plesk 9.0 api rpc

Parallels Plesk Panel

Copyright NoticeISBN: N/A Parallels 660 SW 39th Street Suite 205 Renton, Washington 98057 USA Phone: +1 (425) 282 6400 Fax: +1 (425) 282 6444 Copyright 1999-2008, Parallels, Inc. All rights reserved Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder. Patented technology protected by U.S.Patents 7,328,225; 7,325,017; 7,293,033; 7,099,948; 7,076,633. Patents pending in the U.S. Product and service names mentioned herein are the trademarks of their respective owners.

ContentsPreface 10

About This Document .................................................................................................................. 10 Who Should Read This Document .............................................................................................. 11 Prerequisites for This Document ................................................................................................. 11 Typographical Conventions ......................................................................................................... 11 Feedback ..................................................................................................................................... 12

Resellers in Plesk 9: Backward Compatibility Before Using The Reference

13 14

XSD Representation Conventions ............................................................................................... 14 Data Types .................................................................................................................................. 15 API RPC Schemas Location ....................................................................................................... 16 How to Analyze API RPC Schema .............................................................................................. 16

API RPC Evolution API RPC Change History

20 22

Plesk 9 ......................................................................................................................................... 23

XML Schemas for API RPC Operators

29

v.1.4.0.0 ....................................................................................................................................... 29 v.1.4.1.0 ....................................................................................................................................... 31 v.1.4.1.1 ....................................................................................................................................... 32 v.1.4.1.2 ....................................................................................................................................... 34 v.1.4.2.0 ....................................................................................................................................... 35 v.1.5.0.0 ....................................................................................................................................... 37 v.1.5.1.0 ....................................................................................................................................... 39 v.1.5.2.0 ....................................................................................................................................... 41 v.1.5.2.1 ....................................................................................................................................... 43 v.1.6.0.0 ....................................................................................................................................... 45

Representation of Object Descriptor

47

Filters of Descriptors.................................................................................................................... 48 Property Descriptor...................................................................................................................... 49 Extension of Permissions Descriptor ................................................................................ 51 Extension of Hosting Settings Descriptor .......................................................................... 52 Extension of Limits Descriptor ........................................................................................... 54 Bind Parameters .......................................................................................................................... 55

Supported Operations

57

Preface Managing Client Accounts ........................................................................................................... 58 Filtering Issues .................................................................................................................. 60 Client Settings ................................................................................................................... 63 Creating Client Account .................................................................................................... 81 Getting Information About Client Accounts ....................................................................... 87 Deleting Client Accounts ................................................................................................... 95 Setting Client Account Properties ................................................................................... 100 Adding IP Addresses to Clients IP Pool ......................................................................... 107 Removing IP Addresses from the Clients IP Pool .......................................................... 109 Listing Buttons Displayed on the Clients Page in Control Panel .................................... 112 Retrieving Descriptor of Limits ........................................................................................ 119 Retrieving Descriptor of Permissions .............................................................................. 125 Upgrading Client Account to Reseller Account ............................................................... 129 Changing Client Account Owner ..................................................................................... 132 Managing Client Templates ....................................................................................................... 135 Client Template Settings ................................................................................................. 136 Filtering Issues ................................................................................................................ 142 Creating Client Template ................................................................................................ 144 Retrieving Information on Client Templates .................................................................... 148 Removing Client Templates ............................................................................................ 153 Updating Client Template Settings ................................................................................. 157 Managing Database Servers ..................................................................................................... 162 Adding Database Server ................................................................................................. 164 Changing Database Server Preferences ........................................................................ 170 Detaching Database Servers .......................................................................................... 175 Setting Default Database Server..................................................................................... 180 Retrieving Default Database Server Info ........................................................................ 184 Retrieving Database Server Parameters ........................................................................ 189 Retrieving Supported Types Of Databases .................................................................... 195 Retrieving Local Database Servers Info ......................................................................... 198 Managing Databases ................................................................................................................ 202 Filtering Issues ................................................................................................................ 204 Creating Databases ........................................................................................................ 205 Deleting Databases ......................................................................................................... 211 Creating Database Users ................................................................................................ 216 Assigning Database Administrator .................................................................................. 221 Retrieving Database Administrator Info .......................................................................... 224 Retrieving Information About Databases ........................................................................ 230 Changing Database User Credentials ............................................................................ 237 Retrieving Database Users Info ...................................................................................... 242 Deleting Database Users ................................................................................................ 246 Managing Desktop Presets ....................................................................................................... 251 Changing Plesk Administrator Preset ............................................................................. 252 Choosing Default Preset ................................................................................................. 255 Retrieving Preset Preferences ........................................................................................ 260 Adding Preset .................................................................................................................. 265 Removing Preset ............................................................................................................. 270 Managing DNS .......................................................................................................................... 276 Filtering Issues ................................................................................................................ 279 Managing DNS Records ................................................................................................. 282 Managing ACL................................................................................................................. 304 Managing SOA Records and Zone Parameters ............................................................. 315 Managing Name Servers ................................................................................................ 329 Managing Local or Remote DNS Servers ....................................................................... 350 Managing DNS Recursion ............................................................................................... 368 Managing Domain Accounts ..................................................................................................... 377 Filtering Issues ................................................................................................................ 379 Domain Settings .............................................................................................................. 383 Creating Domain Account ............................................................................................... 422

4

Preface Getting Information About Domain Accounts .................................................................. 429 Deleting Domain Accounts .............................................................................................. 440 Setting Domain Parameters ............................................................................................ 445 Getting the Domain Buttons List ..................................................................................... 453 Getting Traffic Usage Information ................................................................................... 459 Setting Domain Traffic Settings ....................................................................................... 468 Retrieving Descriptor of Limits ........................................................................................ 472 Retrieving Descriptor of Permissions .............................................................................. 478 Retrieving Descriptor of Hosting Settings ....................................................................... 482 Managing Domain Aliases ......................................................................................................... 487 Domain Alias Settings ..................................................................................................... 489 Filtering Issues ................................................................................................................ 491 Creating Domain Aliases ................................................................................................. 492 Retrieving Information On Domain Aliases ..................................................................... 497 Updating Domain Aliases Settings .................................................................................. 503 Deleting Domain Aliases ................................................................................................. 508 Renaming Domain Aliases .............................................................................................. 512 Retrieving Information On Manageable Services ........................................................... 515 Managing Domain Templates ................................................................................................... 516 Domain Template Settings .............................................................................................. 517 Filtering Issues ................................................................................................................ 522 Creating Domain Template ............................................................................................. 524 Getting Information On Domain Templates .................................................................... 532 Configuring Domain Template Settings .......................................................................... 539 Deleting Domain Template.............................................................................................. 549 Managing FTP Accounts ........................................................................................................... 555 FTP Account Permissions ............................................................................................... 556 Filtering Issues ................................................................................................................ 556 Creating FTP Accounts ................................................................................................... 560 Retrieving Information On FTP Accounts ....................................................................... 568 Changing FTP Account Settings ..................................................................................... 575 Deleting FTP Accounts ................................................................................................... 582 Managing IP Addresses ............................................................................................................ 587 Adding IP Address .......................................................................................................... 588 Retrieving IP addresses .................................................................................................. 593 Changing Type ................................................................................................................ 596 Removing IP .................................................................................................................... 600 Managing Locales ..................................................................................................................... 605 LP Names........................................................................................................................ 606 Filtering Issues ................................................................................................................ 606 Retrieving List of LP's...................................................................................................... 608 Installing LP ..................................................................................................................... 614 Retrieving Localized Messages ...................................................................................... 617 Removing LP ................................................................................................................... 622 Enabling LP ..................................................................................................................... 627 Disabling LP .................................................................................................................... 632 Locale Codes .................................................................................................................. 637 Managing Log Rotation on Domain ........................................................................................... 640 Log Rotation Settings ...................................................................................................... 641 Filtering Issues ................................................................................................................ 642 Changing Log Rotation Settings ..................................................................................... 644 Retrieving Log Rotation Settings..................................................................................... 650 Enabling Log Rotation Service ........................................................................................ 656 Disabling Log Rotation Service ....................................................................................... 662 Checking Status of Log Rotation Service ....................................................................... 667 Managing Mail on Domain Level ............................................................................................... 673 Mail Service Preferences ................................................................................................ 675 Mail Account Settings ...................................................................................................... 677 Filtering Issues ................................................................................................................ 690

5

Preface Creating Mail Accounts ................................................................................................... 691 Modifying Mail Account Settings ..................................................................................... 696 Getting Mail Account Settings ......................................................................................... 703 Deleting Mail Accounts .................................................................................................... 708 Enabling/Disabling Mail Service on Domain ................................................................... 712 Setting Mail Service Preferences .................................................................................... 717 Getting Mail Service Preferences.................................................................................... 721 Renaming Mail Accounts ................................................................................................ 725 Managing Mailing Lists .............................................................................................................. 728 Filtering Issues ................................................................................................................ 730 Adding Mailing List .......................................................................................................... 733 Removing Mailing List ..................................................................................................... 739 Adding Subscriber to Mailing List .................................................................................... 744 Retrieving Mailing Lists ................................................................................................... 749 Retrieving Subscribers' Info ............................................................................................ 754 Removing Subscriber ...................................................................................................... 759 Activating Mailing Lists Service ....................................................................................... 764 Deactivating Mailing Lists Service................................................................................... 769 Enabling Mailing List ....................................................................................................... 774 Disabling Mailing List ...................................................................................................... 779 Retrieving Status of Mailing Lists Service ....................................................................... 783 Managing Plesk Backups .......................................................................................................... 789 Remote Storage Settings ................................................................................................ 791 Retrieving Remote Storage Settings ............................................................................... 792 Changing Remote Storage Settings ............................................................................... 797 Creating Domain-level Backup Task ............................................................................... 800 Creating Client-level Backup Task .................................................................................. 805 Creating Reseller-level Backup Task .............................................................................. 809 Creating Server-level Backup Task................................................................................. 813 Retrieving Backup Task Status ....................................................................................... 817 Retrieving List of Local Backups ..................................................................................... 822 Adding Backup to Repository .......................................................................................... 827 Downloading Backup ...................................................................................................... 831 Retrieving Protocols Supported by Backup Manager ..................................................... 834 Cancelling Backup Tasks ................................................................................................ 836 Removing Backup ........................................................................................................... 839 Managing Plesk Server ............................................................................................................. 842 Administrator Personal Information ................................................................................. 844 Server Preferences ......................................................................................................... 847 Getting Supported Protocols ........................................................................................... 850 Performing Initial Server Setup ....................................................................................... 851 Managing Plesk License ................................................................................................. 855 Getting Server Information .............................................................................................. 865 Setting Up Server ............................................................................................................ 897 Managing Plesk Services ................................................................................................ 901 Managing Plesk Updates .......................................................................................................... 905 Checking Updater Status ................................................................................................ 906 Retrieving Plesk Updates ................................................................................................ 908 Retrieving Components List ............................................................................................ 911 Installing Components ..................................................................................................... 916 Updating Plesk ................................................................................................................ 919 Managing Protected Directories ................................................................................................ 922 Filtering Issues ................................................................................................................ 923 Creating Protected Directory ........................................................................................... 926 Changing Protected Directory Properties ....................................................................... 930 Removing Protected Directory ........................................................................................ 938 Retrieving Protected Directory Properties ....................................................................... 942 Creating Protected Directory User .................................................................................. 948 Changing Protected Directory User Settings .................................................................. 952

6

Preface Removing Protected Directory User ............................................................................... 957 Retrieving Protected Directory User Settings ................................................................. 961 Retrieving Descriptor of Protected Directory Properties ................................................. 965 Managing Reseller Accounts ..................................................................................................... 970 Reseller Settings ............................................................................................................. 972 Filtering Issues ................................................................................................................ 980 Creating Reseller Accounts ............................................................................................. 982 Setting Reseller Account Properties ............................................................................... 987 Retrieving Information on Reseller Accounts .................................................................. 992 Removing Reseller Accounts .......................................................................................... 999 Adding IP Addresses to Reseller's IP Pool ................................................................... 1003 Removing IP Addresses from Reseller's IP Pool .......................................................... 1007 Changing IP Address Type in Reseller's IP Pool .......................................................... 1010 Changing Types of Application Packages in Reseller's Application Pool ..................... 1013 Viewing Buttons Displayed on Reseller's Home Page in Control Panel ...................... 1016 Retrieving Descriptor of Limits ...................................................................................... 1021 Retrieving Descriptor of Permissions ............................................................................ 1024 Downgrading Reseller Account to Client Account ........................................................ 1027 Managing Reseller Templates ................................................................................................. 1030 Reseller Template Settings ........................................................................................... 1031 Filtering Issues .............................................................................................................. 1034 Creating Reseller Template .......................................................................................... 1035 Retrieving Information About Reseller Templates ........................................................ 1039 Removing Reseller Templates ...................................................................................... 1043 Setting Reseller Template Properties ........................................................................... 1046 Managing Secret Keys ............................................................................................................ 1050 Creating Secret Key ...................................................................................................... 1051 Retrieving Info on Secret Keys...................................................................................... 1055 Removing Secret Key ................................................................................................... 1060 Managing Sessions ................................................................................................................. 1065 Retrieving Sessions List ................................................................................................ 1065 Terminating Session ..................................................................................................... 1068 Managing Web Applications .................................................................................................... 1072 History of Changes ........................................................................................................ 1074 Web Application Properties ........................................................................................... 1075 Retrieving List of All Web Applications ......................................................................... 1076 Viewing Application Pool ............................................................................................... 1079 Adding Web Application to Application Pool ................................................................. 1083 Removing Web Applications ......................................................................................... 1087 Retrieving List of Packages Available For Domain ....................................................... 1091 Changing Properties of Web Application ...................................................................... 1096 Retrieving Web application Requirements .................................................................... 1100 Installing Web Application ............................................................................................. 1106 Managing Spam Filtering Service ........................................................................................... 1111 Filtering Issues .............................................................................................................. 1113 About Spam Filtering ..................................................................................................... 1115 Adding Pattern............................................................................................................... 1119 Removing Pattern ......................................................................................................... 1125 Retrieving Patterns ........................................................................................................ 1130 Retrieving Info on Spam Filtering service ..................................................................... 1134 Setting Spam Filtering Preferences .............................................................................. 1140 Retrieving Available Spam Filtering Preferences.......................................................... 1146 Retrieving Allowed Lists ................................................................................................ 1152 Checking Status of Spam Filtering Service ................................................................... 1158 Managing SSL Certificates ...................................................................................................... 1161 Installing Certificate ....................................................................................................... 1162 Deleting Certificate ........................................................................................................ 1168 Generating Certificate ................................................................................................... 1173 Managing SSO Service ........................................................................................................... 1178

7

Preface Filtering Issues .............................................................................................................. 1179 Enabling SSO Service ................................................................................................... 1181 Disabling SSO Service .................................................................................................. 1184 Registering Plesk in IdP ................................................................................................ 1186 Retrieving SSO Service Preferences ............................................................................ 1189 Configuring SSO Branding ............................................................................................ 1191 Adding Delegation Rule ................................................................................................ 1212 Removing Delegation Rule ........................................................................................... 1215 Managing Subdomains ............................................................................................................ 1218 Filtering Issues .............................................................................................................. 1219 Subdomain Properties ................................................................................................... 1220 Creating Subdomain ..................................................................................................... 1222 Retrieving Information on Subdomain ........................................................................... 1226 Changing Subdomain Settings ...................................................................................... 1232 Removing Subdomain ................................................................................................... 1235 Renaming Subdomain ................................................................................................... 1238 Changing Parent Domain .............................................................................................. 1241 Managing User Interface ......................................................................................................... 1245 Setting Up Controls Visibility ......................................................................................... 1246 Managing Custom Buttons ............................................................................................ 1249 Managing Virtual Directories ................................................................................................... 1267 Virtual Directory Settings ............................................................................................... 1268 Creating Virtual Directories ........................................................................................... 1275 Removing Virtual Directories......................................................................................... 1280 Managing Web Users .............................................................................................................. 1284 Web User Settings and Preferences ............................................................................. 1285 Filtering Issues .............................................................................................................. 1289 Creating Web Users ...................................................................................................... 1291 Deleting Web Users ...................................................................................................... 1296 Updating Web User Settings ......................................................................................... 1302 Retrieving Web Users Settings .................................................................................... 1308 Retrieving Web Users Preferences ............................................................................... 1314 Updating Web Users Preferences................................................................................. 1319 Migrating Domain And Client Accounts ................................................................................... 1325 IP Addresses Mapping .................................................................................................. 1327 Databases Mapping ...................................................................................................... 1329 Checking Plesk Migration Manager Installation ............................................................ 1331 Retrieving File System Information ............................................................................... 1333 Starting Migration .......................................................................................................... 1335 Retrieving Migration Status ........................................................................................... 1350 Stopping Migration ........................................................................................................ 1356 Retrieving Action Log Data ...................................................................................................... 1360 Retrieving Action Log .................................................................................................... 1361 Retrieving ID of Last Action ........................................................................................... 1366 Uploading Files to Server ........................................................................................................ 1368 Uploading Files Using cURL ......................................................................................... 1368 Uploading Files Using PHP ........................................................................................... 1370 Uploading Files Using .NET .......................................................................................... 1371 Response Packet Structure .......................................................................................... 1375 Response Samples ....................................................................................................... 1376

8

Preface

9

Error Codes

1377

Reduced List of Error Codes ................................................................................................... 1378 Complete List of Error Codes .................................................................................................. 1379 Common errors ............................................................................................................. 1383 Client Operations .......................................................................................................... 1384 Domain Operations ....................................................................................................... 1386 IP Operations ................................................................................................................ 1388 DNS Operations ............................................................................................................ 1390 Server Operations ......................................................................................................... 1392 Web Application Operations .......................................................................................... 1394 Email Operations ........................................................................................................... 1395 Certificate Operations ................................................................................................... 1395 UI Operations ................................................................................................................ 1396 Upload Operations ........................................................................................................ 1397 Secret Key Operations .................................................................................................. 1397 Spam Filter Operations ................................................................................................. 1398 Domain Alias Operations .............................................................................................. 1398 Database Server Operations......................................................................................... 1399 Migration Operations ..................................................................................................... 1399

10

Preface

PrefaceIn this section:About This Document ........................................................................................ 10 Who Should Read This Document .................................................................... 11 Prerequisites for This Document ....................................................................... 11 Typographical Conventions ............................................................................... 11 Feedback .......................................................................................................... 12

About This DocumentThis part of Plesk API RPC documentation describes in detail the programming means provided by Plesk API. Chapter Before Using Reference (on page 14) contains information required for proper reading of the reference sections. Chapter Representation of Object Descriptors (see page 47) explains in detail what object descriptors are and how they are implemented in the API RPC protocol. Chapter Supported Operations explains which Plesk objects can be managed programmatically via API RPC, how this can be done, and what particular operations are allowed to different kinds of Plesk users. Chapter API RPC Versions contains references on what XML Schemas are used for each API RPC operation depending on the API RPC version. Chapter Error Codes (see page 1377) provides information on codes of the errors that may occur when using Plesk API RPC protocol.

This document covers the following versions of the API RPC protocol: 1.3.5.1 - 1.6.0.0. In most code samples, the 1.4.2.0 version of the protocol is used. If a feature is supported only in later versions of API RPC, the earliest version of the protocol that supports the feature is used in code samples.

Preface

11

Who Should Read This DocumentThis part of Plesk API RPC documentation is addressed to the developers who want to implement a kind of a remote Plesk manager or other software capable of managing Plesk objects remotely.

Prerequisites for This DocumentUsers of this document should be familiar with the following: Plesk functionality and business logic. Plesk API RPC protocol (idea, usage). Refer to the Plesk API RPC Developer's Guide. HTTP messages (types, structure). Refer to the RFC 2616 (http://www.ietf.org/rfc/rfc2616.txt). XML basics (idea, syntax, elements, attributes). Refer to the W3Schools XML Tutorial (http://www.w3schools.com/xml/default.asp). XML Schema (idea, simple and complex elements, XSD indicators, data types). Refer to the W3Schools XML Schema Tutorial (http://www.w3schools.com/schema/default.asp).

Typographical ConventionsThe following kinds of formatting in the text identify special information.Formatting convention Special Bold Type of Information Names of operators and operations. Titles of chapters, sections, and subsections found in the other documents. Italics Example Go to the QoS tab. Read the Basic Administration chapter.

Emphasizes the importance of The system supports the so a point, to introduce a term or called wildcard character to designate a command line search. placeholder, which is to be replaced with a real name or value. The names of commands, files, and directories. The license file is located in the httpdocs/common/license s directory.

Monospace

12

Preface On-screen computer output in # ls al /files your command-line sessions; total 14470 source code in XML, C++, or other programming languages. What you type, contrasted with # cd /root/rpms/php on-screen computer output. Names of keys on the keyboard and names of operations on the title page of an operator. Key combinations for which the user must press and hold down one key and then press another. SHIFT, CTRL, ALT

Preformatted

Preformatted Bold CAPITALS

KEY+KEY

CTRL+P, ALT+F4

FeedbackIf you have found a mistake in this guide, or if you have suggestions or ideas on how to improve this guide, please send your feedback using the online form at http://www.parallels.com/en/support/usersdoc/. Please include in your report the guide's title, chapter and section titles, and the fragment of text in which you have found an error.

CHAPTER 1

Resellers in Plesk 9: Backward CompatibilityThe Plesk 9 backward compatibility prevents malfunctioning of client applications which interact with Plesk 9 through old versions of API RPC(current version) Changes to earlier versions of the protocol caused by changes in logic of a new Plesk version (subsection Changes to Earlier Versions).

These two groups are further categorized by Plesk features that required modifying operators and/or operations. Each set of feature-dependant changes is fit into a separate table and sequenced in alphabetical order. Thus, if you use Plesk 9 through API RPC 1.5.0.0 and want to see changes to API RPC 1.5.0.0 driven by the Plesk 9 backward compatibility feature, refer to subsection Plesk 9 > Changes to Earlier Versions, table "Feature: Plesk 9 backward compatibility". Each feature-dependant table consists of the following columns: Option - defines whether an operator/operation/parameter is added ("+"), modified ("*"), or deprecated ("-"). Operator - contains the name of the operator affected by the feature. Operation - contains the name of the operation affected by the feature. The operation name is omitted in the following cases: New operator is added Operator is removed Feature modifies the behavior of an entire operator Feature modifies the XSD complex type that is not explicitly related to an operation (Example: filters).

Type/File - contains the name of an XSD complex type affected by the feature. This name helps to determine whether request, response or both packet structures are changed. If the complex type name is changed, the new name is given. If an operation description is changed, and new description does not use any named complex types, the XSD file which contains the operation description is given. The type/file name is omitted in the following cases: Operation description is left unaffected. Operation is added or deprecated.

Note: The summary of changes does not explicitly track changes in complex type names

API RPC Change History

23

Parameter - contains the affected parameter. This value is present only if Operation or Type/Filename values are provided. If the operation name or both values are set, the path to the parameter is given relatively the operation node. Otherwise, the path is given relatively to the XML element described by the type. We use XPath notations to address the parameter. Comment - contains short description of a change. In case an operator, operation or parameter is deprecated, this field contains brief instructions on what functionality can be used instead.

In this chapter:Plesk 9 ...............................................................................................................23

Plesk 91.6.0.0 Feature: ResellersOption + + + + + + + + + + * + + + + Operator client client client client client client client client client client clienttemplate clienttemplate clienttemplate clienttemplate clienttemplate ClientTemplatePref erencesType ClientTemplateAddI nputType ClientTemplateAddI nputType ClientTemplateGetI nputType shared owner-id owner-login owner-id add add get convert-toreseller change-owner clientSelectionFilter owner-id Type clientSelectionFilter owner-login Type clientSelectionFilter guid Type clientAddGenInfo owner-id clientAddGenInfo clientGetGenInfo clientLimits owner-login owner-id resourcepolicy Now resellers can use this operator Operation Type/File Parameter Comment Now resellers can use this operator

add add get

24


Option + + + + + * * + + + + + + + + + + +

Operator

Operation

Type/File ClientTemplateGetI nputType ClientTemplateDelI nputType ClientTemplateDelI nputType ClientTemplateSetI nputType ClientTemplateSetI nputType SetDefaultPresetIn putCommandType

Parameter owner-login owner-id owner-login owner-id owner-login type

Comment

clientget template clientdel template clientdel template clientset template clientset template desktop set-default-preset domain domain domain domain domain domain domain domain domain domain domain domain domain domain domain domain domain domaintemplate domaintemplate add add add add add get get set set set

Add "reseller" Now resellers can use this operator

domainFilterType domainFilterType domainFilterType domainFilterType domainFilterType domainFilterType domainFilterType

guid client_id owner-id domain_name Use domainname instead domain-name client_login owner-login /gen_setup/cli ent_id /gen_setup/ow ner-id /gen_setup/ow ner-login Use owner-id instead Use owner-login instead Use owner-id instead

domainGenInfoTyp client_id e domainGenInfoTyp owner-id e setGenSetupType client_id setGenSetupType setGenSetupType domainLimits owner-id owner-login overuse

Use owner-id instead


DomainTemplateAd client-id dInputType DomainTemplateAd owner-id dInputType



25

Option + + + + + + + *

Operator domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate domaintemplate event_log

Operation add add get get get get set set set set del del del del get_events

Type/File

Parameter

Comment Use owner-login instead

DomainTemplateAd client-login dInputType DomainTemplateAd owner-login dInputType DomainTemplateG client-id etInputType DomainTemplateG owner-id etInputType DomainTemplateG client-login etInputType DomainTemplateG owner-login etInputType DomainTemplateSe client-id tInputType DomainTemplateSe owner-id tInputType DomainTemplateSe client-login tInputType DomainTemplateSe owner-login tInputType DomanTemplateDe client-id leteInputType DomanTemplateDe owner-id leteInputType DomanTemplateDe client-login leteInputType


Use owner-login instead





DomanTemplateDe owner-login leteInputType EventLogResponse /result/event/cl Classes Type ass reseller_* are added New operator added New operator added

+ +

reseller resellertemplate

Feature: New backup functionalityOption + + Operator backup backup Operation get-remotestorage-settings get-remotestorage-settings Type/File Parameter Comment

BackupGetRemote reseller-id StorageSettingsInp ut BackupGetRemote reseller-login StorageSettingsInp ut

26


Option + + + + + + + + + + + + + + + + + + -

Operator backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup

Operation get-remotestorage-settings get-remotestorage-settings set-remotestorage-settings set-remotestorage-settings set-remotestorage-settings set-remotestorage-settings backup-domain backup-domain backup-domain backup-domain backup-domain backup-domain backup-client backup-client backup-client backup-client backup-client backup-client backup-client backup-client backup-client backup-reseller backup-server get-backup-status

Type/File BackupGetRemote StorageSettingsInp ut BackupGetRemote StorageSettingsOut put BackupSetRemote StorageSettingsInp ut BackupSetRemote StorageSettingsInp ut BackupSetRemote StorageSettingsInp ut BackupSetRemote StorageSettingsInp ut BackupDomainInpu t BackupDomainInpu t BackupDomainInpu t BackupDomainInpu t BackupDomainInpu t

Parameter server /result/settings /passive-mode reseller-id reseller-login server /settings/passi ve-mode filename prefix only-hosting only-mail onlyconfiguration

Comment

BackupCommandO /result/task-id utput BackupClientInput filename BackupClientInput domain-id BackupClientInput domain-name BackupClientInput all-domains BackupClientInput prefix BackupClientInput only-hosting BackupClientInput only-mail BackupClientInput onlyconfiguration BackupCommandO /result/task-id utput

Use get-tasksinfo instead


27

Option + + +

Operator backup backup backup

Operation get-tasks-info

Type/File

Parameter

Comment

get-local-backup- BackupGetLocalBa reseller-id list ckupListInput get-local-backup- BackupGetLocalBa reseller-login list ckupListInput get-local-backup- BackupGetLocalBa server list ckupListInput put-file import-file download-file download-file download-file download-file stop-backup stop-backup stop-backup stop-backup stop-backup get-backupprocesses remove-file remove-file remove-file remove-file BackupRemoveFile Input BackupRemoveFile Input BackupRemoveFile Input BackupRemoveFile Input domain-id domain-name client-id client-login BackupDownloadFil eInput BackupDownloadFil eInput BackupDownloadFil eInput BackupDownloadFil eInput BackupStopInput BackupStopInput BackupStopInput BackupStopInput BackupStopInput domain-id domain-name client-id client-login domain-id domain-name client-id client-login task-id Use get-tasksinfo instead Use import-file instead

+ + + -

backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup backup

Feature: APS Catalog+ server serverPrefs aps-catalogurl

28


Other updates:+ + * domaintemplate clienttemplate updater DomainTemplatePr shared eferencesType ClientTemplatePref shared erencesType UpdateType action

get-updates

The upgrade action is added

Changes to Earlier Versions 1.3.5.1-1.5.2.0 Feature: Plesk 9 backward compatibilityOption * Operator client Operation add Type/File Parameter Comment Client account is automatically assigned to Plesk Administrator * client get If you request info on all client accounts, Plesk will return info on all client accounts, reseller accounts and artificial client account. Plesk user hierarchy will not be retained. If you request reseller account statistics, the operation will return total reseller account statistics (including statistics for controlled client accounts). If you remove a reseller account, all client accounts owned by the reseller will also be removed If you request info on domain accounts owned by a reseller, Plesk will return info on only reseller's personal domain accounts, excluding those owned by the reseller's clients. If you request info on all domain accounts, the info on all domain accounts (including the accounts owned by Plesk Administrator) will be returned. Now you can also request Plesk Administrator's or reseller's personal domain templates Each reseller-related action is tracked as a client-related action.

*

client

get

*

client

del

*

domain

get

*

domain

get

*

domaintemplate event_log

get

*

CHAPTER 4

XML Schemas for API RPC OperatorsThis chapter lists XML schemas that define format of messages sent to and received from Plesk API operators, grouped by the protocol versions. To learn how to access the schemas, refer to the API RPC Schemas Location (on page 16) section. The chapter also contains information on Plesk API RPC evolution which shows how Plesk API is developed: what Plesk version introduced each protocol version, and what were the new managed objects in each version.

In this chapter:v.1.4.0.0 ............................................................................................................ 29 v.1.4.1.0 ............................................................................................................ 31 v.1.4.1.1 ............................................................................................................ 32 v.1.4.1.2 ............................................................................................................ 34 v.1.4.2.0 ............................................................................................................ 35 v.1.5.0.0 ............................................................................................................ 37 v.1.5.1.0 ............................................................................................................ 39 v.1.5.2.0 ............................................................................................................ 41 v.1.5.2.1 ............................................................................................................ 43 v.1.6.0.0 ............................................................................................................ 45

v.1.4.0.0Version 1.4.0.0 of Plesk XML API has a two-level structure as follows: An entry point to the input XML schemas is agent_input.xsd (./rpc/1.4.0.0/agent_input.xsd). This file references all lower-level input schemas available. An entry point to the output XML schemas is agent_output.xsd. This file references all lower-level output schemas available.

Version 1.4.0.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATIONS Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd AVAILABLE TO Plesk Administrator Plesk Administrator

30


Database server operations Desktop operations DNS operations

db_server

database_input.xsd, database_output.xsd, plesk_db.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd event_log_input.xsd, event_log_output.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_ key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter_input.xsd, spamfilter_output.xsd, plesk_spamfilter.xsd upload_output.xsd

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator

desktop dns

Domain alias operations

domain_alias

Domain operations

domain

Event Logging IP operations Mail operations

event_log ip mail

Migration operations

migration

Secret key operations

secret_key

Plesk Administrator

Server operations

server

Plesk Administrator

Web Application operations Spam filtering

siteapp

Plesk Administrator

spamfilter

Plesk Administrator Plesk Administrator

Upload

upload

Simple and commonly used types are provided in schemas common.xsd and plesk_common.xsd.


31

v.1.4.1.0Version 1.4.1.0 of Plesk XML API has a two-level structure as follows: An entry point to the input XML schemas is agent_input.xsd. This file references all lower-level input schemas available. An entry point to the output XML schemas is agent_output.xsd. This file references all lower-level output schemas available.

Version 1.4.1.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATIONS Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd AVAILABLE TO Plesk Administrator

Plesk Administrator

Client template operations Database server operations Desktop operations DNS operations

client-template db_server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client

desktop dns

Domain operations

domain

Domain template operations Domain alias operations

domain-template domain_alias

Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator

Event Logging IP operations Mail operations

event_log ip mail


migration

32



secret_key

secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter_input.xsd, spamfilter_output.xsd, plesk_spamfilter.xsd upload_output.xsd

Plesk Administrator

Server operations

server

Plesk Administrator

Web Application operations Spam filtering

siteapp

Plesk Administrator

spamfilter

Plesk Administrator Plesk Administrator

Upload

upload



Version 1.4.1.1 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator

Client template operations Database server operations Desktop operations DNS operations


desktop dns


33

Domain operations

domain

domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter_input.xsd, spamfilter_output.xsd, plesk_spamfilter.xsd upload_output.xsd virtdir.xsd

Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client

Domain template operations Domain alias operations Event Logging IP operations Mail operations Migration operations


Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator

event_log ip mail migration


secret_key

Plesk Administrator

Server operations

server

Plesk Administrator

SiteApp operations

siteapp

Plesk Administrator

Spam filtering

spamfilter

Plesk Administrator Plesk Administrator Plesk Administrator

Upload Virtual directory operations

upload virtdir

34




Version 1.4.1.2 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client domain_alias Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client

Client template operations Database server operations Desktop operations DNS operations Domain operations


desktop dns domain

Domain template operations Domain alias operations Event Logging IP operations Mail operations

domain-template

event_log ip mail


35


migration

migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter_input.xsd, spamfilter_output.xsd, plesk_spamfilter.xsd upload_output.xsd virtdir.xsd

Plesk Administrator


secret_key

Plesk Administrator

Server operations

server

Plesk Administrator

SiteApp operations

siteapp

Plesk Administrator

Spam filtering

spamfilter

Plesk Administrator Plesk Administrator Plesk Administrator

Upload Virtual directory operations

upload virtdir



Version 1.4.2.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator

Client template operations

client-template

36


Database server operations Desktop operations DNS operations Domain operations

db_server

database_input.xsd, database_output.xsd, plesk_db.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd ftpuser.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd upload_output.xsd virtdir.xsd webuser.xsd

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client

desktop dns domain

Domain template operations Domain alias operations Event Logging Additional FTP account operations IP operations Mail operations Mailing list operations Migration operations


Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator

event_log ftp-user ip mail maillist migration


secret_key

Plesk Administrator

Server operations

server

Plesk Administrator

SiteApp operations

siteapp

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client

Spam filtering Upload Virtual directory operations Web user operations

spamfilter upload virtdir webuser


37



Version 1.5.0.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd descriptor.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator

Client template operations Database server operations


Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator

Descriptor structure Desktop operations DNS operations Domain operations

desktop dns domain

Domain template operations Domain alias operations Event Logging


event_log

38


Localization operations Log rotation operations Additional FTP account operations IP operations Mail operations Mailing list operations Migration operations

locale log-rotation ftp-user ip mail maillist migration

locale.xsd logrotation.xsd ftpuser.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd session.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd updater.xsd upload_output.xsd virtdir.xsd webuser.xsd

Plesk Administrator Plesk Administrator, Plesk client Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator


secret_key

Plesk Administrator

Server operations

server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client

Session management operations SiteApp operations

session siteapp

Spam filtering Updater operations Upload Virtual directory operations Web user operations

spamfilter updater upload virtdir webuser



39

v.1.5.1.0Version 1.5.1.0 of Plesk XML API has a two-level structure as follows: An entry point to the input XML schemas is agent_input.xsd (./rpc/1.5.1.0/agent_input.xsd). This file references all lower-level input schemas available. An entry point to the output XML schemas is agent_output.xsd. This file references all lower-level output schemas available.

Version 1.5.1.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd descriptor.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd locale.xsd logrotation.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator



Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk client


desktop dns domain

Domain template operations Domain alias operations Event Logging Localization operations Log rotation operations


event_log locale log-rotation

40


Additional FTP account operations IP operations Mail operations Mailing list operations Migration operations

ftp-user ip mail maillist migration

ftpuser.xsd ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd session.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd updater.xsd upload_output.xsd virtdir.xsd webuser.xsd backup.xsd

Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator


secret_key

Plesk Administrator

Server operations

server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client


session siteapp

Spam filtering Updater operations Upload Virtual directory operations Web user operations Operations with Plesk backups

spamfilter updater upload virtdir webuser backup-manager



41

v.1.5.2.0Version 1.5.2.0 of Plesk XML API has a two-level structure as follows: An entry point to the input XML schemas is agent_input.xsd. This file references all lower-level input schemas available. An entry point to the output XML schemas is agent_output.xsd. This file references all lower-level output schemas available. Version 1.5.2.0 of Plesk XML API supports operations on the following Plesk objects:SUPPORTED OPERATION Certificate operations Client operations OPERATOR certificate client SCHEMAS certificate_input.xsd, certificate_output.xsd client_input.xsd, client_output.xsd, plesk_client.xsd client_template.xsd database_input.xsd, database_output.xsd, plesk_db.xsd descriptor.xsd desktop.xsd dns_input.xsd, dns_output.xsd, plesk_dns.xsd domain_input.xsd, domain_output.xsd, plesk_domain.xsd domain_template.xsd domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd event_log_input.xsd, event_log_output.xsd locale.xsd logrotation.xsd ftpuser.xsd AVAILABLE TO Plesk Administrator Plesk Administrator Plesk Administrator



Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk client Plesk Administrator, Plesk Client


desktop dns domain

Domain template operations Domain alias operations Event Logging Localization operations Log rotation operations Additional FTP account operations


event_log locale log-rotation ftp-user

42


IP operations Mail operations Mailing list operations Migration operations

ip mail maillist migration

ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd protected_dir.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd session.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd subdomain.xsd ui_input.xsd, ui_output.xsd, plesk_custom_button.xsd updater.xsd upload_output.xsd virtdir.xsd webuser.xsd backup.xsd

Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator

Protected directory operations Secret key operations

protected_dir secret_key

Server operations

server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client


session siteapp

Spam filtering Subdomain operations User interface operations Updater operations Upload Virtual directory operations Web user operations Operations with Plesk backups

spamfilter subdomain ui updater upload virtdir webuser backup-manager



43






desktop dns domain




44




ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd protected_dir.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd session.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd subdomain.xsd ui_input.xsd, ui_output.xsd, plesk_custom_button.xsd updater.xsd upload_output.xsd virtdir.xsd




Server operations

server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client


session siteapp

Spam filtering Subdomain operations User interface operations Updater operations Upload Virtual directory operations Web user operations Operations with Plesk backups

spamfilter subdomain ui updater upload virtdir webuser backup-manager

webuser.xsd backup.xsd



45






desktop dns domain




46




ip_input.xsd, ip_output.xsd mail_input.xsd, mail_output.xsd, plesk_mailname.xsd maillist.xsd migration_input.xsd, migration_output.xsd, plesk_migration.xsd protected_dir.xsd secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd server_input.xsd, server_output.xsd, plesk_server.xsd session.xsd siteapp_input.xsd, siteapp_output.xsd, plesk_siteapp.xsd spamfilter.xsd, plesk_spamfilter.xsd subdomain.xsd ui_input.xsd, ui_output.xsd, plesk_custom_button.xsd updater.xsd upload_output.xsd virtdir.xsd




Server operations

server

Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client Plesk Administrator, Plesk Client


session siteapp

Spam filtering Subdomain operations User interface operations Updater operations Upload Virtual directory operations Web user operations Operations with Plesk backups Operations with Plesk resellers Operations with Plesk reseller templates

spamfilter subdomain ui updater upload virtdir webuser backup-manager reseller reseller-template

webuser.xsd backup.xsd reseller.xsd reseller_template.xsd


CHAPTER 5

Representation of Object DescriptorEvery object descriptor is composed of a set of property descriptors and correlation between properties of

plesk 9.0 api rpc

Documents