You are on page 1of 1011

2

Copyright Notice
ISBN: N/A SWsoft. 13755 Sunrise Valley Drive Suite 325 Herndon VA 20171 USA Phone: +1 (703) 815 5670 Fax: +1 (703) 815 5675 Copyright 1999-2007, SWsoft Holdings, Ltd. 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 hosting technology protected by U.S.Patents 7,099,948; 7,076,633. Patents pending in the U.S. Linux is a registered trademark of Linus Torvalds. ASPLinux and the ASPLinux logo are registered trademarks of SWsoft. RedHat is a registered trademark of Red Hat Software, Inc. Solaris is a registered trademark of Sun Microsystems, Inc. X Window System is a registered trademark of X Consortium, Inc. UNIX is a registered trademark of The Open Group. Intel, Pentium, and Celeron are registered trademarks of Intel Corporation. MS Windows, Windows 2003 Server, Windows XP, Windows 2000, Windows NT, Windows 98, and Windows 95 are registered trademarks of Microsoft Corporation. IBM DB2 is a registered trademark of International Business Machines Corp. SSH and Secure Shell are trademarks of SSH Communications Security, Inc. MegaRAID is a registered trademark of American Megatrends, Inc. PowerEdge is a trademark of Dell Computer Corporation. Request Tracker is a trademark of Best Practical Solutions, LLC All other trademarks and copyrights referred to are the property of their respective owners.

Contents
Preface 8

About This Document................................................................................................................ 8 Typographical Conventions ....................................................................................................... 8 Feedback .................................................................................................................................. 9

Before Using Reference

10

XSD Representation Conventions ........................................................................................... 10 Data Types ............................................................................................................................. 10 How to Analyze API RPC Schema .......................................................................................... 12

Representation of Object Descriptor

16

Property Descriptor ................................................................................................................. 17 Extension of Permissions Descriptor.............................................................................. 19 Extension of Hosting Settings Descriptor ....................................................................... 20 Extension of Limits Descriptor ....................................................................................... 21 Bind Parameters ..................................................................................................................... 22 Filters of Descriptors ............................................................................................................... 23

Supported Operations

24

Managing Client Accounts....................................................................................................... 25 Filtering Issues .............................................................................................................. 27 Client Settings ............................................................................................................... 28 Creating Client Account ................................................................................................. 45 Getting Information About Client Accounts..................................................................... 51 Deleting Client Accounts ............................................................................................... 58 Setting Client Account Properties .................................................................................. 61 Adding IP Addresses to Clients IP Pool......................................................................... 68 Removing IP Addresses from the Clients IP Pool .......................................................... 70 Listing Buttons Displayed on the Clients Page in Control Panel ..................................... 73 Retrieving Descriptor of Limits ....................................................................................... 78 Retrieving Descriptor of Permissions ............................................................................. 84 Managing Client Templates ..................................................................................................... 88 Client Template Settings ............................................................................................... 89 Filtering Client Templates .............................................................................................. 95 Creating Client Template ............................................................................................... 96 Getting Information About Client Templates ................................................................... 99 Deleting Client Templates............................................................................................ 104 Setting Client Template Settings.................................................................................. 107 Managing Database Servers ................................................................................................. 112 Adding Database Server ............................................................................................. 114 Changing Database Server Preferences ...................................................................... 119 Detaching Database Servers ....................................................................................... 123 Setting Default Database Server.................................................................................. 127 Retrieving Default Database Server Info ...................................................................... 131 Retrieving Database Server Parameters ...................................................................... 134 Retrieving Supported Types Of Databases .................................................................. 139 Retrieving Local Database Servers Info ....................................................................... 142

Preface Managing Databases ............................................................................................................ 146 Filtering Issues ............................................................................................................ 147 Creating Databases ..................................................................................................... 148 Deleting Databases ..................................................................................................... 154 Creating Database Users ............................................................................................ 158 Assigning Database Administrator ............................................................................... 163 Retrieving Database Administrator Info ........................................................................ 166 Retrieving Information About Databases ...................................................................... 170 Changing Database User Credentials .......................................................................... 177 Retrieving Database Users Info ................................................................................... 181 Deleting Database Users ............................................................................................. 185 Managing Desktop Presets ................................................................................................... 190 Changing Plesk Administrator Preset........................................................................... 191 Choosing Default Preset .............................................................................................. 194 Retrieving Preset Preferences ..................................................................................... 198 Adding Preset.............................................................................................................. 202 Removing Preset ......................................................................................................... 206 Managing DNS...................................................................................................................... 211 Filtering Issues ............................................................................................................ 213 Managing DNS Records .............................................................................................. 216 Managing ACL ............................................................................................................ 234 Managing SOA Records and Zone Parameters ........................................................... 242 Managing Name Servers ............................................................................................. 254 Managing Local or Remote DNS Servers .................................................................... 271 Managing DNS Recursion ........................................................................................... 283 Managing Domain Accounts.................................................................................................. 290 Filtering Issues ............................................................................................................ 292 Domain Settings .......................................................................................................... 295 Creating Domain Account ............................................................................................ 329 Getting Information About Domain Accounts................................................................ 334 Deleting Domain Accounts .......................................................................................... 343 Setting Domain Parameters ......................................................................................... 348 Getting the Domain Buttons List .................................................................................. 355 Getting Traffic Usage Information ................................................................................ 361 Setting Domain Traffic Settings ................................................................................... 368 Retrieving Descriptor of Limits ..................................................................................... 372 Retrieving Descriptor of Permissions ........................................................................... 378 Retrieving Descriptor of Hosting Settings ..................................................................... 382 Managing Domain Aliases ..................................................................................................... 387 Domain Alias Settings ................................................................................................. 388 Filtering Issues ............................................................................................................ 390 Creating Domain Aliases ............................................................................................. 391 Retrieving Information On Domain Aliases ................................................................... 395 Updating Domain Aliases Settings ............................................................................... 401 Deleting Domain Aliases ............................................................................................. 405 Renaming Domain Aliases .......................................................................................... 408 Retrieving Information On Manageable Services ......................................................... 411 Managing Domain Templates ................................................................................................ 412 Domain Template Settings .......................................................................................... 413 Filtering Issues ............................................................................................................ 416 Creating Domain Template .......................................................................................... 417 Getting Information On Domain Templates .................................................................. 424 Configuring Domain Template Settings........................................................................ 430 Deleting a Domain Template ....................................................................................... 440 Managing Domain-Level Mail ................................................................................................ 445 Mail Service Preferences ............................................................................................. 447 Mail Account Settings .................................................................................................. 448 Filtering Issues ............................................................................................................ 459 Creating Mail Accounts................................................................................................ 460

Preface Modifying Mail Account Settings .................................................................................. 464 Getting Mail Account Settings ...................................................................................... 470 Deleting Mail Accounts ................................................................................................ 475 Enabling/Disabling Mail Service on Domain ................................................................. 478 Setting Mail Service Preferences ................................................................................. 482 Getting Mail Service Preferences................................................................................. 486 Renaming Mail Accounts ............................................................................................. 489 Managing FTP Accounts ....................................................................................................... 492 FTP Account Permissions ........................................................................................... 493 Filtering Issues ............................................................................................................ 494 Creating FTP Accounts ............................................................................................... 497 Retrieving Information On FTP Accounts ..................................................................... 504 Changing FTP Account Settings .................................................................................. 511 Deleting FTP Accounts ................................................................................................ 517 Managing IP Addresses ........................................................................................................ 522 Adding IP Address....................................................................................................... 523 Retrieving IP addresses .............................................................................................. 527 Changing Type ............................................................................................................ 530 Removing IP ............................................................................................................... 534 Managing Locales ................................................................................................................. 538 LP Names ................................................................................................................... 539 Filtering Issues ............................................................................................................ 539 Retrieving List of LP's .................................................................................................. 540 Installing LP ................................................................................................................ 545 Retrieving Localized Messages ................................................................................... 547 Removing LP .............................................................................................................. 552 Enabling LP................................................................................................................. 555 Disabling LP ................................................................................................................ 559 Appendix. Locale Codes .............................................................................................. 563 Managing Log Rotation on Domain ....................................................................................... 567 Log Rotation Settings .................................................................................................. 568 Filtering Issues ............................................................................................................ 568 Changing Log Rotation Settings .................................................................................. 570 Retrieving Log Rotation Settings.................................................................................. 576 Enabling Log Rotation Service..................................................................................... 582 Disabling Log Rotation Service .................................................................................... 587 Checking Status of Log Rotation Service ..................................................................... 591 Managing Mailing Lists.......................................................................................................... 596 Filtering Issues ............................................................................................................ 598 Adding Mailing List ...................................................................................................... 601 Removing Mailing List ................................................................................................. 605 Adding Subscriber to Mailing List ................................................................................. 610 Retrieving Mailing Lists................................................................................................ 614 Retrieving Subscribers' Info ......................................................................................... 620 Removing Subscriber .................................................................................................. 625 Activating Mailing Lists Service .................................................................................... 629 Deactivating Mailing Lists Service................................................................................ 635 Enabling Mailing List ................................................................................................... 640 Disabling Mailing List................................................................................................... 645 Retrieving Status Of Mailing Lists Service .................................................................... 650 Managing Plesk Backups ...................................................................................................... 655 Remote Storage Settings............................................................................................. 656 Retrieving Remote Storage Settings ............................................................................ 657 Changing Remote Storage Settings............................................................................. 661 Creating Backup of Domain Account ........................................................................... 664 Creating Backup of Client Account .............................................................................. 668 Retrieving Backup Status ............................................................................................ 672 Retrieving List of Local Backups .................................................................................. 676 Uploading Backup to Repository .................................................................................. 680

Preface Downloading Backup ................................................................................................... 683 Retrieving Protocols Supported by Backup Manager ................................................... 686 Stopping Backup Process............................................................................................ 687 Retrieving List of Backup Processes ............................................................................ 690 Removing Backup ....................................................................................................... 693 Managing Plesk Server ......................................................................................................... 696 Administrator Personal Information .............................................................................. 697 Server Preferences ..................................................................................................... 699 Getting Supported Protocols ........................................................................................ 701 Performing Initial Server Setup .................................................................................... 703 Managing Plesk License.............................................................................................. 706 Getting Server Information........................................................................................... 714 Setting Up Server ........................................................................................................ 744 Managing Plesk Services ............................................................................................ 747 Managing Plesk Updates ...................................................................................................... 751 Checking Updater Status............................................................................................. 752 Retrieving Plesk Updates ............................................................................................ 753 Retrieving Components List......................................................................................... 755 Installing Components ................................................................................................. 758 Updating Plesk ............................................................................................................ 761 Managing Secret Keys .......................................................................................................... 764 Creating Secret Key .................................................................................................... 764 Retrieving Info on Secret Keys .................................................................................... 768 Removing Secret Key .................................................................................................. 772 Managing Sessions ............................................................................................................... 776 Retrieving Sessions List .............................................................................................. 776 Terminating Session.................................................................................................... 779 Managing Site Applications ................................................................................................... 781 History of Changes ...................................................................................................... 783 Site Application Properties........................................................................................... 784 Retrieving List of All Site Applications .......................................................................... 785 Viewing Application Pool ............................................................................................. 787 Adding Site Application to Application Pool .................................................................. 791 Removing Site Applications ......................................................................................... 795 Retrieving List of Packages Available For Domain ....................................................... 799 Changing Properties of Site Application ....................................................................... 803 Retrieving Site Application Requirements .................................................................... 807 Installing Site Application ............................................................................................. 812 Managing Spam Filtering Service .......................................................................................... 815 Filtering Issues ............................................................................................................ 817 About Spam Filtering ................................................................................................... 819 Adding Pattern ............................................................................................................ 823 Removing Pattern........................................................................................................ 829 Retrieving Patterns ...................................................................................................... 834 Retrieving Info on Spam Filtering service ..................................................................... 838 Setting Spam Filtering Preferences ............................................................................. 843 Retrieving Available Spam Filtering Preferences.......................................................... 849 Retrieving Allowed Lists .............................................................................................. 854 Checking Status of Spam Filtering Service .................................................................. 859 Managing SSL Certificates .................................................................................................... 861 Installing Certificate ..................................................................................................... 862 Deleting Certificate ...................................................................................................... 868 Generating Certificate.................................................................................................. 872 Managing Virtual Directories ................................................................................................. 878 Virtual Directory Settings ............................................................................................. 878 Creating Virtual Directories .......................................................................................... 884 Removing Virtual Directories ....................................................................................... 889 Managing Web Users ............................................................................................................ 891 Web User Settings and Preferences ............................................................................ 892

Preface Filtering Issues ............................................................................................................ 895 Creating Web Users .................................................................................................... 897 Deleting Web Users .................................................................................................... 902 Updating Web User Settings........................................................................................ 907 Retrieving Web Users Settings ................................................................................... 912 Retrieving Web Users Preferences .............................................................................. 918 Updating Web Users Preferences................................................................................ 922 Migrating Domain And Client Accounts.................................................................................. 927 IP Addresses Mapping ................................................................................................ 928 Databases Mapping .................................................................................................... 930 Checking Migration Possibility ..................................................................................... 932 Retrieving File System Information .............................................................................. 934 Starting Migration ........................................................................................................ 936 Retrieving Migration Status.......................................................................................... 946 Stopping Migration ...................................................................................................... 951 Retrieving Action Log Data .................................................................................................... 954 Retrieving Action Log .................................................................................................. 954 Retrieving ID of Last Action ......................................................................................... 958 Uploading Files to Server ...................................................................................................... 960 Uploading Files Using cURL ........................................................................................ 960 Uploading Files Using PHP ......................................................................................... 961 Uploading Files Using .NET......................................................................................... 962 Response Packet Structure ......................................................................................... 966 Response Samples ..................................................................................................... 967

API RPC Versions

968

API RPC Evolution ................................................................................................................ 969 v.1.4.0.0................................................................................................................................ 970 v.1.4.1.0................................................................................................................................ 972 v.1.4.1.1................................................................................................................................ 973 v.1.4.1.2................................................................................................................................ 975 v.1.4.2.0................................................................................................................................ 977 v.1.5.0.0................................................................................................................................ 980 v.1.5.1.0................................................................................................................................ 982

Error Codes

986

Complete List of Error Codes ................................................................................................ 987 Common errors ........................................................................................................... 992 Client Operations ........................................................................................................ 993 Domain Operations ..................................................................................................... 995 IP Operations .............................................................................................................. 998 DNS Operations .......................................................................................................... 999 Server Operations ..................................................................................................... 1001 Site Application Operations ....................................................................................... 1004 Email Operations ....................................................................................................... 1004 Certificate Operations ................................................................................................ 1005 UI Operations ............................................................................................................ 1005 Upload Operations .................................................................................................... 1006 Secret Key Operations .............................................................................................. 1007 Spam Filter Operations.............................................................................................. 1007 Domain Alias Operations ........................................................................................... 1008 Database Server Operations ..................................................................................... 1008 Migration Operations ................................................................................................. 1009 Reduced List of Error Codes ............................................................................................... 1010

CHAP

TER

Preface
About This Document
This part of Plesk API RPC documentation describes in detail the programming means provided by Plesk API. Chapter Before Using Reference (see page 10) contains information required for proper reading of the reference sections. Chapter Representation of Object Descriptors (see page 16) 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 (see page 968) contains references on what XML Schemas are used for each API RPC operation depending on the API RPC version. Chapter Error Codes (see page 986) provides information on codes of the errors that may occur when using Plesk API RPC protocol.

Typographical Conventions
The 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 Emphasizes the importance of a point, to introduce a term or to designate a command line placeholder, which is to be replaced with a real name or value. Example Go to the QoS tab. Read the Basic Administration chapter. The system supports the so called wildcard character search.

Preface

Monospace

The names of commands, files, and directories.

Preformatted

On-screen computer output in your command-line sessions; source code in XML, C++, or other programming languages. What you type, contrasted with 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.

The license file is located in the httpdocs/common/licens es directory. # ls al /files total 14470

Preformatted Bold

# cd /root/rpms/php

CAPITALS

SHIFT, CTRL, ALT

KEY+KEY

CTRL+P, ALT+F4

Feedback
If 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 to userdocs@swsoft.com. 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.

10

CHAP

TER

Before Using Reference


This section contains information required for proper reading of the reference sections. The XSD Representation Conventions (on page 10) section explains designations used in graphical representation of XML objects described in the current document. The Data Types (on page 10) section contains classification of object types described in the current document. The How to Analyze API RPC Schema (on page 12) section explains how to read an XSD schema using user agents or text editors. This can be helpful, if you want to create a valid packet according only to XSD files.

In this chapter:
XSD Representation Conventions ................................................................... 10 Data Types .................................................................................................... 10 How to Analyze API RPC Schema .................................................................. 12

XSD Representation Conventions


The protocol functionality is described using an XSD schema. This document uses Altova XMLSpy rules and agreements to represent the scheme graphically. For details on the rules and agreements, visit the following URL: http://www.altova.com/manual2007/XMLSpy/spyenterprise/contentmodelview.htm.

Data Types
Each node of the XML schema is of a specified type. For details on XML data types, visit the following URL: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/. In API Reference, a node can be of a simple or a complex type. If the type of the node is complex and has a name, the name of the type is followed by a filename. The filename specifies the file where the type is located. If the type is not named, it is called complex in the reference. If the type is simple, it can be a standard type or its modification. A list of standard simple types presented in the following table.
Type string short Definition Sequence of 1..255 characters Examples mytext, a, ppp

Integer numbers from -2^15 to 2^15- -167, 2880, 310 1*

Before Using Reference

11

Type integer unsignedInt unsignedLong long base64 boolean byte date dateTime

Definition

Examples

Integer numbers from -2^31 to 2^31- -16007, 211880, 310010 1 Integer numbers from 0 to 2^32-1 Integer numbers from 0 to 2^64-1 1670031, 3321455232 44322344432

Integer numbers from -2^63 to 2^63- 184467440737095516 1 Base64-encoded arbitrary binary data Binary-valued logic legal literals Integer numbers from -128 to 127 Calendar date. Format YYYY-MMDD Specific instant of time. ISO 8601 extended format YYYY-MMDDThh:mm:ss GTrRddxXRGgh== true, false, 1, 0 1, 0, 126, 100 May the 31st, 1999 is: 1999-05-31 1:20 pm on May the 31st, 1999 for Eastern Standard Time which is 5 hours behind Coordinated Universal Time (UTC) looks as follows: 1999-05-31T13:20:00-05:00

none anySimple

Nodes of this type do not contain any data (so-called blank nodes) Any simple type except none 123, mytext, example123string

* - the number y^n is the number y raised to n-th power.

Before Using Reference

12

How to Analyze API RPC Schema


The following instructions can help you analyze an XML API schema.

If you use API RPC 1.4.0.0 or higher: Start with the main agent_input.xsd schema. It lists all supported operator elements within the packet element. For example,

On the above figure, complex data type RequestPacketType lists all operator elements supported in API RPC 1.4.0.0. These operators are: server, client, domain, etc. Each operator has a matching request data type (the type attribute). This data type describes the structure of the operator. To see the structure of a certain operator, you need to find the low-level 'input' schema where its data type is defined. File agent_input.xsd lists all subsequent schemas as follows:

Before Using Reference

13

The schema name contains the name of the operator you need and the _input suffix. Open the schema matching any operator. It will contain several complex data types, including the request data type specified for the operator. For example, here is the contents of the client_input.xsd schema (v.1.4.0.0) matching the client operator.

Before Using Reference

14

The client operator is described by type ServerOperatorType (highlighted). To see its structure, click the + sign to the left and expand the section. Type ServerOperatorType describes the client operator as follows: It lists all operations that can be applied to Plesk Client (get_protos, get, set, srv_man, etc.). The same principle is true for any operator: its request data type (specified in the agent_input.xsd schema) declares operations that can be applied to the relevant object.

Each operation element is also presented by a special data type specified in the type attribute. Operation data types are normally defined in the same schema. For example, the set operation (type AdminSetType) is defined in the same client_input.xsd schema as follows:

All nested elements (operation parameters) are described by specific data types. You can find their definitions either in the same schema, or in the included schema:

Thus, when you analyse the schemas, the approach is as follows: start with the main schema to choose the operator and drill down to the subsequent data types that can be found in the included schemas.

Before Using Reference

15

If you use API RPC 1.3.5.1 or lower, find the required input schema by its name. The schema describes the structure of the XML packet within the packet element: It contains a single operator element that, in turn, contains some operation elements. Operations are structured as described above: Each operation is a complex data type that contains sequences of various parameters. Some parameters are fully defined within the operation element, others have just a complex data type specified against them. Such data types can be defined in the same schema or in some other schema included into this one with the include directive.

16

CHAP

TER

Representation of Object Descriptor


Every object descriptor is composed of a set of property descriptors and correlation between properties of the object. Its graphical representation is as follows:

The descriptor node is required. It specifies object descriptor. Data type: ObjectDescriptor (descriptor.xsd). The property node is required. It specifies one or more property descriptors. For details, refer to the Descriptor of Property (on page 17) section. Data type: PropertyDescriptor (descriptor.xsd). The bind node is optional. It defines correlation between properties of the object. For details, refer to the Bind Parameters (on page 22) section. Data type: PropertyDescriptor (descriptor.xsd).

Before you start using descriptors, read more about descriptor filtering issues in the Filters of Descriptors (on page 23) section. For more info on descriptors, refer to the Descriptors Overview section of the Programming Guide.

In this chapter:
Property Descriptor ........................................................................................ 17 Bind Parameters............................................................................................ 22 Filters of Descriptors ...................................................................................... 23

Representation of Object Descriptor

17

Property Descriptor
Property descriptor is comprised of parameters that specify an object property. Its graphical representation is as follows:

The property node is required. It specifies a property descriptor. Data type: PropertyDescriptor (descriptor.xsd). The name node is required. It specifies identifier of the property. Data type: string. The type node is required. It specifies a type of property value. Data type: string. Allowed values: string | password | int | uint | float | boolean | bytes | date Where uint is an unsigned integer. Date is stored in timestamp format. In 'bytes' type -1 (value) = UNLIMITED

The enum node is optional. It specifies values of the property in case the property has limited set of values. Data type: EnumElementType (descriptor.xsd). The value node is required if the enum node is specified. It defines a value of the property. Data type: string.

Representation of Object Descriptor

18

The label node is optional. It specifies brief explanation of the property value in Plesk CP. This value should be equal to locale key name of the property. To retrieve locale key value, use the locale operator. Data type: string. The hint value is optional. It specifies the hint that can be seen if you point cursor on the property label in Plesk CP. Data type: string.

The default-value node is optional. It specifies default value of the property. Data type: none. The writable-by node is optional. It specifies users who can edit the property. Data type: sting. Allowed values: none | admin | client | domain-admin. The label node is optional. It specifies brief explanation of the property in Plesk CP. This value should be equal to locale key name of the property. To retrieve locale key value, use the locale operator. Data type: string. The hint node is optional. It specifies hint that can be seen if you point cursor on the property label in Plesk CP. Data type: string. The extension node is optional. It defines data specific for the object. For details, refer to the Extension of Permissions Descriptor (on page 18), Extension of Hosting Settings Descriptor (on page 19) and Extension of Limits Descriptor (see page 20) sections. Data type: any.

Samples The following property descriptor specifies FTP quota.


<property> <name>ftp_quota</name> <type>int</type> <default>-1</default> <writable-by>admin</writable-by> </property>

The following property descriptor specifies PHP support.


<property> <name>php</name> <type>boolean</type> <default>1</default> <writable-by>admin</writable-by> <writable-by>client</writable-by> <writable-by>domain-admin</writable-by> </property>

Representation of Object Descriptor

19

Extension of Permissions Descriptor


This extension is used to define correlations between types of users and permissions. If you send request packet containing the get-permission-descriptor operation, the respond from the server will contain permission level in the level node nested into the extension node. The graphical representation of the construction is as follows:

This node can be empty, or contain one of the following values: client. The parameter is visible to clients. domain. The parameter is visible to domain administrators. mail. The parameter is visible to mail account users.

Note: You can specify multiple service parameters in one extension node.

Extension node sample


<packet> <property> <name>manage_virusfilter</name> <type>boolean</type> <default-value>false</default-value> <writable-by>admin</writable-by> <label>cl_perm__manage_virusfilter</label> <extension> <level>client</level> <level>domain</level> <level>mail</level> </extension> </property>

For details on permissions, refer to the Limits and Permissions (on page 35) (client's settings), or Limits, Permissions and Hosting Settings (on page 305) (domain and domain administrator's settings) sections.

Representation of Object Descriptor

20

Extension of Hosting Settings Descriptor


This extension is used to define visible properties on managing Plesk objects. If you send a request packet containing the get-physical-hosting-descriptor operation, the service node nested into the extension node will contain if a property is visible when you manage a specified object. The graphical representation of the construction is as follows:

This node can be empty, or contain one of the following values: domain. The parameter is visible when managing domains. subdomain. The parameter is visible when managing sub-domains. webuser. The parameter is visible when managing web users.

Note: You can specify multiple service parameters in one extension node.

Extension node sample


<property> <name>asp</name> <type>boolean</type> <writable-by>admin</writable-by> <label>__asp_unix_support</label> <extension> <service> <domain>1</domain> <subdomain>1</subdomain> <webuser>1</webuser> </service> </extension> </property>

For details on hosting settings, refer to the Limits, Permissions and Hosting Settings (on page 305) section.

Representation of Object Descriptor

21

Extension of Limits Descriptor


Number of limits have values equal ot users of different access levels. For instance, mailbox quota is a shared parameter, because it's value is equal both for a client and for domain administrator. Graphically, the extension node can be represented in the following way:

The shared node is required. Data type: boolean. Extension node sample
<property> <name>max_subdom</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_subdom</label> <extension> <shared>false</shared> </extension> </property>

For details on limits, refer to the Limits and Permissions (on page 35) (client's settings), or Limits, Permissions and Hosting Settings (on page 305) (domain and domain administrator's settings) sections.

Representation of Object Descriptor

22

Bind Parameters
Bind parameters hold correlation between properties of the object. Typical bind parameter has the following graphical representation:

The bind node is optional. It specifies the bind parameter. Data type: BindType (descriptor.xsd). If it is specified, it contains the following parameters: The ref node is required. It specifies name of a property to be bound with other properties. The relevant node is optional. It contains rules defining dependence of the property on another. A depended property can be editable only if the "master" property's value (or read-only indicator) is equal to a specified value. Data type: RelevantType (descriptor.xsd). If it is specified, it contains the following parameters: The name node is required. It specifies name of another property this property will depend on. Data type: string. The value node is required. It specifies value of another property this property will depend on. Data type: string. The read-only node is required. It specifies if the property (defined in ref node) will be editable on fulfilling conditions defined in the relevant node. Data type: boolean.

The read-only node is required. It defines if the property is editable for users. Data type: boolean.

Note: read-only is of higher priority than writable-by.

Representation of Object Descriptor

23

Remarks Multiple bind nodes for a single property descriptor are treated as logical disjunction of correlations. Multiple relevant nodes are treated as logical conjunction of the rules. This rule tells to make PHP ISAPI support editable only if PHP support is editable and checked.
<bind> <ref>php_isapi</ref> <relevant> <id>php</id> <read-only>0</read-only> </relevant> <relevant> <id>php</id> <value>1</value > </relevant> <read-only>0</read-only> </bind>

Filters of Descriptors
Filters used by descriptors differs from filters used by operators. There are client-level and domain-level filters for object descriptors. Client-level filters can specify a client by ID or login name. Domain-level filters can specify a domain by name, ID, or they can specify multiple domains belonging to a specified client by client ID or login name. If the filter node is not blank (<filter/>) the server will return descriptor for an object, specified by filtering rule parameters. In this case there will be filter-id and id nodes in the response packet. If the filter node is blank the server will return the server-level descriptor for a specified object. In this case there will not be filter-id and id nodes in the response packet. A single filter node cannot contain filtering parameters presented by different nodes in XML schema, but can contain multiple filtering parameters presented by the same node in XML schema. For details on descriptors, refer to the Descriptors section of the Programming Guide.

24

CHAP

TER

Supported Operations
This chapter can serve as a guide on how each Plesk object can be managed programmatically via Plesk API RPC protocol. Each section is devoted to a particular object or range of objects. For your convenience the sections are arranged in alphabetical order. Each section, at first, lists all operations on the objects in focus that are supported by API RPC, then each operation is considered in detail with XML code samples. The detailed description touches upon the structure of the request and response packets.

In this chapter:
Managing Client Accounts ............................................................................. 25 Managing Client Templates............................................................................ 88 Managing Database Servers .......................................................................... 112 Managing Databases ..................................................................................... 146 Managing Desktop Presets ............................................................................ 190 Managing DNS .............................................................................................. 211 Managing Domain Accounts .......................................................................... 290 Managing Domain Aliases ............................................................................. 387 Managing Domain Templates......................................................................... 411 Managing Domain-Level Mail ......................................................................... 445 Managing FTP Accounts ................................................................................ 492 Managing IP Addresses ................................................................................. 534 Managing Locales ......................................................................................... 538 Managing Log Rotation on Domain ................................................................ 567 Managing Mailing Lists .................................................................................. 596 Managing Plesk Backups ............................................................................... 655 Managing Plesk Server .................................................................................. 696 Managing Plesk Updates ............................................................................... 829 Managing Secret Keys ................................................................................... 764 Managing Sessions ....................................................................................... 776 Managing Site Applications ............................................................................ 781 Managing Spam Filtering Service ................................................................... 815 Managing SSL Certificates ............................................................................. 861 Managing Virtual Directories .......................................................................... 878 Managing Web Users .................................................................................... 891 Migrating Domain And Client Accounts ........................................................... 927 Retrieving Action Log Data............................................................................. 954 Uploading Files to Server ............................................................................... 960

Supported Operations

25

Managing Client Accounts


Operator: <client> XML Schema: client_input.xsd, client_output.xsd, plesk_client.xsd Plesk version: all versions API RPC version: all versions Plesk user: Plesk Administrator Description The hierarchy of Plesk users includes clients, domain administrators, and email users (enumerated in the descending level order). Creating a Plesk Client is equivalent to creating a special client account. This operation is allowed to Plesk Administrator only. The upper level client account is provided to a customer whose business is reselling hosting services or hosting multiple domains/web sites. Client account presents a set of Plesk Client personal data and a collection of various settings. These settings are as follows: Limits on use of Plesk resources Plesk Client access permissions Plesk Client IP pool settings Plesk client template (if specified)

Once created, a client account is allotted a portion of Plesk server disk space and other Plesk resources. A client account can be created with a unique collection of settings, or this can be done using a client template (a special object that holds a collection of predefined settings). To learn more about client templates, refer to section Managing Client Templates (see page 88). In turn, Plesk Client can create and manage domains and user accounts that share the disk space of the 'parent' client account.

Supported Operations

26

Supported operations

ADD (see page 44) creates new client account to Plesk database; GET (see page 50) retrieves the information about the specified client account(s) from Plesk database DEL (see page 57) deletes the specified client account(s) from Plesk database SET (see page 61) updates/ modifies certain information about the specified client account(s) in Plesk database IPPOOL_ADD_IP (see page 67) adds IP addresses to the clients IP pool IPPOOL_DEL_IP (see page 70) removes IP addresses from the clients IP pool CFORM_BUTTONS_LIST (see page 72) retrieves the list of buttons displayed on the client page in Plesk Control Panel. GET-LIMIT-DESCRIPTOR (on page 78) retrieves client limits descriptors GET-PERMISSION-DESCRIPTOR (on page 84) retrieves client permissions descriptors

Supported Operations

27

Filtering Issues
Filtering is the way the request packets pick out clients to which the requested operation will be applied. The filter node is presented by the ClientSelectionFilterType complex type (client_input.xsd). This data type is structured as follows:

The id node is optional. It specifies the identifier of the client account. Data type: integer. The login node is optional. It specifies the login name of the client account. Data type: string.

Both the client identifier and the client login are unique in the Plesk database. The following packet deletes three client accounts specified by id:
<packet version=1.4.2.0> <client> <del> <filter> <id>124</id> <id>125</id> <id>127</id> </filter> </del> </client> </packet>

The following packet is identical except it specifies client accounts by name:


<packet version=1.4.2.0> <client> <del> <filter> <login>advent</login> <login>freescale</login> <login>talkmore</login> </filter> </del> </client> </packet>

Supported Operations

28

The following packet is invalid as both the id node and the login node are used in the same filter:
<packet version=1.4.2.0> <client> <del> <filter> <login>advent</login> <id>125</id> <login>talkmore</login> </filter> </del> </client> </packet>

To fix this problem, use two different <del> sections:


<packet version=1.4.2.0> <client> <del> <filter> <login>advent</login> <login>talkmore</login> </filter> </del> <del> <filter> <id>125</id> </filter> </del> </client> </packet>

Client Settings
This section describes a collection of client account and Plesk Client settings. These settings can be defined when creating a new client account or later, and retrieved from Plesk database as well. These settings are as follows: General Client Account settings (see page 28) Limits (on page 35) on use of Plesk resources set for the client account Plesk Client permissions (on page 35)

The above settings can also be read from Plesk database along with IP pool settings (see page 42) and statistics (see page 43) on use of various Plesk resources by the given Plesk Client.

Supported Operations

29

General Client Account Settings


General client account settings are specified by three data types as follows: type clientAddGenInfo (see page 29) - used when creating the client account with the add operation type clientGetGenInfo (see page 31) - used when retrieving the general information from Plesk database using the get operation type clientSetGenInfo (see page 33) - used when updating the client account using the set operation

Type clientAddGenInfo When creating the client account, the general client account information is specified by complex type clientAddGenInfo (plesk_client.xsd). It is structured as follows:

Supported Operations

30

The cname node is optional. Specifies the company name. Data type: string (0 to 60 characters long). The pname node is required. Specifies the personal name of the customer who owns the client account. Data type: string (1 to 60 characters long). The login node is required. Specifies the login name of the client account. Data type: string (1 to 60 characters long). The passwd node is required. Specifies the password of the client account. Data type: string (5 to 14 characters long) . The status node is optional. Specifies the current status of the client account. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 16 (disabled_by admin) | 4 (under backup/restore) | 256 (expired). Only status values 0 and 16 can be set up. The phone node is optional. Specifies the phone number of the client account owner. Data type: string (0 to 30 characters long). The fax node is optional. Specifies the fax number of the client account owner. Data type: string (0 to 30 characters long). The email node is optional. Specifies the email address of the client account owner. Data type: string (0 to 255 characters long). The address node is optional. Specifies the postal address of the client account owner. Data type: string (0 to 255 characters long). The city node is optional. Specifies the city of the client account owner. Data type: string (0 to 50 characters long). The state node is optional. Specifies the US state of the client account owner (should be specified for US citizens only). Data type: string (0 to 50 characters long). The pcode node is optional. Specifies the zip code of the client account owner (specified for US citizens only). Data type: string (0 to 10 characters long). The country node is optional. Specifies the 2-character country code of the client account owner (US for United States, CA for Canada, etc.). Data type: string (2 characters long). The locale node is optional. Specifies the locale used on the client account. Data type: string. Default value: en.

Note: In API RPC v.1.5.0.0 and later, use four-letter locale names (RFC 1766). The default value for the node is en-US. If you specify two-letter locale name in a request packet, you will receive the error (error code 1019). The uid node is deprecated.

The following packet creates a client account and defines the general settings for it:
<packet version="1.5.1.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <status>0</status> <phone>416 907 9944</phone>

Supported Operations <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> </add> </client> </packet>

31

Type clientGetGenInfo When getting the general client account information, complex type clientAddGenInfo (plesk_client.xsd) is used in the response get packet. It is structured as follows (pared-down variant):

Supported Operations

32

The cr_date node is required. It specifies the date when the specified client account was created. Data type: date. The cname node is required. Specifies the company name. Data type: string (1 to 60 characters long). The pname node is required. Specifies the personal name of the customer who owns the client account. Data type: string (1 to 60 characters long). The login node is required. Specifies the login name of the client account. Data type: string (1 to 20 characters long). The status node is required. Specifies the current status of the client account. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 16 (disabled_by admin) | 4 (under backup/restore) | 256 (expired). Default value: 0 The phone node is required. Specifies the phone number of the client account owner. Data type: string (0 to 30 characters long). The fax node is required. Specifies the fax number of the client account owner. Data type: string (0 to 30 characters long). The email node is required. Specifies the email address of the client account owner. Data type: string (0 to 255 characters long). The address node is required. Specifies the postal address of the client account owner. Data type: string (0 to 255 characters long). The city node is required. Specifies the city of the client account owner. Data type: string (0 to 50 characters long). The state node is required. Specifies the US state of the client account owner (specified for US citizens only). Data type: string (0 to 50 characters long). The pcode node is required. Specifies the zip code of the client account owner (specified for US citizens only). Data type: string (0 to 10 characters long). The country node is required. Specifies the 2-character country code of the client account owner (US for United States, CA for Canada, etc.). Data type: string (2 characters long). The locale node is required. Specifies the locale used on the client account. Data type: string. Default value: en.

Note: In API RPC v.1.5.0.0 and later, use four-letter locale names (RFC 1766). The default value for the node is en-US. If you specify two-letter locale name in a request packet, you will receive the error (error code 1019). The password node is optional. Specifies the client account password. Data type: string. Deprecated in API RPC v.1.4.2.0. The password_type node is optional. Specifies the type of the client account password. Data type: string. Allowed values: crypt | plain. The passwd node is optional. Specifies the client account password. Data type: string. Obsolete, used by API RPC 1.3.2 and earlier. The uid and the global-login nodes are deprecated.

Supported Operations

33

Type clientSetGenInfo When setting the general client account information, complex type clientSetGenInfo (plesk_client.xsd) is used in the response set packet. It is structured as follows:

The cname node is optional. It specifies the company name. Data type: string (1 to 60 characters long). The pname node is optional. It specifies the personal name of the customer who owns the client account. Data type: string (1 to 60 characters long). The login node is optional. It specifies the login name of the client account. Data type: string (1 to 20 characters long). The passwd node is optional. It specifies the client account password.Data type: string. The global-login and the uid nodes are deprecated.

Supported Operations

34

The status node is optional. It specifies the current status of the client account. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 16 (disabled_by admin) | 4 (under backup/restore) | 256 (expired). Default value: 0. Only status values 0 and 16 can be set up. The phone node is optional. It specifies the phone number of the client account owner. Data type: string (0 to 30 characters long). The fax node is optional. It specifies the fax number of the client account owner. Data type: string (0 to 30 characters long). The email node is optional. It specifies the email address of the client account owner. Data type: string (0 to 255 characters long). The address node is optional. It specifies the postal address of the client account owner. Data type: string (0 to 255 characters long). The city node is optional. It specifies the city of the client account owner. Data type: string (0 to 50 characters long). The state node is optional. It specifies the US state of the client account owner (specified for US citizens only). Data type: string (0 to 50 characters long). The pcode node is optional. It specifies the zip code of the client account owner (specified for US citizens only). Data type: string (0 to 10 characters long). The country node is optional. It specifies the 2-character country code of the client account owner (US for United States, CA for Canada, etc.). Data type: string (2 characters long). The locale node is optional. It specifies the locale used on the client account. Data type: string. Default value: en.

Supported Operations

35

Limits and Permissions


This section contains limits and permissions settings for client accounts. Starting from API RPC 1.5.0.0 you can manage the settings using descriptors. For details on descriptors, refer to the Presentation of Object Descriptor (on page 16) section in API Reference and the Descriptors section in the Programming Guide. API RPC 1.4.2.0 and Earlier Versions This section contains limits and permissions settings of a client account, that are available in API RPC v.1.4.2.0 and earlier. Limits The limits on use of Plesk resources are defined by complex type clientLimits (plesk_client.xsd). It is structured as follows:

The max_webapps node is optional. Specifies the maximum number of Tomcat web applications available for the client. Data type: string.

Supported Operations

36

The max_maillists node is optional. Specifies the maximum number of mailing lists available for the client. Data type: string. The max_resp node is optional. Specifies the maximum number of email autoresponders available for the client. Data type: string. The max_mg node is optional. Specifies the maximum number of mail groups available for the client. Data type: string. The max_redir node is optional. Specifies the maximum number of redirects available for the client. Data type: string. The mbox_quota node is optional. Specifies the maximum mail box size (in bytes) allowed for the client. Data type: string. The max_box node is optional. Specifies the maximum number of mailboxes allowed for the client. Data type: string. The max_db node is optional. Specifies the maximum number of MySQL databases available for the client. Data type: string. The max_wu node is optional. Specifies the maximum quantity of web users allowed for the client. Data type: string. The max_traffic node is optional. Specifies the limit (in bytes) on the traffic for the client. Data type: string. The disk_space node is optional. Specifies the limit on disk space (in bytes) for the client. Data type: string. The max_subdom node is optional. Specifies the maximum number of subdomains available for the client. Data type: string. The max_dom node is optional. Specifies the limit on the number of domains for the client. Data type: string. The expiration node is optional. Specifies the validity period of the client account in the UNIX timestamp format. Data type: string. The total_mboxes_quota node is optional. Specifies the total size of all mailboxes (in bytes) allowed for the client. Data type: string. Makes sense for Plesk for Windows only. The mysql_dbase_space node is optional. Specifies the maximum disk space (in bytes) occupied by all MySQL databases belonging to the client. Data type: string. Makes sense for Plesk for Windows only. The mssql_dbase_space node is optional. Specifies the maximum disk space (in bytes) occupied by all Microsoft SQL databases belonging to the client. Data type: string. Makes sense for Plesk for Windows only. The max_mssql_db node is optional. Specifies the maximum number of Microsoft SQL databases available for the client. Data type: string. Makes sense for Plesk for Windows only. The max_iis_app_pools node is optional. Specifies the maximum number of IIS application pools available for the client. Data type: string. Makes sense for Plesk for Windows only. The max_shared_ssl_links node is optional. Specifies the maximum number of shared SSL links available for the client. Data type: string. Makes sense for Plesk for Windows only. The max_subftp_users node is optional. Specifies the maximum number of additional FTP accounts. Data type: integer. Supported in version 1.4.1.0 and higher. Makes sense for Plesk for Windows only.

Supported Operations

37

The max_fpse_users node is optional. Specifies the maximum number of additional Microsoft FrontPage accounts. Data type: integer. Supported in version 1.4.1.0 and higher. Makes sense for Plesk for Windows only. The max_dom_aliases node is optional. Specifies the maximum number of domain aliases allowed for the Plesk Client just created. Data type: integer. The max_odbc node is optional. Specifies the maximum number of ODBC connections allowed for the Plesk Client just created. Data type: integer. Makes sense for Plesk for Windows only. The feature is supported by API RPC 1.4.2.0 and later.

The following packet creates a client account and sets the limits for it:
<packet version="1.4.2.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <passwd>Jhtr66fBB</passwd> <status>0</status> <phone>416 907 9944</phone> <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </add> </client> </packet>

Supported Operations

38

Permissions Client permissions are presented by complex type clientPerms (plesk_client_xsd). It is structured as follows:

The create_domains node is optional. It allows/disallows the client to create domains. Data type: Boolean. The manage_phosting node is optional. It allows/disallows the client to manage physical hosting. Data type: Boolean. The manage_quota node is optional. It allows/disallows the client to change the hard disk limit. Data type: Boolean. The manage_subdomains node is optional. It allows/disallows the client to manage subdomains. Data type: Boolean. The manage_not_chroot_shell node is optional. It allows/disallows the client to manage shell without changing the mount point of the UNIX root. Data type: Boolean.

Supported Operations

39

The change_limits node is optional. It allows/disallows the client to change the domain limits. Data type: Boolean. The manage_dns node is optional. It allows/disallows the client to manage DNS settings. Data type: Boolean. The manage_log node is optional. It allows/disallows the client to manage log rotation. Data type: Boolean. The manage_crontab node is optional. It allows/disallows the client to manage the task scheduler. Data type: Boolean. The manage_anonftp node is optional. It allows/disallows the client to manage Anonymous FTP. Data type: Boolean. The manage_webapps node is optional. It allows/disallows the client to manage Tomcat web applications. Data type: Boolean. The manage_sh_access node is optional. It allows/disallows the client to use shell access and provide it to users. Data type: Boolean. The manage_maillists node is optional. It allows/disallows the client to manage mailing lists. Data type: Boolean. The manage_drweb node is optional. It allows/disallows the client to manage the DrWeb antivirus program. Data type: Boolean. Available in Plesk 7.1 and higher if DrWeb is supported by the key. The make_dumps node is optional. It allows/disallows the client to use backup/restore functions. Data type: Boolean. The site_builder node is optional. It allows/disallows the client to use SiteBuilder. Data type: Boolean. Available in Plesk 7.1 and higher, not used in Plesk for UNIX beginning with version 8.0. The remote_access_interface node is optional. It allows/disallows the client to use API RPC. Data type: Boolean. Supported in Plesk 7.5.4 for UNIX and later, API RPC 1.3.5 and higher. The manage_performance node is optional. It allows/disallows the client to manage hosting performance. Data type: Boolean. Is used for Plesk for Windows only. The cp_access node is optional. It allows/disallows the client to access Plesk via Control Panel. Data type: Boolean. The manage_domain_aliases node is optional. It allows/disallows the client to manage domain aliases. Is used in Plesk for UNIX only. Data type: Boolean. Supported in API RPC 1.4.0.0 and higher. The manage_iis_app_pool node is optional. It allows/disallows the client to manage IIS application pool. Data type: Boolean. Makes sense for Plesk for Windows only. The dashboard node is optional. It allows/disallows the client to use Plesk Desktop. Data type: Boolean. The stdgui node is optional. It allows/disallows the client to use the standard Plesk GUI. Data type: Boolean. The manage_dashboard node is optional. It allows/disallows the client to manage Plesk Desktop. Data type: Boolean. The manage_subftp node is optional. It allows/disallows the client to manage additional FTP accounts (with access to the specified domain folders only) created on domains. Data type: Boolean. Supported beginning with version 1.4.1.0 of API RPC.

Supported Operations

40

The manage_spamfilter node is optional. It allows/disallows Plesk Client to manage spam filter settings. Data type: Boolean. Makes sense for Plesk for UNIX only. The feature is supported by API RPC 1.4.2.0 and later. The allow_local_backups node is optional. It allows/disallows Plesk Client to use the local repository for backup/restore functions. Data type: Boolean. Makes sense for Plesk for UNIX only. The feature is supported by API RPC 1.4.2.0 and later. The allow_ftp_backups node is optional. It allows/disallows Plesk Client to use the FTP repository for backup/restore functions. Data type: Boolean. Makes sense for Plesk for UNIX only. The feature is supported by API RPC 1.4.2.0 and later.

The following sample packet creates a client account and sets permissions for it:
<packet version="1.4.2.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <passwd>Jhtr66fBB</passwd> <status>0</status> <phone>416 907 9944</phone> <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> <permissions> <create_domains>true</create_domains> <manage_phosting>true</manage_phosting> <manage_quota>false</manage_quota> <manage_subdomains>true</manage_subdomains> <change_limits>true</change_limits> <manage_dns>true</manage_dns> <manage_log>true</manage_log> <manage_anonftp>true</manage_anonftp> <manage_webapps>true</manage_webapps> <manage_sh_access>true</manage_sh_access> <manage_maillists>true</manage_maillists> <make_dumps>true</make_dumps> <remote_access_interface>true</remote_access_interface> <cp_access>true</cp_access> <manage_domain_aliases>true </manage_domain_aliases> </permissions> </add> </client> </packet>

Supported Operations

41

API RPC 1.5.0.0 and Later Versions This section contains clients limits and permissions settings of a client account, that are available in API RPC v.1.5.0.0 and later. Limits The limits node is presented by clientLimits type (plesk_client.xsd), and its graphical representation is as follows:

The limit node is required. It specifies parameters of a limit. Data type: PleskLimitType (plesk_client.xsd). The name node is required. It specifies a limit name. Data type: sting. The value node is required. It specifies a limit value. Data type: any.

Note: You can specify multiple limit parameters in one limits node. The following code represents maximum databases limit:
<limits> <limit> <name>max_db</name> <value>100</value> </limit> </limits>

Note: To manage limits, you should first retrieve limits descriptor (for a specified client), containing names of limits. For details, refer to the Retrieving Descriptor of Limits (on page 78) section. Permissions The permissions node is presented by clientPerms type (plesk_client.xsd), and its graphical representation is as follows:

The permission node is required. It specifies parameters of a permission. Data type: PleskPermissionType (plesk_client.xsd). The name node is required. It specifies a permission name. Data type: sting.

Supported Operations

42

The value node is required. It specifies a permission value. Data type: any.

Note: You can specify multiple permission parameters in one permissions node.

The following code represents maximum databases limit:


<permissions> <permission> <name>create_domains</name> <value>100</value> </permission> </limits>

Note: To manage permissions, you should first retrieve permissions descriptor (for a specified client), containing names of permissions. For details, refer to the Retrieving Descriptor of Permissions (on page 84) section.

IP Pool Settings
Every client account has its own pool of IP addresses. It is presented in XML packets by node ippool of type ipPoolType (plesk_client.xsd). This node is structured as follows:

The ip-address node is optional. It specifies a single IP address currently available in the IP pool of the Plesk Client. Data type: ip_address (string).

Supported Operations

43

Statistics
The statistics requested from Plesk database for a certain Plesk Client is returned in the stat node of type clientStatType (plesk_client.xsd). This node is structured as follows:

The active_domains node is required. It specifies the number of active domains created by Plesk Client. Data type: unsignedInt. Default value: 0. The subdomains node is required. It specifies the number of sub-domains created by Plesk Client. Data type: unsignedInt. Default value: 0. The disk_space node is required. It specifies the amount of disk space occupied by the given Plesk Client. Data type: integer. Default value: 0. The postboxes node is required. It specifies the number of email boxes created by Plesk Client. Data type: unsignedInt. Default value: 0. The redirects node is required. It specifies the number of redirects created by Plesk Client. Data type: unsignedInt. Default value: 0. The mail_groups node is required. It specifies the number of email groups created by Plesk Client. Data type: unsignedInt. Default value: 0. The mail_resps node is required. It specifies the number of automatic response messages created by Plesk Client. Data type: unsignedInt. Default value: 0. The mail_lists node is required. It specifies the number of mailing lists created by Plesk Client. Data type: unsignedInt. Default value: 0.

Supported Operations

44

The web_users node is required. It specifies the number of web users created by Plesk Client. Data type: unsignedInt. Default value: 0. The data_bases node is required. It specifies the number of databases used by Plesk Client. Data type: unsignedInt. Default value: 0. The webapps node is required. It specifies the number of Tomcat web applications used by Plesk Client. Data type: unsignedInt. Default value: 0. The traffic node is required. It specifies the amount of traffic (in bytes) spent by Plesk Client monthly. Data type: integer. Default value: 0. The traffic_prevday node is required. It specifies the amount of traffic (in bytes) spent by Plesk Client during the previous day. Data type: integer. Default value: 0.

Supported Operations

45

Creating Client Account


Client accounts can be created by Plesk Administrator only. Client account presents some general information about Plesk Client and a collection of various settings. These settings are as follows: Limits on use of Plesk resources Plesk Client access permissions Plesk Client IP pool settings Client template on which the client account is based

The general information is always specified when creating a client account, while settings can be specified later. The only exception is a client template. It can be applied only when creating the client account. To learn more about client templates, refer to section Managing Client Templates (see page 88).

Request Packet Structure


A request XML packet adding a new client account to Plesk database includes the add operation node:
<packet version=1.4.2.0> <client> <add> </add> </client> </packet>

The add node does not have a separate type, it is nested within the ClientTypeRequest complex type (client_input.xsd). The add node has the following graphics representation:

Supported Operations

46

The gen_info node is required. Specifies the general information about the new client account. Data type: clientAddGenInfo (plesk_client.xsd). See the structure of this node in topic General Client Account Settings (see page 29). The add_packages_to_client_pool is optional. Specifies the list of web application distributions that should be added to the client pool (to be deployed to the client's domains later). Data type: none. See the structure of this node below. The limits node is optional. Specifies the set of limits imposed on Plesk resources accessible to the new client. Data type: clientLimits (plesk_client.xsd). See the structure of this node in the Limits and Permissions (on page 35) topic. The permissions node is optional. Specifies the clients list of permissions for using Plesk resources and managing own services. Data type: clientPerms (plesk_client.xsd). See the structure of this node in the Limits and Permissions (on page 35) topic. The template-id node is required. Is used to specify the client template if the new client account must be based on any. Data type: integer. The feature is supported in API RPC 1.4.2.0 and later. The template-name node is required. Is used to specify the client template name if the new client account must be based on any. Data type: string. The feature is supported in API RPC 1.4.2.0 and later. The sbnet-user node is optional. Is true if a SiteBuilder user should be created when creating the client template. Data type: Boolean. Makes sense for Plesk for Windows only. The feature is supported in API RPC 1.4.2.0 and later.

The add_packages_to_client_pool node doesn't have a special data type, it is defined within the add node as follows:

The package_id node is required. It specifies the identifier of the distribution package to be added to the client pool. Data type: integer.

Supported Operations

47

Request Samples
The following packet creates a client account and sets the collection of settings for it:
<packet version="1.4.2.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <passwd>Jhtr66fBB</passwd> <status>0</status> <phone>416 907 9944</phone> <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> </add> </client> </packet>

A client account can be created using a client template. The following packet performs this task:
<packet version="1.4.2.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <passwd>Jhtr66fBB</passwd> <status>0</status> <phone>416 907 9944</phone> <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> <template-name>base_template</template-name> </add> </client> </packet>

Client templates normally define a collection of client settings (limits, permissions, etc), so this packet creates a client account with these settings set already. See the Managing Client Templates (see page 88) section for details.

Supported Operations

48

To create multiple client accounts (e.g., using a client template), use a different add operations for each:
<packet version="1.4.2.0"> <client> <add> <gen_info> <cname>LogicSoft Ltd.</cname> <pname>Stephen Lowell</pname> <login>stevelow</login> <passwd>Jhtr66fBB</passwd> <status>0</status> <phone>416 907 9944</phone> <fax>928 752 3905</fax> <email>host@logicsoft.net</email> <address>105 Brisbane Road, Unit 2</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> </add> <add>

<gen_info> <cname>TechnoSoft Ltd.</cname> <pname>James Hardy</pname> <login>jhard</login> <passwd>Jk8Dhh6fBB</passwd> <status>0</status> <phone>416 907 3366</phone> <fax>928 752 3377</fax> <email>james@technosoft.net</email> <address>122 Greenroad Valley, Unit 1</address> <city>Toronto</city> <state/> <pcode/> <country>CA</country> </gen_info> <template-name>base_template</template-name> </add> </client> </packet>

Supported Operations

49

Response Packet Structure


The add node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested add operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the add operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the add operation fails. Data type: string. The id node is optional. It is required if the add operation succeeds. Returns the unique identifier of the client account just added to Plesk. Data type: integer.

Response Samples
A response packet received after the client account is created successfully looks as follows:
<packet version=1.4.2.0> <client> <add> <result> <status>ok</status> <id>2435</id> </result> </add> </client> </packet>

If the packet created more than one client account, each create operation will be reported in a separate add node:
<packet version=1.4.2.0> <client> <add> <result> <status>ok</status>

Supported Operations <id>2435</id> </result> </add> <add> <result> <status>ok</status> <id>2436</id> </result> </add> </client> </packet>

50

If the operation fails, the negative response can look as follows:


<packet version=1.4.2.0> <client> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </client> </packet>

or:
<packet version=1.4.2.0> <client> <add> <result> <status>ok</status> <id>2435</id> </result> </add> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </client> </packet>

The add sections will follow one another in the order they have been listed in the request packet.

Supported Operations

51

Getting Information About Client Accounts


The get operation is used to retrieve client account settings from Plesk database. These settings are as follows: General information about Plesk Client (name, company, contact data, and so on) Statistics on this Plesk Client Limits on use of Plesk resources set for this Plesk Client Access permissions set for this Plesk Client IP pool settings set for this Plesk Client

To retrieve this information, send a request packet with the get operation to Plesk server.

Request Packet Structure


A request XML packet retrieving information about the client accounts from Plesk database includes the get operation node:
<packet version=1.4.2.0> <client> <get> </get> </client> </packet>

The get node does not have a separate type, it is nested within the ClientTypeRequest complex type (client_input.xsd). The get node has the following graphics representation:

Supported Operations

52

The dataset node is required. It indicates the types of information requested from Plesk database. Data type: clientDatasetType (plesk_client.xsd). The gen_info node is optional. It is used to request for the general client account settings. Data type: none. The stat node is optional. It is used to request statistics on the specified clients. Data type: none. The permissions node is optional. It is used to request permissions set for the specified Plesk Clients. For details, refer to the Limits and Permissions (on page 35) section. Data type: none. The limits node is optional. It is used to request the limits set for the specified clients. For details, refer to the Limits and Permissions (on page 35) section. Data type: none. The ippool node is optional. It is used to request the IP pool configuration settings for the specified clients. Data type: none.

Request Samples
To get the information about the client account, specify the packet as follows:
<packet version=1.4.2.0> <client> <get> <filter> <id>1324</id> </filter> <dataset> <gen_info/> <stat/> <permissions/> <limits/> <ippool/> </dataset> </get> </client> </packet>

To send a similar packet for multiple client accounts, use the packet as follows:
<packet version=1.4.2.0> <client> <get> <filter> <id>1324</id> <id>1325</id> </filter> <dataset> <gen_info/> <stat/> <permissions/> <limits/> <ippool/> </dataset> </get> </client> </packet>

Supported Operations

53

You cannot identify multiple client accounts by different parameters (id and login) in the same filter section. The following packet will be invalid:
<packet version=1.4.2.0> <client> <get> <filter> <id>1324</id> <login>technolux</login> </filter> <dataset> <gen_info/> <stat/> <permissions/> <limits/> <ippool/> </dataset> </get> </client> </packet>

To fix this packet, use multiple get sections:


<packet version=1.4.2.0> <client> <get> <filter> <id>1324</id> </filter> <dataset> <gen_info/> <stat/> </dataset> </get> <get> <filter> <login>technolux</login> </filter> <dataset> <permissions/> <limits/> <ippool/> </dataset> </get> </client> </packet>

Supported Operations

54

Response Packet Structure


The get node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested get operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the get operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the get operation fails. Data type: string. The filter-id node is optional. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. Data type: anySimple. The id node is optional. It is required if the get operation succeeds. Returns the unique identifier of the client account whose data is received from Plesk database. Data type: integer. The data node is optional. It is present if the get operation succeeds. Returns a requested collection of Plesk Client settings. Data type: clientData (plesk_client.xsd). See the structure of this node below.

Supported Operations

55

The data node is defined by complex type clientData (plesk_client.xsd). It is structured as follows:

The gen_info node is optional. It returns a collection of general client account settings. Data type: clientGetGenInfo (plesk_client.xsd). See the structure of this node in topic General Client Account Settings. The stat node is optional. It returns a the statistics collected on the specified client account. Data type: clientStatType (plesk_client.xsd). See the structure of this node in the Statistics (see page 43) topic. The permissions node is optional. It returns a collection of permissions set for the specified client account. Data type: clientPerms (plesk_client.xsd). For details, refer to the Limits and Permissions (on page 35) section. The limits node is optional. It returns a collection of limits set for the specified client account. Data type: clientLimits (plesk_client.xsd). For details, refer to the Limits and Permissions (on page 35) section. The ippool node is optional. It returns the IP pool configuration settings for for the specified client account. Data type: ipPoolType (plesk_client.xsd). See the structure of this node in the IP Pool Settings (see page 42) topic. The sbnet-user node is optional. It indicates whether a SiteBuilder user account was created for the given client account. Data type: Boolean. The feature is supported by API RPC 1.4.2.0 and later. Makes sense for Plesk for Windows only.

Supported Operations

56

Response Samples
If you use API RPC 1.5.0.0 or later versions, a positive response from the server can look as follows:
<packet version=1.5.0.0> <client> <get> <result> <status>ok</status> <id>1324</id> <data> <limits> <limit> <name>disk_space</name> <value>209715200</value> </limit> <limit> <name>max_dom</name> <value>50</value> </limit> <limit> <name>max_subdom</name> <value>250</value> </limit> <limit> <name>max_webapps</name> <value>30</value> </limit> <limit> <name>max_traffic</name> <value>209715200</value> </limit> <limit> <name>max_db</name> <value>30</value> </limit> <limit> <name>expiration</name> <value>1134616208</value> </limit> </limits> <sbnet-user>false</sbnet-user> </data> </result> </get> </client> </packet>

Supported Operations

57

If you use API RPC 1.4.2.0 or earlier versions, a positive response from the server can look as follows:
<packet version=1.4.2.0> <client> <get> <result> <status>ok</status> <id>1324</id> <data> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> <sbnet-user>false</sbnet-user> </data> </result> </get> </client> </packet>

A negative response can look as follows:


<packet version=1.4.2.0> <client> <get> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1324</id> </result> </get> </client> </packet>

Supported Operations

58

Deleting Client Accounts


The del operation is used to remove the specified client account and all its settings from Plesk database.

Request packet Structure


A request XML packet deleting a client account from Plesk database includes the del operation node:
<packet version=1.4.2.0> <client> <del> </del> </client> </packet>

The del node does not have a separate type, it is nested within the ClientTypeRequest complex type (client_input.xsd). The del node has the following graphics representation:

The filter node is required. It is used to uniquely identify the client account either by id, or by login. Data type: clientSelectionFilterType (client_input.xsd). The id node is optional. It specifies the unique identifier of the client account. Data type: integer. The login node is optional. It specifies the unique login of the client account. Data type: string.

Request Samples
A single request packet can delete a client account or multiple client accounts. If multiple client accounts are deleted, they can be filtered either by id or by login:
<packet version=1.4.2.0> <client> <del> <filter> <id>1324</id> <id>1325</id> </filter>

Supported Operations </del> </client> </packet>

59

Or:
<packet version=1.4.2.0> <client> <del> <filter> <login>technolux</login> <login>advent</login> </filter> </del> </client> </packet>

The following packet is invalid as it uses both id and login in the same filter:
<packet version=1.4.2.0> <client> <del> <filter> <id>1324</id> <login>advent</login> </filter> </del> </client> </packet>

To fix this packet, use multiple del sections:


<packet version=1.4.2.0> <client> <del> <filter> <id>1324</id> </filter> </del> <del> <filter> <login>advent</login> </filter> </del> </client> </packet>

Supported Operations

60

Response Packet Structure


The del node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested del operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the del operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the del operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the del operation fails. Data type: string. The filter-id node is optional. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. Data type: anySimple. The id node is optional. It is required if the del operation succeeds. Returns the unique identifier of the client account just deleted from Plesk. Data type: integer.

Response Samples
After the specified client account has been deleted successfully, the response received from Plesk server can look as follows:
<packet version=1.4.2.0> <client> <del> <result> <status>ok</status> <id>1324</id> </result> </del> </client> </packet>

Supported Operations

61

If multiple client accounts has been deleted successfully, the response packet is as follows:
<packet version=1.4.2.0> <client> <del> <result> <status>ok</status> <id>1324</id> </result> <result> <status>ok</status> <id>1325</id> </result> </del> </client> </packet>

If the operations failed, the response can look as follows:


<packet version=1.4.2.0> <client> <del> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1325</id> </result> </del> </client> </packet>

Setting Client Account Properties


A client account stored in Plesk database can be updated by Plesk Administrator. This update can refer to any or all of the following settings: General Plesk Client settings Limits on use of Plesk resources Plesk Client access permissions Sitebuilder user account

Supported Operations

62

Request Packet Structure


A request XML packet setting various settings for the specified client account includes the set operation node:
<packet version=1.4.2.0> <client> <set> </set> </client> </packet>

The set node does not have a separate type, it is nested within the ClientTypeRequest complex type (client_input.xsd). The set node has the following graphics representation:

The filter node is required. It is used to uniquely identify the client account. This can be done either by id, or by login. Data type: clientSelectionFilterType (client_input.xsd). The id node is optional. It specifies the unique identifier of the client account. Data type: integer. The login node is optional. It specifies the unique login of the client account. Data type: string. The values node is required. It is used to specify the categories of settings that will be set to Plesk database. Data type: none. The gen_info node is optional. It specifies a collection of general settings. Data type: clientSetGenInfo (plesk_client.xsd). See the structure of this node in topic General Client Account Settings (see page 29).

Supported Operations

63

The limits node is optional. It specifies a collection of limits set for the specified client account. Data type: clientLimits (plesk_client.xsd). For details, refer to the Limits and Permissions (on page 35) section. The permissions node is optional. It specifies a collection of Plesk Client permissions. Data type: clientPerms (plesk_client.xsd). For details, refer to the Limits and Permissions (on page 35) section. The sbnet-user node is optional. It is used to enable/disable the creation of a SiteBuilder user account for this Plesk Client. Data type: Boolean. Makes sense for Plesk for Windows only. This feature is supported by API RPC 1.4.2.0 and later.

Request Samples
The set operation can be used for setting the same collection of settings for multiple client accounts. All accounts should be filtered within the same filter either by id, or by login. If you use API RPC 1.5.0.0 or later versions, a request packet can look as follows:
<packet version=1.5.0.0> <client> <set> <filter> <login>technolux</login> <login>advent</login> </filter> <values> <limits> <limit> <name>disk_space</name> <value>209715200</value> </limit> <limit> <name>max_dom</name> <value>50</value> </limit> <limit> <name>max_subdom</name> <value>250</value> </limit> <limit> <name>max_webapps</name> <value>30</value> </limit> <limit> <name>max_traffic</name> <value>209715200</value> </limit> <limit> <name>max_db</name> <value>30</value> </limit>

Supported Operations

64

<limit> <name>expiration</name> <value>1134616208</value> </limit> </limits> </values> </set> </client> </packet>

If you use API RPC 1.4.2.0 or earlier versions, the request packet looks as follows:
<packet version=1.4.2.0> <client> <set> <filter> <id>1324</id> <id>1325</id> </filter> <values> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </values> </set> </client> </packet>

Or:
<packet version=1.4.2.0> <client> <set> <filter> <login>technolux</login> <login>advent</login> </filter> <values> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </values>

Supported Operations </set> </client> </packet>

65

The following packet is invalid as it uses both filtering parameters within the same filter:
<packet version=1.4.2.0> <client> <set> <filter> <id>1324</id> <login>advent</login> </filter> <values> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </values> </set> </client> </packet>

To fix this packet, use multiple set operations:


<packet version=1.4.2.0> <client> <set> <filter> <id>1324</id> </filter> <values> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom> <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </values> </set> <set> <filter> <login>advent</login> </filter> <values> <limits> <disk_space>209715200</disk_space> <max_dom>50</max_dom> <max_subdom>250</max_subdom>

Supported Operations <max_webapps>30</max_webapps> <max_traffic>209715200</max_traffic> <max_db>30</max_db> <expiration>1134616208</expiration> </limits> </values> </set> </client> </packet>

66

Response Packet Structure


The set node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested set operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the set operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the set operation fails. Data type: string. The filter-id node is optional. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. Data type: anySimple. The id node is optional. It is required if the set operation succeeds. Returns the unique identifier of the client account just updated. Data type: integer.

Supported Operations

67

Response Samples

Once the specified client accounts are updated, the response packet as follows is received from the server:

<packet version=1.4.2.0> <client> <set> <result> <status>ok</status> <id>1324</id> </result> <result> <status>ok</status> <id>1325</id> </result> </set> </client> </packet>

If the set operations fails, the response can look as follows:

<packet version=1.4.2.0> <client> <set> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1324</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </set> </client> </packet>

Supported Operations

68

Adding IP Addresses to Clients IP Pool


The ippool_add_ip operation is used to add IP addresses to the IP pool of the specified client account.

Request Packet Structure


A request XML packet adding a new IP address to the IP pool of the specified Plesk Client includes the ippool_add_ip node:
<packet version=1.4.2.0> <client> <ippool_add_ip> </ippool_add_ip> </client> </packet>

The ippool_add_ip node is specified by type ipPoolOperateType (plesk_client.xsd). The ippool_add_ip node has the following graphics representation:

The client_id node is required. It specifies the unique identifier of the client account whose IP pool is added with new IP addresses. Data type: integer. The ip_address node is required. It specifies the IP address to be added to the IP pool of the specified Plesk Clients. Data type: ip_address (common.xsd).

Request Samples
To add an IP address to the clients IP pool, specify the packet as follows:
<packet version=1.4.2.0> <client> <ippool_add_ip> <client_id>1234</client_id> <ip_address>192.0.2.122</ip_address> <ip_address>192.0.2.123</ip_address> </ippool_add_ip> </client> </packet>

Supported Operations

69

Response Packet Structure


The ippool_add_ip node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested ippool_add_ip operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the ippool_add_ip operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the ippool_add_ip operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the ippool_add_ip operation fails. Data type: string. The ip_address node is optional. It is required if the ippool_add_ip operation succeeds. Returns the IP address added to the IP pool of the specified client account(s). Data type: ip_address (common.xsd). The client_id node is optional. It is required if the ippool_add_ip operation succeeds. Returns the unique identifier of the client account whose IP pool is enlarged with the specified IP address. Data type: integer.

Response Samples
A positive response packet received from the server can look as follows:
<packet version=1.4.2.0> <client> <ippool_add_ip> <result> <status>ok</status> <client_id>1234</client_id> <ip_address>192.0.2.122</ip_address> <ip_address>192.0.2.123</ip_address> </result> </ippool_add_ip> </client> </packet>

Supported Operations

70

If the ippool_add_ip operations fails, the negative response can look as follows:
<packet version=1.4.2.0> <client> <ippool_add_ip> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </ippool_add_ip> </client> </packet>

Removing IP Addresses from the Clients IP Pool


The ippool_del_ip operation is used to remove IP addresses from the IP pool of the specified client account.

Request Packet Structure


A request XML packet removing IP addresses from the IP pool of the specified Plesk Client includes the ippool_del_ip operation node:
<packet version=1.4.2.0> <client> <ippool_del_ip> </ippool_del_ip> </client> </packet>

The ippool_del_ip node is specified by type ipPoolOperateType (plesk_client.xsd). The ippool_add_ip node has the following graphics representation:

The client_id node is required. It specifies Plesk Client from whose IP pool the specified IP addresses are taken away. Data type: integer. The ip_address node is required. It specifies the IP address that will be removed from the IP pool of the specified Plesk Clients. Data type: string.

Supported Operations

71

Request Samples
To remove the specified IP addresses from the clients IP pool, specify the packet as follows:
<packet version=1.4.2.0> <client> <ippool_del_ip> <client_id>1234</client_id> <ip_address>192.0.2.122</ip_address> <ip_address>192.0.2.123</ip_address> </ippool_del_ip> </client> </packet>

Response Packet Structure


The ippool_del_ip node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested ippool_del_ip operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the ippool_del_ip operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the ippool_del_ip operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the ippool_del_ip operation fails. Data type: string. The ip_address node is optional. It is required if the ippool_del_ip operation succeeds. Returns the IP address removed from the IP pool of the specified client accounts. Data type: string. The client_id node is optional. It is required if the ippool_del_ip operation succeeds. Returns the unique identifier of the client account from whose IP pool the specified IP address (or several) is removed. Data type: integer. (integer).

Supported Operations

72

Response Samples
A positive response packet received from the server can look as follows:
<packet version=1.4.2.0> <client> <ippool_del_ip> <result> <status>ok</status> <client_id>1234</client_id> <ip_address>192.0.2.122</ip_address> <ip_address>192.0.2.123</ip_address> </result> </ippool_del_ip> </client> </packet>

If the ippool_del_ip operations failed, the response can look as follows:


<packet version=1.4.2.0> <client> <ippool_del_ip> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </ippool_del_ip> </client> </packet>

Supported Operations

73

Listing Buttons Displayed on the Clients Page in Control Panel


The cform_buttons_list operation is used to retrieve the list of buttons displayed on a personal Plesk Client page in Plesk Control panel.

Request Packet Structure


A request XML packet getting the list of buttons of the specified client account from Plesk database includes the cform_buttons_list operation node:
<packet version=1.4.2.0> <client> <cform_buttons_list> </cform_buttons_list> </client> </packet>

The cform_buttons_list operation node does not have a separate type, it is nested within the ClientTypeRequest complex type (client_input.xsd). The cform_buttons_list node has the following graphics representation:

The filter node is required. It is used to define Plesk Client whose buttons will be got. This can be done either by id, or by login. Data type: clientSelectionFilterType (client_input.xsd) The id node is optional. It specifies the identifier of a Plesk Client whose buttons will be got. Data type: integer. The login node is optional. it specifies the login name of a Plesk Client whose buttons will be got. Data type: string.

Request Samples
A single request packet can retrieve the list the buttons for a single Plesk Client or multiple Plesk Clients. If multiple Plesk Clients are requested, they can be filtered either by id or by login:
<packet version=1.4.2.0> <client> <cform_buttons_list> <filter> <id>1324</id> <id>1325</id> </filter>

Supported Operations </cform_buttons_list> </client> </packet>

74

Or:
<packet version=1.4.2.0> <client> <cform_buttons_list> <filter> <login>technolux</login> <login>advent</login> </filter> </cform_buttons_list> </client> </packet>

The following packet is invalid as it uses both id and login in the same filter:
<packet version=1.4.2.0> <client> <cform_buttons_list> <filter> <id>1324</id> <login>advent</login> </filter> </cform_buttons_list> </client> </packet>

To fix this packet, use multiple cform_buttons_list sections:


<packet version=1.4.2.0> <client> <cform_buttons_list> <filter> <id>1324</id> </filter> </cform_buttons_list> <cform_buttons_list> <filter> <login>advent</login> </filter> </cform_buttons_list> </client> </packet>

Supported Operations

75

Response Packet Structure


A response cform_buttons_list packet structure is specified in the client_output.xsd schema as follows:

The result node is required. It wraps the result of the requested cform_buttons_list operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the cform_buttons_list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the cform_buttons_list operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the cform_buttons_list operation fails. Data type: string. The filter-id node is optional. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. Data type: anySimple. The id node is optional. It is required if the cform_buttons_list operation succeeds. Returns the unique identifier of the client account whose list of buttons is returned. Data type: integer. The button node is optional. It is present if the cform_buttons_list operation succeeds. Returns a single button displayed on the client's page in Plesk Control Panel (PCP). Data type: buttonDataType (plesk_common.xsd). See the structure of this node below.

Supported Operations

76

The button node is structured as follows:

The code node is required. It specifies the button's identifier. Data type: string.

Supported Operations

77

The type node is required. It specifies the button's type (a link or a standard button). Data type: string. Allowed values: link_button | comm_button. The name node is required. It specifies the localized caption displayed on the button in PCP. Data type: string. The name_id node is required. It specifies the localization key of the button's name. Data type: string. The group_name node is required. It specifies the localized name of the section in which the button is located in PCP. Data type: string. The group_name_id node is required. It specifies the localization key of the section name. Data type: string. The href node is required. It specifies the URL referenced by the button. Data type: string. The js_onclick node is optional. It specifies a piece of the JavaScript code executed at the button click. Data type: text. The enabled node is required. It specifies whether the button is enabled/disabled. Data type: Boolean. The new_window node is optional. It indicates whether a new window will be opened at a button click. Data type: Boolean. The tabindex node is optional. It specifies the tabulation index of the button. Data type: integer. Default value: 0. The conhelp_id node is optional. It specifies the localization key of the context help message associated with the button. Data type: string. The conhelp node is optional. It specifies a context help message displayed for the button. Data type: text. The icon_url node is optional. It specifies the URL of the buttons icon. Data type: string.

Response Samples
A positive response received from the server returns the clients identifier and one to many button elements, each describing a single button:
<packet version=1.5.0.0> <client> <cform_buttons_list> <result> <status>ok</status> <filter-id>1324</filter-id> <id>1324</id> <button> <code>EDIT_BUTTON</code> <type>link_button</type> <name>Edit</name> <name_id>edit</name_id> <group_name>Tools</group_name> <group_name_id>__tools</group_name_id> <href>/clients/cl_ed.php3</href> <enabled>true</enabled> <new_window>false</new_window> </button> </result> </cform_buttons_list> </client>

Supported Operations </packet>

78

If the operation fails, the negative response packet can look as follows:
<packet version=1.5.0.0> <client> <cform_buttons_list> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <filter-id>1324</filter-id> </result> </cform_buttons_list> </client> </packet>

Retrieving Descriptor of Limits


Use the get-limit-descriptor operation to retrieve descriptor of client's limits. For details on descriptors, refer to the Representation of Object Descriptor (on page 16) section. For details on client's limits, refer to the Limits (on page 41) section.

Request Packet Structure


A request XML packet retrieving client limits descriptors includes the get-limit-descriptor operation node:
<packet version=1.5.0.0> <client> <get-limit-descriptor> </get-limit-descriptor> </client> </packet>

You can retrieve descriptor for the specified client, or the server-level client limits descriptor. The get-limit-descriptor node has the following graphical representation:

Supported Operations

79

The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors (on page 16) section. Data type: clientSelectionFilterType (client_input.xsd). The id node is optional. It specifies the client ID. Data type: integer. The login is optional. It specifies the client name. Data type: string.

Note: you can specify multiple id or name parameters in one filter node.

Request Samples
The request packet retrieving limits descriptor for the client with ID 5 looks as follows:
<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <filter> <id>5</id> </filter> </get-limit-descriptor> </client> </packet>

The request packet retrieving limits descriptor for the clients with ID 5 and ID 7 looks as follows:
<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <filter> <id>5</id> <id>7</id> </filter> </get-limit-descriptor> </client> </packet>

The request packet retrieving the server-level descriptor of client limits looks as follows:
<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <filter/> </get-limit-descriptor> </client> </packet>

Supported Operations

80

Response Packet Structure


The get-limit-descriptor node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd). The status node is required. It specifies the execution status of the get-limit-descriptor operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get-limitdescriptor operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the get-limitdescriptor operation fails. Data type: string. The filter-id node is optional. It is required if the get-limit-descriptor operation succeeds. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. For info on filters, refer to the Filters of Descriptors (on page 23) section. Data type: anySimple. The id node is optional. It is required if the get-limit-descriptor operation succeeds. Returns the unique identifier of the client account. Data type: integer. The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor (on page 16). Data type: string.

Note: This descriptor contains limits extensions. For details, refer to the Extension of Limits Descriptor (see page 20) section.

Supported Operations

81

Response Samples
If a limit name was not found on the server, the response can look as follows:
<packet version ="1.5.0.0"> <client> <set> <result> <status>error</status> <errcode>1002</errcode> <errtext>Unknown limit name: my_limit</errtext> </result> </set> </client> </packet>

A possible response from the server can look as follows:


<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <result> <status>ok</status> <filter-id>5</filter-id> <id>5</id> <descriptor> <property> <name>max_dom</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_dom</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_subdom</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_subdom</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_dom_aliases</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_dom_aliases</label> <extension> <shared>false</shared> </extension> </property> <property> <name>disk_space</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__disk_space</label> <extension> <shared>false</shared>

Supported Operations </extension> </property> <property> <name>max_traffic</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__max_traffic</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_wu</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_wu</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_db</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_db</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_box</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_box</label> <extension> <shared>false</shared> </extension> </property> <property> <name>mbox_quota</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__mbox_quota</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_redir</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_redir</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_mg</name> <type>int</type> <writable-by>admin</writable-by>

82

Supported Operations <label>limit__max_mg</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_resp</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_resp</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_maillists</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_maillists</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_webapps</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_webapps</label> <extension> <shared>false</shared> </extension> </property> <property> <name>expiration</name> <type>date</type> <writable-by>admin</writable-by> <label>limit__expiration</label> <extension> <shared>true</shared> </extension> </property> </descriptor> </result> </get-limit-descriptor> </client> </packet>

83

Supported Operations

84

Retrieving Descriptor of Permissions


Use the get-permission-descriptor operation to retrieve descriptor of client's permissions. For details on descriptors, refer to the Representation of Object Descriptor (on page 16) section. For details on client's permissions, refer to the Permissions (on page 41) section.

Request Packet Structure


A request XML packet retrieving client permissions preferences includes the getpermission-descriptor operation node:
<packet version=1.5.0.0> <client> <get-permission-descriptor> </get-permission-descriptor> </client> </packet>

You can retrieve permissions descriptor for the specified client, or the server-level client permissions descriptor. The get-permission-descriptor node has the following graphical representation:

The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors (on page 16) section. Data type: clientSelectionFilterType (client_input.xsd). The id node is optional. It specifies the client ID. Data type: integer. The login is optional. It specifies the client name. Data type: string.

Note: you can specify multiple id or name parameters in one filter node.

Supported Operations

85

Request Samples

The request packet retrieving permissions descriptor for the client with ID 5 looks as follows:
<packet version ="1.5.0.0"> <client> <get-permission-descriptor> <filter> <id>5</id> </filter> </get-permission-descriptor> </client> </packet>

The request packet retrieving permissions descriptor for MyClient and MyClient2 clients looks as follows:
<packet version ="1.5.0.0"> <client> <get-permission-descriptor> <filter> <login>MyClient</login> <login>MyClient2</login> </filter> </get-permission-descriptor> </client> </packet>

The request packet retrieving the server-level descriptor of client permissions looks as follows:
<packet version ="1.5.0.0"> <client> <get-permission-descriptor> <filter/> </get-permission-descriptor> </client> </packet>

Supported Operations

86

Response Packet Structure


The get-permission-descriptor node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd). The status node is required. It specifies the execution status of the get-permissiondescriptor operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the getpermission-descriptor operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the getpermission-descriptor operation fails. Data type: string. The filter-id node is optional. It is required if the get-permission-descriptor operation succeeds. Returns the name or ID of a client depending on a way of client specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. For info on filters, refer to the Filters of Descriptors (on page 23) section. Data type: anySimple. The id node is optional. It is required if the get-permission-descriptor operation succeeds. Returns the unique identifier of the client account. Data type: integer. The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor (on page 16). Data type: string.

Note: This descriptor contains permissions extensions. For details, refer to the Extension of Permissions Descriptor (on page 18) section.

Supported Operations

87

Response Samples
A positive response from the server can look as follows:
<packet version="1.5.0.0"> <client> <get-permission-descriptor> <result> <status>ok</status> <descriptor> <property> <name>cp_access</name> <type>boolean</type> <default-value>true</default-value> <writable-by>admin</writable-by> <label>cl_perm__cp_access</label> <extension> <level>client</level> <level>mail</level> </extension> </property> <property> <name>create_domains</name> <type>boolean</type> <default-value>false</default-value> <writable-by>admin</writable-by> <label>cl_perm__create_domains</label> <extension> <level>client</level> </extension> </property> ... </descriptor> </result> </get-permission-descriptor> </client> </packet>

Supported Operations

88

Managing Client Templates


Operator: <client-template> XML Schema: client_template.xsd Plesk version: Plesk 8.0 for UNIX | Plesk 7.6 for Windows and higher API RPC version: 1.4.1.0 and higher Plesk user: Plesk Administrator Description Client templates are a kind of presets which are useful when it is necessary to create multiple client accounts with identical permissions, limits, IP pool settings, and preferences. All operations on client templates are allowed for Plesk Administrator only. Client templates are used to specify a collection of settings and apply them to Plesk Clients. These settings are as follows: permissions limits on use of Plesk resources IP pool settings preferences

Refer to the Client Template Settings (see page 89) section for details. Supported operations

ADD (see page 96) creates a client template GET (see page 99) retrieves the information on the specified Plesk Clients from the server DEL (see page 104) deletes the specified client templates (see page 107) SET (see page 107) sets new preferences, limits, and IP pool settings for the specified client template

Supported Operations

89

Client Template Settings


This section describes a collection of Plesk Client settings that can be defined in a client template. These settings can be set when creating a Plesk Client or later. These settings are as follows: Permissions and limits on use of Plesk resources (on page 35) IP pool settings (see page 93) Preferences (see page 94)

Permissions
For details on client permissions, refer to the Limits and Permissions (on page 35) section. Samples The "Limits" XML schema is the same for client and client template. In API RPC 1.5.0.0 and later versions, a packet that requests for creating a new client template and with a collection of permissions can look as follows:
<packet version=1.5.0.0> <client-template> <add> <name>base_template</name> <permissions> <permission> <name>create_domains</name> <value>true</value> </permission> <permission> <name>manage_phosting</name> <value>true</value> </permission> <permission> <name>manage_quota</name> <value>true</value> </permission> <permission> <name>manage_domain_aliases</name> <value>true</value> </permission> <permission> <name>manage_subdomains</name> <value>true</value> </permission> <permission> <name>manage_dns</name> <value>true</value>

Supported Operations </permission> <permission> <name>manage_log</name> <value>true</value> </permission> <permission> <name>manage_anonftp</name> <value>true</value> </permission> <permission> <name>manage_subftp</name> <value>true</value> </permission> <permission> <name>manage_webapps</name> <value>true</value> </permission> <permission> <name>remote_access_interface</name> <value>true</value> </permission> <permission> <name>cp_access</name> <value>true</value> </permission> <permission> <name>stdgui</name> <value>true</value> </permission> <permission> <name>dashboard</name> <value>true</value> </permission> <permission> <name>manage_dashboard</name> <value>true</value> </permission> <permission> <name>allow_local_backups</name> <value>true</value> </permission> </permissions> </add> </client-template> </packet>

90

Supported Operations

91

In API RPC 1.4.2.0 and earlier versions, a packet that requests for creating a new client template and with a collection of permissions can look as follows:
<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <permissions> <create_domains>true</create_domains> <manage_phosting>true/manage_phosting> <manage_quota>true</manage_quota> <manage_domain_aliases>true</manage_domain_aliases> <manage_subdomains>true</manage_subdomains> <manage_dns>true</manage_dns> <manage_log>true</manage_log> <manage_anonftp>true</manage_anonftp> <manage_subftp>true</manage_subftp> <manage_webapps>true</manage_webapps> <remote_access_interface>true</remote_access_interface> <cp_access>true</cp_access> <stdgui>true</stdgui> <dashboard>true</dashboard> <manage_dashboard>true</manage_dashboard> <allow_local_backups>true</allow_local_backups> </permissions> </add> </client-template> </packet>

Limits
For details on client limits, refer to the Limits and Permissions (on page 35) section. Samples The "Limits" XML schema is the same for client and client template. In API RPC 1.5.0.0 and later versions, a packet that requests for creating a new client template and with a collection of limits can look as follows:
<packet version=1.5.0.0> <client-template> <add> <name>base_template</name> <limits> <limit> <name>disk_space</name> <value>209715200</value> </limit> <limit> <name>mysql_dbase_space</name> <value>52428800</value> </limit> <limit> <name>max_db</name> <value>50</value> </limit>

Supported Operations <limit> <name>max_traffic</name> <value>52428800</value> </limit> <limit> <name>max_dom</name> <value>100</value> </limit> <limit> <name>max_dom_aliases</name> <value>5</value> </limit> <limit> <name>max_subdom</name> <value>400</value> </limit> <limit> <name>total_mboxes_ quota</name> <value>1000</value> </limit> <limit> <name>expiration</name> <value>63072000</value> </limit> </limits> </add> </client-template> </packet>

92

In API RPC 1.4.2.0 and earlier versions, a packet that requests for creating a new client template and with a collection of limits can look as follows:
<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <limits> <disk_space>209715200</disk_space> <mysql_dbase_space>52428800</mysql_dbase_space> <max_db>50</max_db> <max_traffic>52428800</max_traffic> <max_dom>100</max_dom> <max_dom_aliases>5</max_dom_aliases> <max_subdom>400</max_subdom> <total_mboxes_ quota>1000</total_mboxes_quota> <expiration>63072000</expiration> </limits> </add> </client-template> </packet>

Supported Operations

93

IP Pool Settings
A client template can specify IP pool settings for a Plesk Client that will be created using this template. The client IP pool can contain a set of shared and exclusive IP addresses. Shared IP addresses are selected from the IP pool of Plesk server. Exclusive IP addresses are created for a Plesk Client. IP pool settings are added to the client account using the ip-pool node of the add or set request packets. Also, this node can be returned in the get response packets (if requested). The ip-pool node is specified by complex type ClienttemplatePoolType (client_template.xsd). It is structured as follows:

The ip-address node is optional. It specifies the IP address available in Plesk IP pool that will be shared by the Client created using this client template. Data type: ip_address (common.xsd). The allocate-ip node is optional. It specifies the number of exclusive IP addresses that will be allotted for a Client created using this client template. Data type: integer.

The following request packet creates a new client template and sets IP pool settings for it:
<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <ip-pool> <ip-address>123.123.123.121</ip-address> <ip-address>123.123.123.122</ip-address> <allocate-ip>2</allocate-ip> </ip-pool> </add> </client-template> </packet>

Supported Operations

94

Preferences
Preferences are set for a Plesk Client in the preferences node of the add or set request packet. Also, this node is returned from Plesk server in the get response packet. The preferences node is specified by complex type ClientTemplatePreferencesType (plesk_client.xsd). It is structured as follows:

The sbnet-user node is optional. It indicates whether a Plesk Client created using this client template can have a SiteBuilder user account. This node makes sense in Plesk for Windows only.

Note: the preferences node is supported by API RPC 1.4.2.0 and later.

The following request packet creates a new client template and sets preferences for it:

<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <preferences> <sbnet-user>true</sbnet_user> </preferences> </add> </client-template> </packet>

Supported Operations

95

Filtering Client Templates


Filtering is the way the request packets pick out client templates to which the requested operation will be applied. The filter node is presented by the ClientTemplateFilterType complex type (client_template.xsd). This data type is structured as follows:

The id node is required. It specifies the unique identifier of the client template. Data type: integer. The name node is required. It specifies the unique name of the client template. Data type: string.

A client template can be filtered either by id, or by name. The same is true if several client templates are filtered by the same filter node. The following sample packet is invalid as it uses both id and name within the same filter:
<packet version=1.4.2.0> <client-template> <get> <filter> <name>base_template</name> <name>quick_template</name> <id>11</id> <id>12</id> </filter> <limits/> </get> </client-template> </packet>

To fix this packet, use two different <get> sections instead:


<packet version=1.4.2.0> <client-template> <get> <filter> <name>base_template</name> <name>quick_template</name> </filter> <limits/> </get> <get> <filter> <id>11</id>

Supported Operations <id>12</id> </filter> <limits/> </get> </client-template> </packet>

96

The filter node can be left empty. In this case all client templates available in Plesk will be filtered:
<packet version=1.4.2.0> <client-template> <get> <filter/> </get> </client-template> </packet>

Creating Client Template


Client templates can be created by Plesk Administrator for own needs only. To create a client template, Plesk Administrator should send an add request packet and specify the template name. Using client templates makes sense if they specify Plesk Client settings. These settings are as follows: Plesk Client permissions limits on use of Plesk resources imposed for a Plesk Client IP pool settings preferences

Request Packet Structure


A request XML packet adding a new client template to Plesk database includes the add operation node:
<packet version=1.4.2.0> <client-template> <add> </add> </client-template> </packet>

Supported Operations

97

The add node is presented by type ClienttemplateAddInputType (client_template.xsd). Its graphical representation is as follows:

The name node is required. It specifies the name of the client template. Data type: string. The limits node is optional. It specifies a collection of limits that will be set for new clients created using this template. Data type: clientLimits (plesk_client.xsd). See the structure of this node in the Limits (on page 35) topic. The permissions node is optional. It specifies a collection of permissions for new clients created using this client template. Data type: clientPerms (plesk_client.xsd). To see the structure of this node, proceed to the Permissions (on page 35) topic. The ip-pool node is optional. It specifies IP pool settings for new clients created using this client template. Data type: clienttemplateIpPoolType (client_template.xsd). To see the structure of this node, proceed to topic IP Pool Settings (see page 93). The preferences node is optional. It specifies a collection of preferences for new clients created using this client template. Data type: ClientTemplatePreferencesType (client_template.xsd). To see the structure of this node, proceed to topic Preferences (see page 94).

Request Samples
The following packet creates a client template with a minimal collection of settings.
<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <ip-pool> <allocate-ip>2</allocate-ip> </ip-pool> </add> </client-template> </packet>

To see sample packets creating client templates with other settings, refer to the Client Template Settings (see page 89)section.

Supported Operations

98

Creating multiple client templates To create two client templates with a single packet, include two different add operations:
<packet version=1.4.2.0> <client-template> <add> <name>base_template</name> <ip-pool> <allocate-ip>2</allocate-ip> </ip-pool> </add> <add> <name>quick_template</name> <ip-pool> <ip-address>192.0.2.121</ip-address> <ip-address>192.0.2.122</ip-address> </ip-pool> </add> </client-template> </packet>

Response Packet Structure


The add node of the output XML packet is structured as follows:

The result node is required. It wraps the response received from the server. Data type: ClientTemplateOutputResulttype (client_template.xsd). The status node is required. Specifies the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return an error code if the add operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return an error message if the add operation fails. Data type: string.

Supported Operations

99

The id node is optional. It is required is the add operation has succeeded. Returns the unique identifier if the client template just added to Plesk. Data type: integer. The name node is optional. It is required if the add operation succeeds. Returns the unique name of the client template just added to Plesk. Data type: string.

Response Samples
A positive response received from the server after adding a new client template can look as follows:
<packet version=1.4.2.0> <client-template> <add> <result> <status>ok</status> <id>24</id> <name>base_template</name> </result> </add> </client-template> </packet>

A negative response can look as follows:


<packet version=1.4.2.0> <client-template> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </client-template> </packet>

Getting Information About Client Templates


The get operation is used to retrieve the information about the client templates from Plesk database. This information is as follows: the unique identifier and the name of the client template Plesk Client permissions limits on use of Plesk resources IP pool settings preferences

Supported Operations

100

The get operation can return all or particular settings currently present in Plesk database. All settings are optional and can be missing in the client template. A client template can even be empty (specified by its id and name and not containing any other information). The get operation will return only the settings currently stored in the database. Filtering client templates is a very important issue. A client template can be uniquely identified by one of two parameters by its id or by the template name. Refer to the Filtering Client Templates (see page 95)section for details.

Request Packet Structure


A request XML packet getting information about the specified client templates from Plesk database includes the get operation node:
<packet version=1.4.2.0> <client-template> <get> </get> </client-template> </packet>

The get node is presented by type ClientTemplateGetInputType (client_template.xsd). Its graphical representation is as follows:

The filter node is required. It serves to pick out client templates whose settings will be selected from Plesk database. Data type: ClientTemplateFilterType (client_template.xsd). See the structure of this node in topic Filtering Client Templates. The limits node is optional. It is used to request for Plesk Client limits set in the filtered client templates. Data type: none. The permissions node is optional. It is used to request for Plesk Client permissions set in the filtered client templates. Data type: none. The ip-pool node is optional. It is used to request for Plesk Client IP pool settings defined in the filtered client templates. Data type: none. The preferences node is optional. It is used to request for Plesk Client preferences defined in the filtered client templates. Data type: none.

Supported Operations

101

Request Samples
To filter client templates whose settings will be retrieved from Plesk database, a get request packet should contain the filter node. Filtering can be done either by the template id, or by the template name. The following packet requests all available information about two client templates with names base_template and quick_template.
<packet version=1.4.2.0> <client-template> <get> <filter> <name>base_template</name> <name>quick_template</name> </filter> <limits/> <permissions/> <ip-pool/> <preferences/> </get> </client-template> </packet>

To filter some client templates by id and others by name within the same packet, use two get operations:
<packet version=1.4.2.0> <client-template> <get> <filter> <name>base_template</name> <name>quick_template</name> </filter> <limits/> </get> <get> <filter> <id>12</id> </filter> <limits/> </get> </client-template> </packet>

To filter all client templates available in Plesk, use the following packet:
<packet version=1.4.2.0> <client-template> <get> <filter/> </get> </client-template> </packet>

Supported Operations

102

This packet does not specify any particular settings, so the response packet will only return the list of identifiers and template names.

Response Packet Structure


The get node of the output XML packet is presented by type ClientTemplateOutputGetType (client_template.xsd). Its graphical representation is as follows:

The result node is required. It wraps the information on a single client template. Data type: ClientTemplateOutputResulttype (client_template.xsd). The status node is required. Specifies the execution status of the get operation. Data type: result_status (common.xsd). Allowed values: ok | error. The errcode node is optional. It is used if the get operation fails. Returns an error code. Data type: unsignedInt. The errtext node is optional. It is used if the get operation fails. Returns an error message. Data type: string. The id node is optional. It is missing if the request packet fails before the validation starts. This node specifies the client template identifier that owns the returned information. Data type: integer. The name node is optional. It is missing if the request packet fails before the validation starts. It specifies the name of the client template that owns the returned information. Data type: string. The limits node is optional. It is present if the request get packet specifies the limits node and the operation succeeds. Data type: clientLimits (plesk_client.xsd). See the structure of this node in the Limits (on page 35) section.

Supported Operations

103

The permissions node is optional. It is present if the request get packet specifies the permissions node and the operation succeeds. Data type: clientPerms (plesk_client.xsd). See the structure of this node in the Permissions (on page 35) section. The ip-pool node is optional. It is present if the request get packet specifies the ippool node and the operation succeeds. Data type: ClienttemplateIpPoolType (client_template.xsd). See the structure of this node in the IP Pool Settings (see page 93) section. The preferences node is optional. It is present if the request get packet specifies the preferences node and the operation succeeds. Data type: ClientTemplatePreferencesType (client_template.xsd). See the structure of this node in the Preferences (see page 94) section.

Response Samples
The following packet demonstrates a positive response received from Plesk server.
<packet version=1.4.2.0> <client-template> <get> <result> <status>ok</status> <id>24</id> <name>base_template</name> <ip-pool> <allocate-ip>2</allocate-ip> </ip-pool> </result> <result> <status>ok</status> <id>12</id> <name>quick_template</name> <ip-pool> <ip-address>192.0.2.122</ip-address> <ip-address>192.0.2.123</ip-address> </ip-pool> </result> </get> </client-template> </packet>

A negative response received from Plesk server can look as follows:


<packet version=1.4.2.0> <client-template> <get> <result> <status>error</status> <errcode>1027</errcode> <errtext>IP operation failed.</errtext> <id>24</id> <name>base_template</name> </result> <result>

Supported Operations <status>error</status> <errcode>1027</errcode> <errtext>IP operation failed.</errtext> <id>12</id> <name>quick_template</name> </result> </get> </client-template> </packet>

104

Deleting Client Templates


Client templates can be deleted by Plesk Administrator. A single del request packet can delete multiple client templates. The client templates to be deleted are specified in the filter node either by the client template identifier, or by the client template name (both parameters uniquely identify a template).

Request Packet Structure


A request XML packet that deletes the client templates from Plesk database includes the del operation node:
<packet version=1.4.2.0> <client-template> <del> </del> </client-template> </packet>

The del node is presented by type ClientTemplateDelInputType (client_template.xsd):

The filter node is required. It specifies the client templates to be deleted from Plesk database. Data type: ClientTemplateFilterType (client_template.xsd). See the structure of this node in topic Filtering Client Templates (see page 95).

Supported Operations

105

Request Samples

To select client templates for deletion, filter them either by id, or by name. The following packet is invalid as it uses both these nodes within one filter node:

<packet version=1.4.2.0> <client-template> <del> <filter> <name>base_template</name> <id>12</id> </filter> </del> </client-template> </packet>

To fix this packet, use different filter nodes (and different del operations):

<packet version=1.4.2.0> <client-template> <del> <filter> <name>base_template</name> </filter> </del> <del> <filter> <id>12</id> </filter> </del> </client-template> </packet>

The following packet deletes all client templates available in Plesk database:

<packet version=1.4.2.0> <client-template> <del> <filter/> </del> </client-template> </packet>

Supported Operations

106

Response Packet Structure


The del node of the output XML packet is structured as follows:

The result node is required. It wraps the result of the del operation for a single client template. Data type: ClientTemplateOutputResulttype (client_template.xsd). The status node is required. Specifies the execution status of the del operation. Data type: result_status (common.xsd). Allowed values: ok | error. The errcode node is optional. Returns an error code if the del operation fails. Data type: unsignedInt. The errtext node is optional. Can return an error message if the del operation fails. Data type: string. The id node is optional. It is missing if the packet fails before the validation starts, or if filtering was done by name. Returns the identifier of the deleted client template. Data type: integer. The name node is optional. It is missing if the packet fails before the validation starts, or if filtering was done by id. Returns the name of the deleted client template. Data type: string.

Response Samples
The following packet returns a positive response after the del operation is performed:
<packet version=1.4.2.0> <client-template> <del> <result> <status>ok</status> <name>base_template</name> </result> <result> <status>ok</status> <id>12</id>

Supported Operations </result> </del> </client-template> </packet>

107

The first template was filtered by name (name = base_template), the second one was filtered by id (id = 12). A negative response received from Plesk server can look as follows:
<packet version=1.4.2.0> <client-template> <del> <result> <status>ok</status> <name>base_template</name> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>12</id> </result> </del> </client-template> </packet>

The deletion of the first client template (filtered by name = base_template) was successful, while the deletion of the second template (filtered by id = 12) failed.

Setting Client Template Settings


The set operation is used to update client template with new settings. These settings are as follows: Permissions Limits on use of Plesk resources by this domain IP pool setting Preferences

You can update all settings of a domain template in bulk or specify particular settings. Filtering client templates can be performed either by its id, or by its name (both uniquely identify the client template). Refer to the section Filtering Client Templates (see page 95)for details.

Request Packet Structure


A request XML packet setting client template settings to Plesk database includes the set operation node:
<packet version=1.4.2.0> <client-template> <set> </set> </client-template>

Supported Operations </packet>

108

The set node is presented by type ClientTemplateSetInputType (client_template.xsd). Its graphical representation is as follows:

The filter node is required. It serves to pick out client templates whose settings will be updated. Data type: ClientTemplateFilterType (client_template.xsd). See the structure of this node in topic Filtering Client Templates (see page 95). The limits node is optional. It sets a collection of limits that will be updated for the specified client templates. Data type: clientLimits complex type (plesk_client.xsd). See the structure of this node in the Limits (on page 35) topic. The permissions node is optional. It sets a collection of Plesk Client permissions to the specified client templates. Data type: clientPermissions (plesk_client.xsd). See the structure of this node in the Permissions (on page 35) topic. The ip-pool node is optional. It sets IP pool settings to the specified client templates. Data type: ClienttemplateIpPoolType (client_template.xsd). See the structure of this node in the IP Pool settings (see page 93) topic. The preferences node is optional. It sets Plesk Client preferences to the specified client templates. Data type: ClientTemplatePreferencesType (client_template.xsd). See the structure of this node in topic Preferences (see page 94).

Request Samples
The following set request packet updates IP pool settings for two client templates, one specified by id and another by name. Since the same filter node cannot use both id and name nodes, we use two different filter nodes (and two set operations):
<packet version=1.4.2.0> <client-template> <set> <filter> <id>12</id> </filter> <ip-pool> <ip-address>192.0.2.121</ip-address> <ip-address>192.0.2.122</ip-address> <allocate-ip>2</allocate-ip> </ip-pool> </set>

Supported Operations <set> <filter> <name>base_template</name> </filter> <ip-pool> <ip-address>192.0.2.121</ip-address> <ip-address>192.0.2.122</ip-address> <allocate-ip>2</allocate-ip> </ip-pool> </set> </client-template> </packet>

109

The following packet updates all client templates available in Plesk with similar IP pool settings:
<packet version=1.4.2.0> <client-template> <set> <filter/> <ip-pool> <ip-address>192.0.2.121</ip-address> <ip-address>192.0.2.122</ip-address> </ip-pool> </set> </client-template> </packet>

The following packet will be considered invalid as it does not specify any settings:
<packet version=1.4.2.0> <client-template> <set> <filter> <id>12</id> </filter> </set> </client-template> </packet>

To see sample packets setting up various client settings, refer to the Client Template Settings (see page 89)section.

Supported Operations

110

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It wraps the result of the set operation for a single client template. Data type: ClientTemplateOutputResulttype (client_template.xsd). The status node is required. Specifies the execution status of the set operation. Data type: result_status (common.xsd). Allowed values: ok | error. The errcode node is optional. It is present if the set operation fails. Returns an error code. Data type: unsignedInt. The errtext node is optional. It is present if the set operation fails. Returns an error message. Data type: string. The id node is optional. It is missing if the packet fails before the validation starts, or if filtering was done by name. Returns the identifier of the updated client template. Data type: integer. The name node is optional. It is missing if the packet fails before the validation starts, or if filtering was done by id. Returns the name of the updated client template. Data type: string.

Supported Operations

111

Response Samples

A positive set response packet can look as follows:


<packet version=1.4.2.0> <client-template> <set> <result> <status>ok</status> <name>base_template</name> </result> <result> <status>ok</status> <id>12</id> </result> </set> </client-template> </packet>

The first template was filtered by name base_template, the second one was filtered by id 12.

A negative set response packet looks as follows:


<packet version=1.4.2.0> <client-template> <set> <result> <status>ok</status> <name>base_template</name> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>12</id> </result> </set> </client-template> </packet>

The update of the first client template was successful, while the update of the second template failed.

Supported Operations

112

Managing Database Servers


Operator: <db_server> XML Schema: database_input.xsd, database_output.xsd Plesk version: Plesk for MS Windows 7.0, Plesk 7.5.4 for Unix and later API RPC version: 1.3.5.1 and higher Plesk user: Plesk Administrator

Description Managing database servers differs in Plesk for Unix and Plesk for Windows, basing on what database types are supported and if remote database servers are supported. This difference is the following:

Database type

Database server

Plesk for MS Windows MSSQL, MySQL Plesk for Unix PostgreSQL, MySQL

local remote, local

A default database server manages all databases of the corresponding type. Only one default database server for each type of databases is available in Plesk.

Note: Use lower case for defining database servers types. In other case, the request might be incorrectly processed by Plesk server.

Supported Operations

113

Supported operations

ADD (on page 114) creates a database server entry of the specified type, specifying the login and password of the database administrator SET (on page 119) updates properties of the specified database server DEL (on page 123) removes a database server entry. Only remote database servers can be specified. The default database server cannot be removed SET-DEFAULT (on page 127) sets a remote database server entry as default for its DBMS type. Only remote database servers can be specified GET-DEFAULT (on page 131) retrieves ID of a default database server GET (on page 134) retrieves the database server info by the server ID GET-SUPPORTED-TYPES (on page 139) (getting the DBMS types supported on the server) GET-LOCAL (on page 142) retrieves ID of the local database server

Supported Operations

114

Adding Database Server


The add operation is used to add a database server of the specified type to Plesk. Before adding the database server, make sure the database server type is supported by Plesk. For more information, refer to the Managing Database Server (on page 112) topic. Note: This operation is not supported in Plesk for Windows.

Request Packet Structure


A request XML packet adding a database server includes the add operation node:
<packet version="1.4.2.0"> <db_server> <add-db> </add-db> </db_server> </packet>

The add node is presented by type DatabaseServerAddParam (plesk_db.xsd), and its graphical representation is as follows:

The host node is required. It specifies the IP address or name of the database server you want to add. Data type: string. The port node is required. It specifies the port of the database server. Data type: string. The type node is required. It specifies the database server type. MySQL and PostgreSQL types are available. Data type: string. Allowed values: mysql | postgresql. The admin node is required. It specifies the login name of administrator of the database server. Data type: integer. The password node is optional. It specifies the password of administrator of the database server. Data type: integer.

Supported Operations

115

The default node is optional. It specifies if the database server manages the databases of a certain type (defined by type). Data type: none.

Note: The add operation is presented by type DatabaseServerDescription in API RPC 1.3.5.1 Remarks You can add multiple database servers in a single packet. Add as many add operations as the number of database servers you want to add.
<db_server> <add> </add> ... <add> </add> </db_server>

Request Samples
Adding a single database server This packet adds the local MySQL database server.
<packet version="1.4.2.0"> <db_server> <add> <host>localhost</host> <port>3306</port> <type>mysql</type> <admin>senior</admin> <password>senior</password> </add> </db_server> </packet>

This packet adds the default PostgreSQL database server.


<packet version="1.4.2.0"> <db_server> <add> <host>71.5.44.29</host> <port>3306</port> <type>postgresql</type> <admin>senior</admin> <password>senior</password> <default/> </add> </db_server> </packet>

Supported Operations

116

Adding multiple database servers This request packet adds local MySQL and PostgreSQL database servers.
<packet version="1.4.2.0"> <db_server> <add> <host>localhost</host> <port>3306</port> <type>mysql</type> <admin>senior</admin> <password>senior</password> </add> <add> <host>localhost</host> <port>3307</port> <type>postgresql</type> <admin>senior</admin> <password>senior</password> </add> </db_server> </packet>

Response Packet Structure


The add node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add operation fails. Data type: string. The id node is optional. If the add operation succeeds, it returns the ID of the database server. Data type: integer.

Supported Operations

117

Response Samples
Adding a single database server This request packet adds the local MySQL database server.
<packet version="1.4.2.0"> <db_server> <add> <host>localhost</host> <port>3306</port> <type>mysql</type> <admin>senior</admin> <password>senior</password> </add> </db_server> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <db_server> <add> <result> <status>ok</status> <id>15</id> </result> </add> </db_server> </packet>

If the type of database server is not supported by Plesk, the response looks as follows:
<packet version="1.4.2.0"> <db_server> <add> <result> <status>error</status> <errcode>14008</errcode> <errtext>Wrong database server type</errtext> </result> </add> </db_server> </packet>

If the local MySQL database server already exists in Plesk, the response looks as follows:
<packet version="1.4.2.0"> <db_server> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed</errtext>

Supported Operations </result> </add> </db_server> </packet>

118

Adding multiple database servers This request packet adds local MySQL and PostgreSQL database servers.
<packet version="1.4.2.0"> <db_server> <add> <host>localhost</host> <port>3306</port> <type>mysql</type> <admin>senior</admin> <password>senior</password> </add> <add> <host>localhost</host> <port>3307</port> <type>postgresql</type> <admin>senior</admin> <password>senior</password> </add> </db_server> </packet>

If the MySQL server was successfully added, and PostgreSQL already exists in Plesk, a response from the server can look as follows:
<packet version="1.4.2.0"> <db_server> <add> <result> <status>ok</status> <id>15</id> </result> </add> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed</errtext> </result> </add> </db_server> </packet>

Supported Operations

119

Changing Database Server Preferences


Use the set operation to change preferences of the database server specified by ID. You can change preferences for multiple database servers in a single packet.

Request Packet Structure


A request XML packet changing a database server preferences includes the set operation node:
<packet version="1.4.2.0"> <db_server> <set> </set> </db_server> </packet>

The set node is presented by type DatabaseServerDescriptionOpt (plesk_db.xsd) and has the following graphical representation:

The host node is required. It specifies new IP address or name of the database server. Data type: string. The port node is required. It specifies new port of the database server. Data type: string. The admin node is required. It specifies the login name of administrator of the database server. Data type: integer. The password node is optional. It specifies the password of the administrator of the database server. Data type: integer. The id node is required. It specifies the database server ID. Data type: integer.

Remarks You can change preferences for multiple database servers in a single packet. Add as many set operations as the number of database servers which preferences are to be changed.
<db_server> <set>

Supported Operations </set> ... <set> </set> </db_server>

120

Request Samples
Changing preferences of a database server This packet changes IP address of the database server specified by ID 1.
<packet version="1.4.2.0"> <db_server> <set> <host>11.122.23.14</host> <port>3306</port> <admin>senior</admin> <password>senior</password> <id>1</id> </set> </db_server> </packet>

Changing preferences of multiple database servers This request packet changes ports of the MySQL and PostgreSQL database servers specified by ID 7 and ID 8.
<packet version="1.4.2.0"> <db_server> <set> <host>localhost</host> <port>336</port> <admin>senior</admin> <password>senior</password> <id>7</id> </set> <set> <host>localhost</host> <port>337</port> <admin>senior</admin> <password>senior</password> <id>8</id> </set> </db_server> </packet>

Supported Operations

121

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set operation fails. Data type: string. The id node is optional. If the set operation succeeds, it returns the ID of the database server. Data type: integer.

Response Samples
Changing preferences of a database server This packet changes IP address of the database server specified by ID 1.
<packet version="1.4.2.0"> <db_server> <set> <host>11.122.23.14</host> <port>3306</port> <admin>senior</admin> <password>senior</password> <id>1</id> </set> </db_server> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <db_server>

Supported Operations <set> <result> <status>ok</status> <id>1</id> </result> </set> </db_server> </packet>

122

If the database server with ID 1 was not found on the server, the positive response looks as follows:
<packet version="1.4.2.0"> <db_server> <set> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database server does not exist</errtext> </result> </set> </db_server> </packet>

Changing preferences of multiple database servers This request packet changes ports of the MySQL and PostgreSQL database servers specified by ID 7 and ID 8.
<packet version="1.4.2.0"> <db_server> <set> <host>localhost</host> <port>336</port> <admin>senior</admin> <password>senior</password> <id>7</id> </set> <set> <host>localhost</host> <port>337</port> <admin>senior</admin> <password>senior</password> <id>8</id> </set> </db_server> </packet>

If preferences of the database server with ID 7 were successfully changed, and the database server with ID 8 was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <db_server> <set> <result> <status>ok</status>

Supported Operations <id>7</id> </result> </set> <set> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database server does not exist</errtext> </result> </set> </db_server> </packet>

123

Detaching Database Servers


Use the del operation to detach database servers from Plesk. This option is available only for remote database servers. Default database servers cannot be removed using this operation. You can detach multiple database servers in a single packet. Note: This operation is not supported by Plesk for MS Windows.

Request Packet Structure


A request XML packet detaching a database server from Plesk includes the del operation node:
<packet version="1.4.2.0"> <db_server> <del> </del> </db_server> </packet>

The del node has the following graphical representation:

The filter node is required. Specifies the filtering rule. Data type: DatabaseServerFilterType (database_input.xsd). The id node is optional. It specifies ID of the database server to be detached. Data type: integer.

Supported Operations

124

Remarks You can detach multiple database servers from Plesk in a single packet. Add as many id parameters as the number of database servers which are to be detached.
<db_server> <del> <filter> <id>...</id> ... <id>...</id> </filter> </del> </db_server>

Request Samples
Unregistering a single database server This packet detaches the database server specified by ID 5 from Plesk.
<packet version="1.4.2.0"> <db_server> <del> <filter> <id>5</id> </filter> </del> </db_server> </packet>

Unregistering multiple database servers This packet detaches the database servers specified by ID 5 and ID 7 from Plesk.
<packet version="1.4.2.0"> <db_server> <del> <filter> <id>5</id> <id>7</id> </filter> </del> </db_server> </packet>

This packet detaches all remote database servers from Plesk.


<packet version="1.4.2.0"> <db_server> <del> <filter/> </del> </db_server> </packet>

Supported Operations

125

Response Packet Structure


The del node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the del operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the del operation fails. Data type: integer The errtext node is optional. It returns the error message if the del operation fails. Data type: string. The id node is optional. It returns the ID of the database server. Data type: integer.

Response Samples
Unregistering a single database server This packet detaches the database server specified by ID 5 from Plesk.
<packet version="1.4.2.0"> <db_server> <del> <filter> <id>5</id> </filter> </del> </db_server> </packet>

The positive response from the server is as follows:


<packet version="1.4.2.0"> <db_server> <del> <result> <status>ok</status> <id>5</id> </result>

Supported Operations </del> </db_server> </packet>

126

If the database server was a default database server, the response from the server looks as follows:
<packet version="1.4.2.0"> <db_server> <del> <result> <status>error</status> <errcode>1023</errcode> <errtext>The default database server cannot be deleted.</errtext> <id>5</id> </result> </del> </db_server> </packet>

If the database server with ID 5 was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <db_server> <del> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database server does not exist.</errtext> <id>5</id> </result> </del> </db_server> </packet>

Unregistering multiple database servers This packet detaches all remote database servers from Plesk.
<packet version="1.4.2.0"> <db_server> <del> <filter/> </del> </db_server> </packet>

Three database servers were detached from Plesk. A possible response from the server looks as follows:
<packet version="1.4.2.0"> <db_server> <del>

Supported Operations <result> <status>ok</status> <id>5</id> </result> <result> <status>ok</status> <id>6</id> </result> <result> <status>ok</status> <id>7</id> </result> </del> </db_server> </packet>

127

Setting Default Database Server


A default database server manages all databases of the corresponding type. Only one default database server for each type of databases is available in Plesk. Use the setdefault operation to set a database server as default. Note: this operation is available only in Plesk for Unix.

Request Packet Structure


A request XML packet setting a default database server includes the set-default operation node:
<packet version="1.4.2.0"> <db_server> <set-default> </set-default> </db_server> </packet>

The set-default node has the following graphical representation:

The id node is required. It specifies the remote database server ID. Data type: integer.

Supported Operations

128

The type node is required. If specified, the local database server will be set as default for managing the databases of the specified type. Data type: string. Allowed values: mysql | postgresql.

Note: You can set only one default database server for each type of databases. Remarks You can set multiple database servers as default in a single packet. Add as many setdefault operations as the number of database servers which status is to be changed.
<db_server> <set-default> </set-default> ... <set-default> </set-default> </db_server>

Request Samples
Changing status of a database server Upon supposition that the type of remote database server with ID 1 is mysql, the following packet sets the database server as default for managing MySQL databases.
<packet version="1.4.2.0"> <db_server> <set-default> <id>1</id> </set-default> </db_server> </packet>

The following packet sets the local database server as default for managing MySQL databases.
<packet version="1.4.2.0"> <db_server> <set-default> <type>1</type> </set-default> </db_server> </packet>

Changing status of multiple database servers This packet sets the remote database server with ID 1 and local PostgreSQL database server as default for managing MySQL and PostgreSQL databases correspondingly.
<packet version="1.4.2.0"> <db_server> <set-default> <id>1</id>

Supported Operations </set-default> <set-default> <type>postgresql</type> </set-default> </db_server> </packet>

129

Response Packet Structure


The set-default node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the set-default operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set-default operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set-default operation fails. Data type: string. The id node is optional. If the set-default operation succeeds and ID was specified in the request packet, it returns the ID of the database server. Data type: integer.

Response Samples
Changing status of a database server Upon supposition that the type of remote database server with ID 1 is mysql, the following request packet sets the database server as default for managing MySQL databases.
<packet version="1.4.2.0"> <db_server> <set-default> <id>1</id> </set-default> </db_server> </packet>

Supported Operations

130

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <db_server> <set-default> <result> <status>ok</status> <id>1</id> </result> </set-default> </db_server> </packet>

If the database server with ID 1 was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <db_server> <set-default> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database server does not exist.</errtext> </result> </set-default> </db_server> </packet>

Changing status of multiple database servers This request packet sets the remote database server with ID 1 and local PostgreSQL database server as default for managing MySQL and PostgreSQL databases correspondingly.
<packet version="1.4.2.0"> <db_server> <set-default> <id>1</id> </set-default> <set-default> <type>postgresql</type> </set-default> </db_server> </packet>

A response from the server can look as follows:


<packet version="1.4.2.0"> <db_server> <set-default> <result> <status>ok</status> <id>1</id> </result> </set-default> <set-default>

Supported Operations <result> <status>ok</status> </result> </set-default> </db_server> </packet>

131

Retrieving Default Database Server Info


A default database server manages all databases of the corresponding type. Only one default database server for each type of databases is available in Plesk. Use the getdefault operation to retrieve a default database server. Note: this operation is available only in Plesk for Unix.

Request Packet Structure


A request XML packet retrieving a default database server info includes the get-default operation node:
<packet version="1.4.2.0"> <db_server> <get-default> </get-default> </db_server> </packet>

The get-default node has the following graphical representation:

The filter node is required. It specifies the filtering rule. Data type: none. The type node is required. If specified, the local database server will be set as default for managing databases of the specified type. Data type: string. Allowed values: mysql | postgresql.

Note: If the filter node is left blank (<filter/>), the operation will return default database servers for all types of databases. A single packet can retrieve the data of multiple default database servers. Add as many different type parameters as the number of default database servers info on which you want to retrieve.
<db_server> <get-default> </get-default> ... <get-default> </get-default> </db_server>

Supported Operations

132

Request Samples
Retrieving status of a database server This packet retrieves default MySQL database server.
<packet version="1.4.2.0"> <db_server> <get-default> <filter> <type>mysql</type> </filter> </get-default> </db_server> </packet>

Retrieving status of multiple database servers This packet retrieves default MySQL and PostgreSQL database servers.
<packet version="1.4.2.0"> <db_server> <get-default> <filter> <type>mysql</type> <type>postgresql</type> </filter> </get-default> </packet>

Response Packet Structure


The get-default node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the get-default operation. Data type: string. Allowed values: ok | error.

Supported Operations

133

The errcode node is optional. Is returns the error code if the get-default operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-default operation fails. Data type: string. The type node is optional. It returns the type of the database server. Data type: string. The id node is optional. If the get-default operation succeeds, it returns the ID of the database server. Data type: integer.

Note: In the API RPC 1.3.5.1 either id or type can be retrieved.

Response Samples
Retrieving status of a database server This request packet retrieves default MySQL database server info.
<packet version="1.4.2.0"> <db_server> <get-default> <filter> <type>mysql</type> </filter> </get-default> </db_server> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <db_server> <get-default> <result> <status>ok</status> <type>mysql</type> <id>2l</id> </result> </get-default> </db_server> </packet>

If an unsupported type was specified in the request packet, the response from the server looks as follows:
<packet version="1.4.2.0"> <db_server> <get-default> <result> <status>error</status> <status>14006</status> <status>unsupported database type</status> </result> </get-default> </db_server> </packet>

Supported Operations

134

Retrieving status of multiple database servers This packet retrieves default MySQL and PostgreSQL database servers info.
<packet version="1.4.2.0"> <db_server> <get-default> <filter> <type>mysql</type> <type>postgresql</type> </filter> </get-default> </packet>

A possible response from the server looks as follows:


<packet version="1.4.2.0"> <db_server> <get-default> <result> <status>ok</status> <type>mysql</type> <id>2l</id> </result> <result> <status>ok</status> <type>postgresql</type> <id>1l</id> </result> </get-default> </db_server> </packet>

Retrieving Database Server Parameters


Use get operation to retrieve parameters of the database server specified by ID. You can retrieve preferences of multiple database servers in a single operation.

Request Packet Structure


A request XML packet retrieving a database server info includes the get operation node:
<packet version="1.4.2.0"> <db_server> <get> </get> </db_server> </packet>

Supported Operations

135

The get node has the following graphical representation: The filter node is required. It specifies the filtering rule. Data type: none.

The id node is optional. Specifies the database server ID. Data type: integer.

Note: If the filter node is left blank (<filter/>), the operation will return info on all database servers. Remarks A single operation can retrieve the data of multiple database servers. Add as many different id parameters as the number of database servers info on which you want to retrieve.
<db_server> <get> </get> ... <get> </get> </db_server>

Request Samples
Retrieving a single database server This packet retrieves info on the database server specified by ID 7.
<packet version="1.4.2.0"> <db_server> <get> <filter> <id>7</id> </filter> </get> </db_server> </packet>

Retrieving multiple database servers This packet retrieves info on database servers specified by ID 7 and ID 9.
<packet version="1.4.2.0"> <db_server> <get> <filter> <id>7</id> <id>9</id> </filter> </get> </db_server> </packet>

Supported Operations

136

This packet retrieves info on all database servers available for the packet sender.
<packet version="1.4.2.0"> <db_server> <get> <filter/> </get> </db_server> </packet>

Response Paket Structure


The get node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: extension of DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get operation fails. Data type: string.

Supported Operations

137

The id node is optional. It returns the ID of the database server. Data type: integer.

The data node is optional. Data type: databaseServerDescription (plesk_db.xsd) If the get operation succeeded it returns the following data: The host node is optional. Specifies the IP address or name of the database server. Data type: string. The port node is optional. It specifies the port of the database server. Data type: string. The type node is required. It returns the type of the database server. Data type: string. The admin node is required. It specifies the login name of administrator of the database server. Data type: integer. The password node is optional. It specifies the password of the administrator of the database server. Data type: integer. The status node is required. Specifies the status of connection to the database server. Data type: string. Allowed values: NO_ERROR | CONNECTION_FAILED | LOGIN_FAILED | PERMISSION_DENIED | OTHER_ERROR | CREDENTIALS_NOT_SET The db_num node is required. Specifies the number of databases managed by the database server. Data type: integer. The default node is optional. It specifies it is a default database server. Data type: none.

The local node is optional. It specifies it is a local database server. Data type: none.

Supported Operations

138

Response Samples
Retrieving a single database server This packet retrieves the database server specified by ID 7
<packet version="1.4.2.0"> <db_server> <get> <filter> <id>7</id> </filter> </get> </db_server> </packet>

A positive response from the server can look as follows:


<db_server> <get> <result> <status>ok</status> <id>7</id> <data> <host>14.13.11.2</host> <port>5432</port> <type>mysql</type> <admin></admin> <status>CREDENTIALS_NOT_SET</status> <db_num>0</db_num> </data> </result> </get> </db_server> </packet>

If the database server was not found, the result is as follows:


<db_server> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database server does not exist.</errtext> </result> </get> </db_server> </packet>

Retrieving multiple database servers This request packet retrieves info on the database servers specified by ID 2 and ID 92.
<packet version="1.4.2.0"> <db_server> <get> <filter>

Supported Operations <id>2</id><id>92</id> </filter> </get> </db_server> </packet>

139

A possible response from the server can look as follows:


<packet version="1.4.2.0"> <db_server> <get> <result> <status>ok</status> <id>2</id> <data> <host>localhost</host> <port>5432</port> <type>postgresql</type> <admin></admin> <status>CREDENTIALS_NOT_SET</status> <db_num>0</db_num> <default></default> <local></local> </data> </result> <result> <status>ok</status> <id>92</id> <data> <host>some.host</host> <port>5432</port> <type>postgresql</type> <admin>admin</admin> <password>qweqwe</password> <status>OTHER_ERROR</status> <db_num>0</db_num> </data> </result> </get> </db_server> </packet>

Retrieving Supported Types Of Databases


A request XML packet retrieving types of database servers supported by Plesk includes the get-supported-types operation node:
<packet version="1.4.2.0"> <dns> <get-supported-types/> </dns> </packet>

The graphical representation of the get-supported-types node is as follows:

Supported Operations

140

Request sample This request packet retrieves the supported types of database servers.
<packet version="1.4.2.0"> <db_server> <get-supported-types/> </db_server> </packet>

Response Packet Structure


The get-supported-types node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the get-supportedtypes operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get-supported-types operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-supported-types operation fails. Data type: string. The type node is optional. It returns the types of supported database servers if the get-supported-types operation succeeds. Data type: string.

Supported Operations

141

Response Samples

This request packet retrieves the supported types of database servers.

<packet version="1.4.2.0"> <db_server> <get-supported-types/> </db_server> </packet>

If the request was sent to Plesk for MS Windows server, the result is as follows:

<packet version="1.4.2.0"> <db_server> <get-supported-types> <result> <status>ok</status> <type>mssql</type> <type>mysql</type> </result> </get-supported-types> </db_server> </packet>

If the request was sent to Plesk for Unix server, the result is as follows:

<packet version="1.4.2.0"> <db_server> <get-supported-types> <result> <status>ok</status> <type>mysql</type> <type>postgresql</type> </result> </get-supported-types> </db_server> </packet>

Supported Operations

142

Retrieving Local Database Servers Info


Use the get-local operation to retrieve info on local database servers of the specified type. You can retrieve preferences of multiple local database servers in a single packet. Note: this operation is available only in Plesk for Unix.

Request Packet Structure


A request XML packet retrieving a local database server info includes the get-local operation node:
<packet version="1.4.2.0"> <db_server> <get-local> </get-local> </db_server> </packet>

The get-local node has the following graphical representation:

The filter node is required. It specifies the filtering rule. Data type: none. The type node is optional. It specifies the type of local database servers. Data type: string. Allowed values: mssql | mysql | postgresql.

Note: If the filter node is left blank (<filter/>), the operation will return info on all local database servers. A single operation can retrieve the data of multiple database servers. Add as many different type parameters as the number of local database servers info on which you want to retrieve.
<db_server> <get-local> </get-local> ... <get-local> </get-local> </db_server>

Supported Operations

143

Request Samples
Retrieving info on a single database server This packet retrieves info on the local MySQL database server.
<packet version="1.4.2.0"> <db_server> <get-local> <filter> <type>mysql</type> </filter> </get-local> </db_server> </packet>

Retrieving info on multiple database servers This packet retrieves info on all local database servers.
<packet version="1.4.2.0"> <db_server> <get-local> <filter/> </get-local> </db_server> </packet>

Response Packet Structure


The get-local node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DatabaseServerResultType (database_output.xsd). The status node is required. It specifies the execution status of the get-local operation. Data type: string. Allowed values: ok | error. The errtext node is optional. It returns the error message if the get-local operation fails. Data type: string.

Supported Operations

144

The errcode node is optional. Is returns the error code if the get-local operation fails. Data type: integer. The type node is required. It returns the type of the database server. Data type: string. The id node is optional. It returns the ID of the database server. Data type: integer.

Note: In the API RPC 1.3.5.1 either id or type can be retrieved.

Response Samples
Retrieving info on a single database server This request packet retrieves info on the MySQL local database server.
<packet version="1.4.2.0"> <db_server> <get-local> <filter> <type>mysql</type> </filter> </get-local> </db_server> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <db_server> <get-local> <result> <status>ok</status> <type>mysql</type> <id>1</id> </result> </get-local> </db_server> </packet>

If the type of database server was invalid, the response from the server looks as follows:
<packet version="1.4.2.0"> <db_server> <get-local> <result> <status>error</status> <errcode>14007</errcode> <errtext>Unsupported database type</errtext> <type>NewSQL</type> </result> </get-local> </db_server> </packet>

Supported Operations

145

Retrieving info on multiple database servers

This request packet retrieves info on all local database servers.

<packet version="1.4.2.0"> <db_server> <get-local> <filter/> </get-local> </db_server> </packet>

A possible response from the server can look as follows:

<packet version="1.4.2.0"> <db_server> <get-local> <result> <status>ok</status> <type>mysql</type> <id>1</id> </result> <result> <status>ok</status> <type>postgresql</type> <id>2</id> </result> </get-local> </db_server> </packet>

Supported Operations

146

Managing Databases
Operator: <database> XML Schema: database_input.xsd, database_output.xsd Plesk version: Plesk 8.1 for Windows or Unix API RPC version: 1.4.2.0 and higher Plesk user: Plesk Administrator, Plesk Client Description Databases are used to store information in a tables format. You can add users to a database (create their own accounts) to grant them access to this information. One of the database user accounts (hereinafter referred to as database administrator) is used for administering the database via the Plesk graphical user interface (DB WebAdmin tool) or by connecting directly to the database server. Supported operations

ADD-DB (see page 148) creates database entry of the specified type, defining the domain that will use it DEL-DB (see page 154) removes database entry; If a database is used by an application installed on the server, it cannot be removed GET-DB (see page 170) retrieves database parameters by the ID, domain name or domain ID SET-DEFAULT-USER (see page 163) specifies a database administrator

Supported Operations

147

GET-DEFAULT-USER (see page 166) retrieves ID of administrator of a specified database ADD-DB-USER (see page 158) creates a database user account for a specified database DEL-DB-USER (see page 185) removes a database user account from a specified database GET-DB-USERS (see page 181) retrieves the list of users of a specified database SET-DB-USER (see page 177) changes credentials of a database user

Remarks Before working with databases, be sure to call operation get_supported_types (on page 139) or the db_server (on page 112) operator in order to retrieve information on which database servers are configured on the specific Plesk server.

Filtering Issues
Filtering is the way the request XML packet indicates the object to which the operation will be applied. The request XML filters data using a special <filter> section. A single filter can specify multiple database users, all specified either by ID or by database ID. It also can match multiple databases, specified either by ID, domain ID, or domain name. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.
<filter> ... </filter>

A packet that retrieves information about databases on domain MyDomain.com can look as follows:
<packet version="1.4.2.0"> <database> <get-db> <filter> <domain-name>MyDomain.com</domain-name> </filter> </get-db> </database> </packet>

If an operation in a request packet (del-db-user, get-db, get-db-users, get-default-user, deldb) uses filters, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If one of the following values was set as a filter rule parameter, it is returned in the filter-id node of the response packet:

Supported Operations

148

database ID domain name domain ID database user ID

It is done so to trace the request parameters in case of an error. Data type: anySimple. If the filter node is left blank (<filter/>), the filter-id parameter will hold the ID of the object. The blank filter means that all objects (like databases or database users) are matched by this rule. Note: The <filter-id> node appears in API RPC 1.4.2.0. Earlier versions of the protocol do not support this node.

Creating Databases
The add-db operation is used to create a database for a certain domain. You can specify the database settings only on creation. You can create a database of one of the following types: MySQL or MS SQL in Plesk for Windows MySQL or PostgreSQL in Plesk for Unix

Request Packet Structure


A request XML packet creating a database includes the add-db operation node:
<packet version="1.4.2.0"> <database> <add-db> </add-db> </database> </packet>

The add-db node is presented by type DatabaseAddInputType (database_input.xsd), and its graphical representation is as follows:

Supported Operations

149

The domain-id node is required. It specifies the domain on which you want to create database. Data type: integer. The name node is required. It specifies the database name. Data type: string. The type node is required. It specifies the database type. MySQL and MS SQL are available in Plesk for Windows. MySQL and PostgreSQL types are available in Plesk for Unix. Data type: string. The db-server-id node is required. It specifies the ID of the database server on which the database will be created. This node is required only in Plesk for Unix. Data type: integer.

Note: The db-server-id node is required only when you use Plesk for Unix. For info on database servers, refer to Managing Database Servers (on page 112) section. In Plesk for Windows, you can define the ID of a database server by the type of databases. However, it is recommended to consider this parameter as required, because in next versions of Plesk for Windows the algorithm of defining database servers can be changed. Note: Use lower case for the database types. In other case the request might be incorrectly processed by the server. Remarks You can add multiple databases in a single packet. Add as many add-db operations as the number of databases you want to add.
<database> <add-db> </add-db> ... <add-db> </add-db> </database>

Request Samples
Adding a database This packet adds MyBase MySQL database to the domain specified by ID 7. The packet is valid only in Plesk for Windows.
<packet version="1.4.2.0"> <database> <add-db> <domain-id>7</domain-id> <name>MyBase</name> <type>mysql</type> </add-db> </database> </packet>

Supported Operations

150

This packet adds My2Base PostgreSQL database to the domain specified by ID 8. This example is valid only in Plesk for Unix.
<packet version="1.4.2.0"> <database> <add-db> <domain-id>7</domain-id> <name>My2Base</name> <type>postgresql</type> <db-server-id>34</db-server-id> </add-db> </database> </packet>

Adding multiple databases This packet adds two MySQL databases to the domain with ID 3. The packet is valid only in Plesk for Windows.
<packet version="1.4.2.0"> <database> <add-db> <domain-id>3</domain-id> <name>MyBase</name> <type>mysql</type> </add-db> <add-db> <domain-id>3</domain-id> <name>My2Base</name> <type>mysql</type> </add-db> </database> </packet>

Supported Operations

151

Response Packet Structure


The add-db node of the output XML packet is presented by type DatabaseAddDBOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the add-db operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add-db operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add-db operation fails. Data type: string. The id node is optional. If the add-db operation succeeds, it returns the ID of the database. Data type: integer.

Response Samples
Adding a database The request packet structured as follows:
<packet version="1.4.2.0"> <database> <add-db> <domain-id>7</domain-id> <name>MyBase</name> <type>mysql</type> </add-db> </database> </packet>

Supported Operations

152

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <result> <add-db> <status>ok</status> <id>14</id> </add-db> </result> </database> </packet>

If MyBase already exists, the response from the server looks as follows:
<packet version="1.4.2.0"> <database> <result> <add-db> <status>error</status> <errcode>1007</errcode> <errtext>Database already exists</errtext> </add-db> </result> </database> </packet>

If the domain with ID 7 was not found, the response looks as follows:
<packet version="1.4.2.0"> <database> <result> <add-db> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> </add-db> </result> </database> </packet>

Adding multiple databases The request packet adding mySQL and PostgreSQL databases looks as follows:
<packet version="1.4.2.0"> <database> <add-db> <domain-id>3</domain-id> <name>MyBase</name> <type>mysql</type> </add-db>

Supported Operations <add-db> <domain-id>3</domain-id> <name>MyBase</name> <type>mysql</type> </add-db> </database> </packet>

153

A possible response from the server looks as follows:


<packet version="1.4.2.0"> <database> <result> <add-db> <status>ok</status> <id>14</id> </add-db> </result> <result> <add-db> <status>error</status> <errcode>1007</errcode> <errtext>Database already exists</errtext> </add-db> </result> </database> </packet>

Supported Operations

154

Deleting Databases
Use the del-db operation to remove one or more databases.

Request Packet Structure


A request XML packet deleting a database includes the del-db operation node:
<packet version="1.4.2.0"> <database> <del-db> </del-db> </database> </packet>

The del-db node is presented by type DatabaseDelDbInputType (database_input.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For information on filters, refer to the Filtering Issues (see page 147) section. Data type: DatabaseFilterType.

Note: If the filter node is blank, all databases are removed. The id node is optional. It specifies the ID of a database. Data type: integer. The domain-id node is optional. It specifies the ID of the domain on which databases are removed. Data type: integer. The domain-name node is optional. It specifies the name of the domain on which databases are removed. Data type: string (Unicode).

Supported Operations

155

Request Samples

Deleting a database This packet deletes the database with ID 55


<packet version="1.4.2.0"> <database> <del-db> <filter> <db-id>55</db-id> </filter> </del-db> </database> </packet>

Deleting multiple databases This packet deletes all databases from all database servers available for the packet sender identified by credentials from HTTP header.
<packet version="1.4.2.0"> <database> <del-db> <filter/> </del-db> </database> </packet>

This packet deletes databases with ID 67 and ID 16.


<packet version="1.4.2.0"> <database> <del-db> <filter> <db-id>67</db-id> <db-id>16</db-id> </filter> </del-db> </database> </packet>

Supported Operations

156

Response Packet Structure


The del-db node of the output XML packet is presented by type DatabaseDelDBOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the del-db operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the del-db operation fails. Data type: integer. The errtext node is optional. It returns the error message if the del-db operation fails. Data type: string. The filter-id node is optional. lt returns the filtering rule parameter. For more information, refer to the Filtering Issues (see page 147) section. The id node is optional. If the add-db operation succeeds it returns the ID of the database.

Response Samples
Deleting database The request packet looks as follows:
<packet version="1.4.2.0"> <database> <del-db> <filter> <db-id>55</db-id>

Supported Operations </filter> </del-db> </database> </packet>

157

Positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <del-db> <result> <status>ok</status> <filter-id>55</filter-id> <id>55</id> </result> </del-db> </database> </packet>

Negative response from the server can look as follows:


<packet version="1.4.2.0"> <database> <del-db> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database does not exist</errtext> <filter-id>55</filter-id> </result> </del-db> </database> </packet>

Deleting multiple databases The request packet looks as follows:


<packet version="1.4.2.0"> <database> <del-db> <filter/> </del-db> <del-db> <filter> <db-id>15</db-id> </filter> </del-db> </database> </packet>

Supported Operations

158

A response from the server can look as follows:


<packet version="1.4.2.0"> <database> <del-db> <result> <status>ok</status> <filter-id>15</filter-id> <id>15</id> </result> <result> <status>ok</status> <filter-id>43</filter-id> <id>43</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database does not exist</errtext> <filter-id>15</filter-id> </result> </del-db> </database> </packet>

The last result shows error, because the database with ID 15 is already deleted.

Creating Database Users


You can create new user accounts for a certain database. Specify the user login name, password and the ID of the database where you want to create new user account. You can add multiple users to the database in a single packet.

Request Packet Structure


A request XML packet creating database user account for the database includes the add-db-user operation node:
<packet version="1.4.2.0"> <database> <add-db-user> </add-db-user> </database> </packet>

Supported Operations

159

The add-db-user node is presented by type DatabaseAddDBUserInputType (database_input.xsd), and its graphical representation is as follows:

The db-id node is required. It specifies ID of the database where a new user will be created. Data type: integer. The login node is required. It specifies login name of the database user. Data type: string. The password node is required. It specifies the password of the database user. Data type: string (length should be more than five digits). The password-type node is optional. Specifies if it is plain or encrypted password. Data type:string. Allowed values: plain | crypt.

Remarks You can add multiple users to database in a single packet. Add as many add-db-user operations to the packet as the number of different users you want to create.You can also add multiple users to multiple databases in a single packet.
<database> <add-default-user> </add-default-user> ... <add-default-user> </add-default-user> </database>

Request Samples
Creating a database user This packet creates user MyUser on the database with ID 55.
<packet version="1.4.2.0"> <database> <add-db-user> <db-id>55</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> </database> </packet>

Supported Operations

160

Creating multiple database users This packet creates users MyUser and My2User on the database with ID 55.
<packet version="1.4.2.0"> <database> <add-db-user> <db-id>55</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> <add-db-user> <db-id>55</db-id> <login>My2User</login> <password>123456</password> </add-db-user> </database> </packet>

This packet creates users MyUser and My2User on the databases with ID 55 and ID 57.
<packet version="1.4.2.0"> <database> <add-db-user> <db-id>55</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> <add-db-user> <db-id>55</db-id> <login>My2User</login> <password>123456</password> </add-db-user> <add-db-user> <db-id>57</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> <add-db-user> <db-id>57</db-id> <login>My2User</login> <password>123456</password> </add-db-user> </database> </packet>

Supported Operations

161

Response Packet Structure


The add-db--user node of the output XML packet is presented by type DatabaseAddDBUserOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the add-db--user operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add-db--user operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add-db--user operation fails. Data type: string. The id node is required. It specifies the database user ID. Data type: integer.

Response Samples
Creating a database user This request packet creates user MyUser on the database with ID 55.
<packet version="1.4.2.0"> <database> <add-db-user> <db-id>55</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> </database> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <add-db-user> <result> <status>ok</status>

Supported Operations <id>132</id> </result> </add-db-user> </database> </packet>

162

If the database was not found, the response looks as follows:


<packet version="1.4.2.0"> <database> <add-db-user> <result> <status>error</status> <errcode>1015</errcode> <errtext>Database not found</errtext> </result> </add-db-user> </database> </packet>

If the login name is already used by another user account on this database, the response looks as follows:
<packet version="1.4.2.0"> <database> <add-db-user> <result> <status>error</status> <errcode>1007</errcode> <errtext>User already exists</errtext> </result> </add-db-user> </database> </packet>

Creating multiple database users This packet creates user MyUser on the databases with ID 55 and ID 57.
<packet version="1.4.2.0"> <database> <add-db-user> <db-id>55</db-id> <login>MyUser</login> <password>hello</password> </add-db-user> <add-db-user> <db-id>55</db-id> <login>My2User</login> <password>123456</password> </add-db-user> </database> </packet>

Supported Operations

163

If the first operation succeeded and the database with ID=57 was not found, the response from the server looks as follows:
<packet version="1.4.2.0"> <database> <add-db-user> <result> <status>ok</status> <id>132</id> </result> </add-db-user> <add-db-user> <result> <status>error</status> <errcode>1015</errcode> <errtext>Database not found</errtext> </result> </add-db-user> </database> </packet>

Assigning Database Administrator


Database administrator is a database user who can manage the database either via Plesk graphical user interface (DB WebAdmin tool) or by connecting directly to the database server. You can set any database user account as the database administrator's account. There can be only one administrator's account for each database. If you create a database, the first user created in the database will be appointed to act as a database administrator.

Request Packet Structure


A request XML packet assigning a database administrator includes the set-default-user operation node:
<packet version="1.4.2.0"> <database> <set-default-user> </set-default-user> </database> </packet>

The set-default-user node is presented by type DatabaseSetDBInputType (database_input.xsd), and its graphical representation is as follows:

Supported Operations

164

The db-id node is required. Specifies the database that will be managed by database administrator. Data type: integer. The default-user-id node is optional. Specifying the database administrator for managing a database. Data type: integer.

Remarks You can set database administrators for multiple databases using a single packet. Add as many set-default-user operations as the number of database administrator's accounts you want to set.
<database> <set-default-user> </set-default-user> ... <set-default-user> </set-default-user> </database>

Request Samples
Assigning a Database Administrator This packet sets the user with ID 35 as administrator for the database with ID 132.
<packet version="1.4.2.0"> <database> <set-default-user> <db-id>132</db-id> <default-user-id>35</default-user-id> </set-default-user> </database> </packet>

Response Packet Structure


The set-default-user node of the output XML packet is presented by type DatabaseSetDBOutputType (database_output.xsd) and structured as follows:

Supported Operations

165

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the set-default-user operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set-default-user operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set-default-user operation fails. Data type: string.

Response Samples
Assigning a Database Administrator This request packet sets the user with ID 35 as administrator for the database with ID 132.
<packet version="1.4.2.0"> <database> <set-default-user> <db-id>132</db-id> <default-user-id>35</default-user-id> </set-default-user> </database> </packet>

The negative response from the server looks as one of the follows: The database with ID=132 was not found on the server.

<packet version="1.4.2.0"> <database> <set-default-user> <result> <status>error</status> <errcode>1015</errcode> <errtext>Database not found</errtext> </result> </set-default-user> </database> </packet>

The user with ID=35 was not found in the database with ID=132.

<packet version="1.4.2.0"> <database> <set-default-user> <result> <status>error</status> <errcode>1015</errcode> <errtext>Database not found</errtext> </result> </set-default-user> </database> </packet>

Supported Operations

166

The positive response received from the server looks as follows:


<packet version="1.4.2.0"> <database> <set-default-user> <result> <status>ok</status> </result> </set-default-user> </database> </packet>

Retrieving Database Administrator Info


Administering database is available when using database administrator credentials, either via Plesk graphical user interface (DB WebAdmin tool) or by connecting directly to the database server. You can set any database user account as the database administrator's account. There can be only one administrator's account for each database. If you create a new database, the first user created in the database will be set as its administrator.

Request Packet Structure


A request XML packet retrieving database administrator info includes the get-default-user operation node:
<packet version="1.4.2.0"> <database> <get-default-user> </get-default-user> </database> </packet>

The get-default-user node is presented by type DatabaseGetDBInputType (database_input.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (see page 147) section. Data type: DatabaseDefaultUserFilterType. The db-id node is optional. It specifies ID of a database. Data type: integer.

Supported Operations

167

Remarks You can retrieve ID's of multiple database administrators using a single packet. Add the get-default-user operation for each database to the request packet.
<database> <get-default-user> </get-default-user> ... <get-default-user> </get-default-user> </database>

Request Samples

Retrieving info on a Database Administrator This packet retrieves info on administrator for the database with ID 35.
<packet version="1.4.2.0"> <database> <get-default-user> <filter> <db-id>35</db-id> </filter> </get-default-user> </database> </packet>

Retrieving info on multiple Database Administrators This packet retrieves administrators for all databases on all database servers available for the packet sender.
<packet version="1.4.2.0"> <database> <get-default-user> <filter/> </get-default-user> </database> </packet>

Supported Operations

168

Response Packet Structure


The get-default-user node of the output XML packet is presented by type DatabaseSetDBOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get-default-user operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get-default-user operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-default-user operation fails. Data type: string. The filter-id node is optional. lt returns the filtering rule parameter. For more information, refer to the Filtering Issues (see page 147) section. The id node is required. It specifies the database administrator ID. Data type: integer.

Response Samples
Retrieving info on a Database Administrator This packet retrieves a Database Administrator of the database with ID 35.
<packet version="1.4.2.0"> <database> <get-default-user> <filter> <db-id>35</db-id>

Supported Operations </filter> </get-default-user> </database> </packet>

169

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <get-default-user> <result> <status>ok</status> <filter-id>35</filter-id> <id>77</id> </result> </get-default-user> </database> </packet>

A negative response got from the server can look as follows:


<packet version="1.4.2.0"> <database> <get-default-user> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database not found</errtext> </result> </get-default-user> </database> </packet>

Retrieving info on multiple Database Administrators This packet retrieves Database Administrators of all databases on all database servers available for the packet sender.
<packet version="1.4.2.0"> <database> <get-default-user> <filter/> </get-default-user> </database> </packet>

A response packet from the server can look as follows:


<packet version="1.4.2.0"> <database> <get-default-user> <result> <status>ok</status> <filter-id>15</filter-id>

Supported Operations <id>77</id> </result> <result> <status>ok</status> <filter-id>35</filter-id> <id>17</id> </result> <result> <status>ok</status> <filter-id>24</filter-id> <id>72</id> </result> </get-default-user> </database> </packet>

170

Retrieving Information About Databases


Use the get-db operation to retrieve the following database preferences: name type domain ID database server ID Database Administrator ID

Request Packet Structure


A request XML packet retrieving database parameters includes the get-db operation node:
<packet version="1.4.2.0"> <database> <get-db> </get-db> </database> </packet>

Supported Operations

171

The get-db node is presented by type DatabaseGetDBInputType (database_input.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (see page 147) section. Data type: DatabaseFilterType (database_input.xsd). The id node is optional. It specifies the ID of a database. Data type: integer. The domain-id node is optional. It specifies the ID of the domain on which a database is added. Data type: integer. The domain-name node is optional. It specifies the name of the domain on which a database is added. Data type: string (Unicode).

Remarks You can retrieve information on multiple databases using a single packet. Add as many get-db operations as the number of different filtering rules (you can either filter by ID, domain-id, or by domain-name).
<database> <get-db> <filter> ... </filter> </get-db> </database>

Request Samples
Retrieving database parameters This packet retrieves information about a database with ID 5.
<packet version="1.4.2.0"> <database> <get-db> <filter> <id>5</id>

Supported Operations </filter> </get-db> </database> </packet>

172

Retrieving parameters of multiple databases This packet retrieves information on all databases added to domain MyDomain.com, and to the domain specified by ID 45.
<packet version="1.4.2.0"> <database> <get-db> <filter> <domain-name>MyDomain.com</domain-name> </filter> </get-db> <get-db> <filter> <domain-id>45</domain-id> </filter> </get-db> </database> </packet>

This packet retrieves information about all databases added to the MyDomain.com and My2Domain.com domains.
<packet version="1.4.2.0"> <database> <get-db> <filter> <domain-name>MyDomain.com</domain-name> <domain-name>My2Domain.com</domain-name> </filter> </get-db> </database> </packet>

This packet is wrong because it uses both domain-name and domain-id in one filter node.
<packet version="1.4.2.0"> <database> <get-db> <filter> <domain-name>MyDomain.com</domain-name> <domain-id>117</domain-id> </filter> </get-db> </database> </packet>

Supported Operations

173

Response Packet Structure


The del-db node of the output XML packet is presented by type DatabaseDelDBOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get-db operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get-db operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-db operation fails. Data type: string. The filter-id node is optional. lt returns the filtering rule parameter. For more information, refer to the Filtering Issues (see page 147) section. The name node is required. It specifies the database name. Data type: string. The type node is required. It specifies the database type. MySQL and MS SQL are available in Plesk for Windows. MySQL and PostgreSQL types are available in Plesk for Unix. Data type: string. Allowed values: mssqsl | mysql | postgresql.

Supported Operations

174

The domain-id node is optional. It is required if the get-db operation succeeds. It specifies the ID of the domain on which a database is added. Data type: integer. The db-server-id node is optional. It is required if the get-db operation succeeds. It specifies the ID of the database server on which a database will be created. This node is required only in Plesk for Unix. Data type: integer. The default-user-id node is optional It is required if the get-db operation succeeds. It specifies ID of the database administrator. Data type: integer.

Response Samples
Retrieving database parameters This packet retrieves information on a database with ID 5.
<packet version="1.4.2.0"> <database> <get-db> <filter> <id>5</id> </filter> </get-db> </database> </packet>

Positive response from the server looks as follows:


<packet version="1.4.2.0"> <database> <get-db> <result> <status>ok</status> <filter-id>5</filter-id> <id>5</id> <name>MyDatabase</name> <type>mysql</type> <domain-id>77</domain-id> <db-server-id>17</db-server-id> <default-user-id>10</default-user-id> </result> </get-db> </database> </packet>

Negative response from the server looks as follows:


<packet version="1.4.2.0"> <database> <get-db> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database does not exist</errtext>

Supported Operations <filter-id>5</filter-id> </result> </get-db> </database> </packet>

175

Retrieving parameters of multiple databases This packet retrieves information on all databases added to the MyDomain.com, My2Domain.com domains and to the domain specified by ID 45.
<packet version="1.4.2.0"> <database> <get-db> <filter> <domain-name>MyDomain.com</domain-name> <domain-name>My2Domain.com</domain-name> </filter> </get-db> <get-db> <filter> <domain-id>45</domain-id> </filter> </get-db> </database> </packet>

One database was found on domain MyDomain.com, the domain with ID 45 and domain My2domain.com were not found. The response from the server in this case looks as follows:
<packet version="1.4.2.0"> <database> <get-db> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>5</id> <name>MyDatabase</name> <type>mysql</type> <domain-id>77</domain-id> <db-server-id>17</db-server-id> <default-user-id>10</default-user-id> </result> </get-db> <get-db> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> <filter-id>My2Domain.com</filter-id> </result> <result>

Supported Operations <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> <filter-id>45</filter-id> </result> </get-db> </database> </packet>

176

When two or more databases are found on the specified domain, a server response is the following:
<packet version="1.4.2.0"> <database> <get-db> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>5</id> <name>MyDatabase</name> <type>mysql</type> <domain-id>77</domain-id> <db-server-id>17</db-server-id> <default-user-id>10</default-user-id> </result> </get-db> <get-db> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>8</id> <name>My2base</name> <type>mysql</type> <domain-id>77</domain-id> <db-server-id>17</db-server-id> <default-user-id>10</default-user-id> </result> </get-db> </database> </packet>

Supported Operations

177

Changing Database User Credentials


You can change credentials of certain database user. To change login or password of a database user, specify the user's ID. You can update preferences for multiple users in a single set-db-user packet.

Request Packet Structure


A request XML packet retrieving users from the database includes the set-db-users operation node:
<packet version="1.4.2.0"> <database> <set-db-user> </set-db-user> </database> </packet>

The set-db-user node is presented by type DatabaseSetDBUserInputType (database_input.xsd), and its graphical representation is as follows:

The id node is required. It specifies ID of the database user whose preferences are to be changed. Data type: integer. The login node is optional. It specifies new login name for the database user. Data type: string. The password node is required. It specifies new password for the database user. Data type: string (length should be more than five digits). The password-type node is optional. Specifies if it is a plain or encrypted password. Data type:string. Allowed values: plain | crypt.

Remarks You can change credentials for multiple database users in a single packet. Add as many set-db-user operations to the packet as the number of different users you want to update.
<packet version="1.4.2.0"> <database> <set-db-user> ... </set-db-user>

Supported Operations ... <set-db-user> ... </set-db-user> </database> </packet>

178

Request Samples
Changing database user credentials This request packet sets new password for the database user identified by ID 61.
<packet version="1.4.2.0"> <database> <set-db-user> <id>61</id> <password>a1b2c3d</password> </set-db-user> </database> </packet>

This request packet sets new password and login name for the database user identified by ID 67.
<packet version="1.4.2.0"> <database> <set-db-user> <id>61</id> <login>MyNewName</login> <password>a1b2c3d</password> </set-db-user> </database> </packet>

Changing credentials of multiple database users This request packet sets new passwords for two database users (identified by ID 6 and ID 7).
<packet version="1.4.2.0"> <database> <set-db-user> <id>6</id> <password>a1b2c3d</password> </set-db-user> <set-db-user> <id>7</id>

Supported Operations <password>b1c2d3e</password> </set-db-user> </database> </packet>

179

Response Packet Structure


The set-db-user node of the output XML packet is presented by type DatabaseSetDBUserOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the set-db-user operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set-db--user operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set-db--user operation fails. Data type: string. The id node is optional. If the set-db-users operation succeeds, it specifies the id of the updated database user. Data type: string.

Response Samples
Changing database user credentials This request packet sets new password for the database user identified by ID 61.
<packet version="1.4.2.0"> <database> <set-db-user> <id>61</id> <password>a1b2c3d</password>

Supported Operations

180

</set-db-user> </database> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <set-db-user> <result> <status>ok</status> <id>61</id> </result> </set-db-user> </database> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <database> <set-db-user> <result> <status>error</status> <errcode>1013</errcode> <errtext>Database user does not exist</errtext> </result> </set-db-user> </database> </packet>

Changing credentials for multiple database users This request packet sets new login names and passwords for the database users identified by ID=61 and ID=68.
<packet version="1.4.2.0"> <database> <set-db-user> <id>61</id> <login>testUser</login> <password>a1b2c3d</password> </set-db-user> <set-db-user> <id>68</id> <login>secondUser</login> <password>abc2c3d</password> </set-db-user> </database> </packet>

Supported Operations

181

If the user with ID 61 was not found on server, and the user with ID 68 was successfully updated, the response packet looks as the follows:
<packet version="1.4.2.0"> <database> <set-db-user> <result> <status>ok</status> <id>61</id> </result> </set-db-user> <set-db-user> <result> <status>ok</status> <id>68</id> </result> </set-db-user> </database> </packet>

Retrieving Database Users Info


You can retrieve information on users of the certain database. To retrieve information on database users, specify the ID of the database. You can retrieve information about users of multiple databases in a single get-db-users operation.

Request Packet Structure


A request XML packet retrieving users info from the database includes the get-db-users operation node:
<packet version="1.4.2.0"> <database> <get-db-users> </get-db-users> </database> </packet>

The get-db-user node is presented by type DatabaseGetDBInputType (database_input.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (see page 147) section. Data type: DatabaseUserFilterType.

Supported Operations

182

The db-id node is optional. It specifies the ID of the database from which information about users is retrieved. Data type: integer.

Remarks Note: In API RPC v.1.5.1.0 and later versions, the get-db-user node is presented by type DatabaseGetDBUsersInputType (database_input.xsd). You can retrieve information from multiple databases using a single get-db-users operation. Add as many db-id parameters to the filtering rule as the number of different databases you want to scan.
<database> <get-db-users> <filter> <db-id>...</db-id> <db-id>...</db-id> </filter> </get-db-users> </database>

Note: Use the <filter/> parameter to retrieve information about all users from all databases available for the user identified by credentials from HTTP header.

Request Samples
Retrieving information about users of database This request packet retrieves information on all users of the database with ID 79.
<packet version="1.4.2.0"> <database> <get-db-users> <filter> <db-id>79</db-id> </filter> </get-db-users> </database> </packet>

Retrieving information about all users of all databases This request packet retrieves information on all users of all available databases.
<packet version="1.4.2.0"> <database> <get-db-users> <filter/> </get-db-users> </database> </packet>

Supported Operations

183

Response Packet Structure


The get-db-users node of the output XML packet is presented by type DatabaseGetDBUsersOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the get-db-users operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get-db--users operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-db--user operation fails. Data type: string. The filter-id node is optional. lt returns the filtering rule parameter. For more information, refer to the Filtering Issues (see page 147) section. The id node is optional. If the get-db-users operation succeeds, it specifies the database user ID. Data type: integer. The login node is optional. If the get-db-users operation succeeds, it specifies login name of the database user. Data type: string. The db-id node is optional. If the get-db-users operation succeeds, it specifies ID of the database where the user is located. Data type: integer.

Supported Operations

184

Response Samples
Retrieving information about users of database This request packet retrieves information about all users of the database with ID=79.
<packet version="1.4.2.0"> <database> <get-db-users> <filter> <db-id>79</db-id> </filter> </get-db-users> </database> </packet>

If two users (UserOne and UserTwo) were found in the database, the response from the server looks as follows:
<packet version="1.4.2.0"> <database> <get-db-users> <result> <status>ok</status> <filter-id>79</filter-id> <id>15</id> <login>UserOne</login> <db-id>79</db-id> </result> <result> <status>ok</status> <filter-id>79</filter-id> <id>15</id> <login>UserTwo</login> <db-id>79</db-id> </result> </get-db-users> </database> </packet>

If the database was not found, the response from the server looks as follows:
<packet version="1.4.2.0"> <database> <get-db-users> <result> <status>ok</status> <errcode>1015<errcode> <errtext>Database does not exist</errtext> <filter-id>79</filter-id> </result> <get-db-users> <database> </packet>

Supported Operations

185

Deleting Database Users


You can remove user accounts from a certain database. Specify the user login name and ID of the database where you want to remove the user. You can remove all users from all databases in a single del-db-user operation.

Request Packet Structure


A request XML packet deleting a user from the database includes the del-db-user operation node:
<packet version="1.4.2.0"> <database> <del-db-user> </del-db-user> </database> </packet>

The del-db-user node is presented by type DatabaseDelDBUserInputType (database_input.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (see page 147) section. Data type: DatabaseUserFilterType. The id node is optional. It specifies the ID of the user you want to delete. Data type: integer. The db-id node is optional. It specifies the ID of the database where a new user will be created. Data type: integer.

Remarks You can delete multiple users from the database using a single packet. Add as many del-db-user operations as the number of different users you want to delete from the database.
<database> <del-db-user> </del-db-user> ... <del-db-user>

Supported Operations </add-db-user> </database>

186

You can also delete all users from the different databases using this construction. Note: Use the <filter/> parameter if you want to delete all users from all databases available for the sender.

Request Samples
Deleting a database user This packet removes the user with ID 55 from a database.
<packet version="1.4.2.0"> <database> <del-db-user> <filter> <id>55</id> </filter> </del-db-user> </database> </packet>

Deleting multiple database users This packet removes all users from the database with ID 45.
<packet version="1.4.2.0"> <database> <del-db-user> <filter> <db-id>45</db-id> </filter> </del-db-user> </database> </packet>

This packet removes all users from all databases available for the user identified by credentials from HTTP header.
<packet version="1.4.2.0"> <database> <del-db-user> <filter/> </del-db-user> </database> </packet>

Supported Operations

187

Response Packet Structure


The del-db-user node of the output XML packet is presented by type DatabaseDelDBUserOutputType (database_output.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the del-db-user operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the del-db--user operation fails. Data type: integer. The errtext node is optional. It returns the error message if the del-db--user operation fails. Data type: string. The filter-id node is optional. lt returns the filtering rule parameter. For more information, refer to the Filtering Issues (see page 147) section. The id node is required. If the del-db-user operation succeeds, it specifies the database user ID. Data type: integer.

Response Samples
Deleting database user This request packet removes the user with ID 55 from the database with ID 2.
<packet version="1.4.2.0"> <database> <del-db-user> <filter> <id>55</id>

Supported Operations </filter> </del-db-user> </database> </packet>

188

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <database> <del-db-user> <result> <status>ok</status> <filter-id>55</filter-id> <id>55</id> </result> </del-db-user> </database> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <database> <del-db-user> <result> <status>ok</status> <errcode>1013<errcode> <errtext>User does not exist</errtext> <filter-id>55</filter-id> </result> </del-db-user> </database> </packet>

Deleting multiple database users This request packet removes all users from the database with ID 45.
<packet version="1.4.2.0"> <database> <del-db-user> <db-id>45</db-id> </del-db-user> </database> </packet>

Two users (ID 7 and ID 8) were removed from the database. The response from the server looks as follows:
<packet version="1.4.2.0"> <database> <del-db-user> <result>

Supported Operations <status>ok</status> <filter-id>45</filter-id> <id>7</id> </result> <result> <status>ok</status> <filter-id>45</filter-id> <id>8</id> </result> </del-db-user> </database> </packet>

189

A negative response can look as follows:


<packet version="1.4.2.0"> <database> <del-db-user> <result> <status>ok</status> <errcode>1015<errcode> <errtext>Database does not exist</errtext> <filter-id>45</filter-id> </result> </del-db-user> </database> </packet>

Supported Operations

190

Managing Desktop Presets


Operator: <desktop> XML Schema: desktop.xsd Plesk version: Plesk 7.5.6 Win | Unix 8.0 and later API RPC version: 1.4.0.0 and higher Plesk user: Plesk Administrator Description The desktop operator is used to modify desktop items of Plesk control panel by applying different desktop presets. The presets are the files containing configuration of desktop elements. You can have several presets for your interface and switch between them when needed. Desktop presets can be of one of the following types: presets for administrators presets for domain administrators presets for clients

The view of interface can be predefined for Plesk Administrator, additional administrator accounts, domain administrators, and clients. The default preset is a preset that will be applied to desktop of these users (except Plesk Administrator) on loading of Plesk control panel. Supported operations

SET-ADMIN (see page 191) changes Plesk Administrator preset SET-DEFAULT-PRESET (see page 194) chooses the default preset for additional administrator accounts, domain administrators, and customers PRESET-LIST (see page 198) retrieves info on presets specified by ID ADD-PRESET (see page 202) overwrites the file of presets

Supported Operations

191

REMOVE-PRESET (see page 209) removes presets specified by name and type, or ID

Remarks Additional administrator accounts are created by Plesk Administrator for technical support engineers, enabling them to perform a virtually limitless variety of administrative tasks. All actions performed by additional Plesk Administrator accounts are logged, which gives the actual Plesk Administrator an unprecedented level of control over additional Administrator accounts' activities. This feature is supported only in Plesk for Windows 8.1.

Changing Plesk Administrator Preset


Use the set-admin operation to change the view of the Plesk Administrator desktop. You can specify only presets for administrators.

Request Packet Structure


A request XML packet changing the Plesk Administrator desktop view includes the setadmin operation node:
<packet version="1.4.2.0"> <desktop> <set-admin> ... </set-admin> </desktop> </packet>

The set-admin node is presented by the SetAdminInputCommandType type (desktop.xsd), and its graphical representation is as follows:

The desktop-preset node is required. It specifies the name of the preset. Data type: string.

Supported Operations

192

Request Samples
This packet applies preset Default Administrator Desktop to the desktop of Plesk Administrator.
<packet version="1.4.2.0"> <desktop> <set-admin> <desktop-preset>Default Administrator Desktop</desktop-preset> </set-admin> </desktop> </packet>

This packet applies preset MyPreset to the desktop of Plesk Administrator.


<packet version="1.4.2.0"> <desktop> <set-admin> <desktop-preset>MyPreset</desktop-preset> </set-admin> </desktop> </packet>

Response Packet Structure


The set-admin node of the output XML packet is presented by type SetAdminResult (desktop.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DesktopOpResultType (desktop.xsd). The status node is required. It specifies the execution status of the set-admin operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set-admin operation fails. Data type: integer.

Supported Operations

193

The errtext node is optional. It returns the error message if the set-admin operation fails. Data type: string. The id node is optional. It holds ID of the preset if the operation succeeds. Data type: integer.

Response Samples
Request sample This request packet applies preset Default Administrator Desktop to the desktop of Plesk Administrator.
<packet version="1.4.2.0"> <desktop> <set-admin> <desktop-preset>Default Administrator Desktop</desktop-preset> </set-admin> </desktop> </packet>

Response sample A positive response from the server can look as follows:
<packet version="1.4.2.0"> <desktop> <set-admin> <result> <status>ok</status> <id>1</id> </result> </set-admin> </desktop> </packet>

If the preset was not found on the server, or the type of preset differs from 'admin', a response from the server can look as follows:
<packet version="1.4.2.0"> <desktop> <set-admin> <result> <status>error</status> <errcode>1013</errcode> <errtext>Preset Default Client Desktop with type admin has not been found in database</errtext> </result> </set-admin> </desktop> </packet>

Supported Operations

194

Choosing Default Preset


Use the set-default-preset operation to choose default preset for clients, domain administrators or additional administrator accounts. If you choose default preset for these Plesk users, it will be immediately applied to their desktop. The default preset for administrators will be applied to Plesk Administrator's desktop only if Administrator's current preset was not found on the server.

Request Packet Structure


A request XML packet changing default preset includes the set-default-preset operation node:
<packet version="1.4.2.0"> <desktop> <set-default-preset> ... </set-default-preset> </desktop> </packet>

The set-default-preset node is presented by the SetDefaultInputCommandType type (desktop.xsd), and its graphical representation is as follows:

The name node is required. It specifies the name of the preset. Data type: string. The id node is required. It specifies the ID of the preset. Data type: integer. The type node is required. It specifies the type of the preset. For information on types of presets, refer to the Managing Desktop Presets (see page 190) section. Data type: string. Allowed values: admin | client | domain.

Remarks You can choose default preset for multiple types of presets. Add as many set-defaultpreset operations as number of presets you want to set as default. Types of the presets should differ.

Request Samples
Defining default preset for presets of the same type This packet chooses default preset for Plesk clients.
<packet version="1.4.2.0"> <desktop>

Supported Operations <set-default-preset> <name>ClientDefaultPreset</name> <type>client</type> </set-default-preset> </desktop> </packet>

195

Defining default preset for multiple types of presets This packet performs the following operations: Chooses the preset called ClientDefaultPreset as default for desktop of Plesk clients Chooses the preset called DomainDefaultPreset as default for desktop of Plesk domain administrators

<packet version="1.4.2.0"> <desktop> <set-default-preset> <name>ClientDefaultPreset</name> <type>client</type> </set-default-preset> <set-default-preset> <name>DomainDefaultPreset</name> <type>domain</type> </set-default-preset> </desktop> </packet>

Response Packet Structure


The set-default-preset node of the output XML packet is presented by type SetDefaultResult (desktop.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DesktopOpResultType (desktop.xsd).

Supported Operations

196

The status node is required. It specifies the execution status of the set-default-preset operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set-default-preset operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set-default-preset operation fails. Data type: string. The id node is optional. It holds ID of the preset if the operation succeeds or if the ID was specified in the request packet. Data type: integer.

Response Samples
Defining default preset for presets of the same type This request packet chooses default preset for Plesk clients.
<packet version="1.4.2.0"> <desktop> <set-default-preset> <name>ClientDefaultPreset</name> <type>client</type> </set-default-preset> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <set-default-preset> <result> <status>ok</status> <id>2</id> </result> </set-default-preset> </desktop> </packet>

If the preset was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <desktop> <set-default-preset> <result> <status>error</status> <errcode>1013</errcode> <errtext>Preset Default Client Desktop with type admin has not been found in database</errtext> </result> </set-default-preset> </desktop> </packet>

Supported Operations

197

Defining default preset for multiple types of presets This request packet performs the following operations: Chooses the preset called ClientDefaultPreset as default for desktop of Plesk clients Chooses the preset called DomainDefaultPreset as default for desktop of Plesk domain owners

<packet version="1.4.2.0"> <desktop> <set-default-preset> <name>ClientDefaultPreset</name> <type>client</type> </set-default-preset> <set-default-preset> <name>DomainDefaultPreset</name> <type>domain</type> </set-default-preset> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <set-default-preset> <result> <status>ok</status> <id>2</id> </result> </set-default-preset> <set-default-preset> <result> <status>ok</status> <id>3</id> </result> </set-default-preset> </desktop> </packet>

Supported Operations

198

Retrieving Preset Preferences


Use the preset-list operation to retrieve preferences of a preset. For info on presets, refer to the Managing Desktop Presets (see page 190) section.

Request Packet Structure


A request XML packet retrieving preferences of a preset includes the preset-list operation node:
<packet version="1.4.2.0"> <desktop> <preset-list> ... </preset-list> </desktop> </packet>

The preset-list node is presented by the PresetListsInputCommandType type (desktop.xsd), and its graphical representation is as follows:

The filter node is required. It specifies the filtering rule. Data type: PresetSimpleFilterType (desktop.xsd). The id node is optional. It specifies the ID of the preset. If ID is not specified, the operation will return all presets available on the server. Data type: integer.

Remarks You can retrieve preferences of multiple presets in a single packet. Add as many id parameters as number of presets info on which you want to retrieve.

Request Samples
Retrieving preferences of a single preset This packet retrieves preferences of the preset specified by ID 5.
<packet version="1.4.2.0"> <desktop> <preset-list> <filter> <id>5</id> </filter> </preset-list> </desktop>

Supported Operations </packet>

199

Retrieving preferences of multiple presets This packet retrieves preferences the presets specified by ID 5 and ID 7.
<packet version="1.4.2.0"> <desktop> <preset-list> <filter> <id>5</id> <id>7</id> </filter> </preset-list> </desktop> </packet>

This packet retrieves preferences of all presets on the server.


<packet version="1.4.2.0"> <desktop> <preset-list> <filter/> </preset-list> </desktop> </packet>

Response Packet Structure


The preset-list node of the output XML packet is presented by type PresetlistsResult (desktop.xsd) and structured as follows:

Supported Operations

200

The result node is required. It warps the response retrieved from the server. Data type: DesktopOpAdvancedpresetType (desktop.xsd). The status node is required. It specifies the execution status of the preset-list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the preset-list operation fails. Data type: integer. The errtext node is optional. It returns the error message if the preset-list operation fails. Data type: string. The id node is optional. It holds ID of the preset. Data type: integer. The preset node is optional. It holds preferences of the preset. Data type: PresetType (desktop.xsd). The following nodes are nested in the response packet only if the operation succeeds: The name node is required. It specifies the preset name. Data type: string. The type node is required. It specifies the type of the preset. For info on types of presets, refer to the Managing Desktop Presets (see page 190) section. Data type: string. Allowed values: admin | client | domain.

The default node is optional. It specifies if the preset will be default for the specified type of presets. For information on default presets, refer to the Managing Desktop Presets (see page 190) section. Data type: none.

Response Samples
Retrieving preferences of a single preset This request packet retrieves preferences of the preset specified by ID 5.
<packet version="1.4.2.0"> <desktop> <preset-list> <filter> <id>5</id> </filter> </preset-list> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <preset-list> <result> <status>ok</status> <id>5</id> <preset> <name>ClientDefaultPreset</name> <type>client</type> <default></default>

Supported Operations </preset> </result> </preset-list> </desktop> </packet>

201

If the preset was not found on the server, the result looks as follows:
<packet version="1.4.2.0"> <desktop> <preset-list> <result> <status>error</status> <errcode>1013</errcode> <errtext>Preset Default Client Desktop with type admin has not been found in database</errtext> <id>5</id> </result> </preset-list> </desktop> </packet>

Retrieving preferences of multiple presets This request packet retrieves preferences of all presets on the server.
<packet version="1.4.2.0"> <desktop> <preset-list> <filter/> </preset-list> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <preset-list> <result> <status>ok</status> <id>5</id> <preset> <name>ClientDefaultPreset</name> <type>client</type> <default></default> </preset> </result> <result> <status>ok</status> <id>7</id> <preset> <name>MyDefaultPreset</name>

Supported Operations <type>admin</type> </preset> </result> </preset-list> </desktop> </packet>

202

Adding Preset
Use the add-preset operation to add a new preset. For information on presets, refer to the Managing Desktop Presets (see page 190) section.

Request Packet Structure


A request XML packet adding a preset includes the add-preset operation node:
<packet version="1.4.2.0"> <desktop> <add-preset> ... </add-preset> </desktop> </packet>

The add-preset node is presented by the AddPresetCommandType type (desktop.xsd), and its graphical representation is as follows:

The file node is required. It specifies full name of the file containing desktop preset. It should be located on the server. If the preset was uploaded using the upload operator, you can retrieve the file value from the response packet of the operation. For information on the upload operator, refer to the Uploading Files to Server (see page 960) section.Data type: string. The overwrite node is optional. It specifies if the file will be overwritten in case of name conflict. Data type: none.

Remarks You can add multiple presets in a single packet. Add as many add-preset operations as number of presets to be added.

Supported Operations

203

Request Samples
Adding a preset This packet adds preset MyPreset to desktop presets located on the server. If preset MyPreset already exists on the server, the operation will overwrite the old file.
<packet version="1.4.2.0"> <desktop> <add-preset> <file>/tmp/mypreset.xml</file> <overwrite/> </add-preset> </desktop> </packet>

Adding multiple presets This packet adds the presets MyPreset and DomainPreset to desktop presets located on the server.
<packet version="1.4.2.0"> <desktop> <add-preset> <file>/tmp/mypreset.xml</file> <overwrite/> </add-preset> <add-preset> <file>/tmp/domainpreset.xml</file> <overwrite/> </add-preset> </desktop> </packet>

Response Packet Structure


The add-preset node of the output XML packet is presented by type AddPresetResult (desktop.xsd) and structured as follows:

Supported Operations

204

The result node is required. It warps the response retrieved from the server. Data type: DesktopOpResultType (common.xsd). The status node is required. It specifies the execution status of the add-preset operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add-preset operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add-preset operation fails. Data type: string. The id node is optional. It holds ID of the preset if the operation succeeds. Data type: integer.

Response Samples
Adding a preset This request packet adds preset MyPreset to desktop presets located on the server. If preset MyPreset already exists on the server, the operation will overwrite the old file.
<packet version="1.4.2.0"> <desktop> <add-preset> <file>/tmp/mypreset.xml</file> <overwrite/> </add-preset> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <add-preset> <result> <status>ok</status> <id>12</id> </result> </add-preset> </desktop> </packet>

If the file was not a valid preset, the response is as follows:


<packet version="1.4.2.0"> <desktop> <add-preset> <result> <status>error</status> <errcode>1002</errcode> <errtext>Unable to import desktop presets: The uploaded XML file contains a syntax error.</errtext> </result> </add-preset> </desktop> </packet>

Supported Operations

205

Adding multiple presets

This packet adds the presets MyPreset and DomainPreset to desktop presets located on the server.
<packet version="1.4.2.0"> <desktop> <add-preset> <file>/tmp/mypreset.xml</file> <overwrite/> </add-preset> <add-preset> <file>/tmp/domainpreset.xml</file> <overwrite/> </add-preset> </desktop> </packet>

A possible response from the server when the second file was not found can look as follows:

<packet version="1.4.2.0"> <desktop> <add-preset> <result> <status>ok</status> <id>12</id> </result> </add-preset> <add-preset> <result> <status>error</status> <errcode>1002</errcode> <errtext>Desktop preset file '' cannot be read</errtext> </result> </add-preset> </desktop> </packet>

Supported Operations

206

Removing Preset
Use the remove-preset operation to remove a preset. For information on presets, refer to the Managing Desktop Presets (see page 190) section. Note: You cannot delete default presets.

Request Packet Structure


A request XML packet removing a preset includes the remove-preset operation node:
<packet version="1.4.2.0"> <desktop> <remove-preset> ... </remove-preset> </desktop> </packet>

The remove-preset node is presented by the RemovePresetInputCommandType type (desktop.xsd), and its graphical representation is as follows:

The filter node is required. It specifies the filtering rule. Data type: PresetfilterType (desktop.xsd). The name node is optional. It specifies the name of the preset. If you specify the preset name, you should also specify the preset type. Data type: string. The type node is optional. It specifies the type of the preset. If you specify the preset type, you should also specify the preset name. Data type: string. The id node is optional. It specifies the ID of the preset. Data type: integer.

Remarks Using different filtering rules, you can do the following operations: Remove a single preset specified by name and type Remove one or more presets specified by ID

Supported Operations

207

The following filtering rule specifies the client preset called ClientPreset.
<filter> <name>ClientPreset</name> <type>client</type> </filter>

The following filtering rule specifies the presets with ID 7 and ID 9


<filter> <id>7</id> <id>9</id> </filter>

Presets can be filtered either by name and type, or by ID. The packet containing type, name, and ID parameters in a single filter node will be considered invalid by Plesk. To use different filtering rules in a single packet, add as many remove-preset operations to the request packet as the number of different filtering rules to be applied.

Request Samples
Removing a preset This packet removes client preset MyPreset.
<packet version="1.4.2.0"> <desktop> <remove-preset> <filter> <name>MyPreset</name> <type>client</type> </filter> </remove-preset> </desktop> </packet>

Removing multiple presets This packet removes the presets specified by ID 6 and ID 8.
<packet version="1.4.2.0"> <desktop> <remove-preset> <filter> <id>6</id> <id>8</id> </filter> </remove-preset> </desktop> </packet>

This packet removes administrator presets MyPreset and MyAdminPreset.


<packet version="1.4.2.0"> <desktop> <remove-preset>

Supported Operations <filter> <name>MyPreset</name> <type>admin</type> </filter> </remove-preset> <remove-preset> <filter> <name>MyAdminPreset</name> <type>admin</type> </filter> </remove-preset> </desktop> </packet>

208

Response Packet Structure


The remove-preset node of the output XML packet is presented by type RemovePresetResult (desktop.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: DesktopOpResultType (common.xsd). The status node is required. It specifies the execution status of the remove-preset operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the remove-preset operation fails. Data type: integer. The errtext node is optional. It returns the error message if the remove-preset operation fails. Data type: string. The id node is optional. It holds ID of the preset if the operation succeeds or if it was specified in the request packet. Data type: integer.

Supported Operations

209

Response Samples
Removing a preset This request packet removes client preset MyPreset.
<packet version="1.4.2.0"> <desktop> <remove-preset> <filter> <name>MyPreset</name> <type>client</type> </filter> </remove-preset> </desktop> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <remove-preset> <result> <status>ok</status> <id>12</id> </result> </remove-preset> </desktop> </packet>

If the preset was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <desktop> <remove-preset> <result> <status>error</status> <errcode>1013</errcode> <errtext>Desktop preset "MyPreset" of type "client" was not found in repository.</errtext> </result> </remove-preset> </desktop> </packet>

Removing multiple presets This packet removes the presets specified by ID 6 and ID 8.
<packet version="1.4.2.0"> <desktop> <remove-preset> <filter> <id>6</id> <id>8</id> </filter> </remove-preset> </desktop> </packet>

Supported Operations

210

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <desktop> <remove-preset> <result> <status>ok</status> <id>6</id> </result> <result> <status>ok</status> <id>8</id> </result> </remove-preset> </desktop> </packet>

This packet removes administrator presets MyPreset and MyAdminPreset.


<packet version="1.4.2.0"> <desktop> <remove-preset> <filter> <name>MyPreset</name> <type>admin</type> </filter> </remove-preset> <remove-preset> <filter> <name>MyAdminPreset</name> <type>admin</type> </filter> </remove-preset> </desktop> </packet>

If the presets were not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <desktop> <remove-preset> <result> <status>error</status> <errcode>1013</errcode> <errtext>Desktop preset "MyPreset" of type "admin" was not found in repository.</errtext> </result> </remove-preset> <remove-preset> <result> <status>error</status> <errcode>1013</errcode> <errtext>Desktop preset "MyPreset" of type "admin" was not found in repository.</errtext> </result> </remove-preset> </desktop> </packet>

Supported Operations

211

Managing DNS
Operator: <dns> XML Schema: dns_input.xsd, dns_output.xsd Plesk version: all versions API RPC version: all versions Plesk user: Plesk Administrator Description Plesk supports the following functionality: Managing DNS records (see page 216) Managing ACL (see page 234) Managing SOA record and zone parameters (see page 242) Managing name servers (see page 254) Managing local or remote DNS servers (see page 271) Managing recursive requests to DNS servers (see page 283)

Supported Operations

212

Supported operations

ADD_REC (see page 216) adds a DNS record of the specified type to the specified domain zone GET_REC (see page 223) retrieves information about certain DNS records DEL_REC (see page 229) removes the specified DNS record(s) GET_ACL (see page 234) retrieves access control lists (ACL) from the server ADD_TO_ACL (see page 235) adds hosts to ACL REMOVE_FROM_ACL (see page 238) removes hosts from ACL SET (see page 243) updates the SOA record settings for the specified zone or zone template GET (see page 248) retrieves the SOA record settings SWITCH (see page 254) switches the DNS zone type between master and slave ADD_MASTER_SERVER (see page 258) adds a new master DNS server for the specified zone GET_MASTER_SERVER (see page 262) retrieves the master server for the specified zone DEL_MASTER_SERVER (see page 267) removes the master server for the specified zone ENABLE (see page 271) enables the name server for the specified zone

DISABLE (see page 274) disables the name server for the specified domain ENABLE-REMOTE-DNS (see page 277) switches the DNS server to primary mode DISABLE-REMOTE-DNS (see page 279) switches the DNS server to slave mode

Supported Operations

213

GET-STATUS-REMOTE-DNS (see page 281) retrieves the status of the remote DNS server SET-RECURSION (see page 283) sets up preferences of recursive requests to DNS server GET-RECURSION (see page 285) retrieves the recursion preferences DNS server GET-SUPPORTED-RECURSION (see page 287) retrieves the available types of recursion for the DNS server

Filtering Issues
Filtering is the way the request XML packet indicates the object to which the operation will be applied. The request XML packet filters data using a special <filter> section. A single filter can specify multiple DNS records, all specified either by ID, domain ID or host IP address. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule. A packet that retrieving information about the master DNS server for domain with ID 3 can look as follows:
<packet version="1.4.2.0"> <dns> <get_master_server> <filter> <domain_id>3</domain_id> </filter> </get_master_server> </dns> </packet>

The filter-id node is nested in a response packet of the get_master_server operation. It returns the filtering rule parameter. If one of the following values was set as a filter rule parameter, it is returned in the filter-id node of the response packet. Domain ID DNS Record ID Domain alias ID

It is done to trace the request parameters in case of error. Data type: anySimpleType. If the filter node is left blank (<filter/>), the filter-id parameter will hold the ID of the object. The blank filter means that all records are matched by this rule. Note:The <filter-id> node appears in API RPC 1.4.2.0. Earlier versions of the protocol do not support this node.

Supported Operations

214

There are three kinds of filters, specified by different types: aclFilter (see page 214) simpleFilter (see page 214) dnsSelectionFilter (see page 215)

aclFilter
The aclFilter filter is used to retrieve and update Access Control Lists (ACL). For more information, refer to the Retrieving ACL (see page 234), Adding to ACL (see page 235), and Removing From ACL (see page 238) sections. This filter is used in the get_acl, add_to_acl, remove_from_acl operations. Data type:aclFilter (dns_input.xsd). The graphical representation of the filter node is as follows:

The host node is required. It specifies the IP address of a host. Data type: string.

You can match multiple hosts using this filter as in the following example:
<filter> <host>192.168.1.1</host> <host>192.168.7.5</host> </filter>

simpleFilter
The simpleFilter filter is used to match one or more domains or domain aliases by ID. This filter is used in get, set, switch, enable, disable operations. Data type: simpleFilterType (dns_input.xsd).The graphical representation of the filter node is as follows:

The domain_id node is required. It specifies the domain ID in Plesk database. Data type: integer. The domain_alias_id is required. It specifies the domain alias ID in Plesk database. For information on domain aliases, refer to the Managing Domain Aliases (see page 387) section. Data type: integer. This filter parameter is supported starting with API RPC v.1.4.0.0.

Supported Operations

215

Remarks You can match multiple domains using this filter. The combination of two filtering rules in one filter node can look as follows:
<filter> <domain_id>1</domain_id> <domain_id>12</domain_id> </filter>

You can also match multiple domain aliases using this filter. The combination of two filtering rules in one filter node can look as follows:
<filter> <domain_alias_id>1</domain_alias_id> <domain_alias_id>12</domain_alias_id> </filter>

Note: you can use either domain_id, or domain_alias_id when using this filter. The packet that contains both domain_id and domain_alias_id parameters in a single filter node will be considered invalid by Plesk server.

dnsSelectionFilter
The dnsSelectionFilter filter match DNS records by ID, domain ID, or domain alias ID. It is used in get_rec, del_rec, del_master_server, get_master_server operations. Data type: dnsSelectionFilterType (dns_input.xsd). The graphical representation of the filter node is as follows:

The domain_id node is optional. It specifies the domain ID in Plesk database. Data type: integer. The id node is optional. It specifies the DNS record ID in Plesk database. Data type: integer. The domain_alias_id node is optional. It specifies the domain alias ID in Plesk database. For information on domain aliases, refer to the Managing Domain Aliases (see page 387) section. Data type: integer. This filter parameter is supported starting with API RPC v.1.4.0.0.

Remarks You can also match multiple domains, domain aliases, DNS records using this filter. The combination of two filtering rules in one filter node can look as follows:

Supported Operations <filter> <id>1</id> <id>2</id> <id>3</id> </filter>

216

Note: you can use either id, domain_id, or domain_alias_id when using this filter. The packet that contains a combination of id, domain_id, and domain_alias_id parameters in a single filter node will be considered invalid by Plesk server.

Managing DNS Records


In Plesk, DNS resource records include zone template records, and domain or domain alias zone records. Template is a server-level set of rules for zone files of the newly created domains: When a new domain or domain alias is created, Plesk automatically generates zone file for it basing on server templates.

Adding DNS Record


Resource Records define data types in the Domain Name System (DNS). Resource Records identified by RFC 1035 are stored in binary format internally for use by DNS software. But resource records are sent across a network in text format while they perform zone transfers. The following record types are available in Plesk: A (Address). Used for storing an IP address (specifically, an IPv4 32-bit address) associated with a domain name. NS (Authoritative name server). Specifies a host name (which must have an A record associated with it), where DNS information can be found about the domain name to which the NS record is attached. NS records are the basic infrastructure on which DNS is built; they stitch together distributed zone files into a directed graph that can be efficiently searched. Defined in RFC 1035. CNAME (Canonical name for a DNS alias). Note that if a domain name has a CNAME record associated with it, then it can not have any other record types. In addition, CNAME records should not point to domain names which themselves have associated CNAME records, so CNAME only provides one layer of indirection. MX (Mail Exchanger). Each MX record specifies a domain name (which must have an A record associated with it) and a priority; a list of mail exchangers is then ordered by priority when delivering mail. MX records provide one level of indirection in mapping the domain part of an email address to a list of host names which are meant to receive mail for that domain name. Critical part of the infrastructure used to support SMTP email. PTR (Domain name pointer). Provides a general indirection facility for DNS records. Most often used to provide a way to associate a domain name with an IPv4 address in the IN-ADDR.ARPA domain. TXT (Text string). Arbitrary binary data, up to 255 bytes in length. AXFR (Asynchronous Full Transfer Zone).

Supported Operations

217

SRV (service) records are a generalization and expansion of features provided by MX records. Where MX records work only for mail delivery and provide "failover" via the Priority value, SRV records add in support for load balancing (via the Weight value) and port selection (via the Port value). This type of records is available only n Plesk for Windows via API RPC v.1.5.0.0 and later.

Note: You can add a DNS record for the specified domain or to the DNS zone template. On creation of a new domain, Plesk automatically generates zone file for the domain or domain alias basing on the server template.

Request Packet Structure A request XML packet adding a new DNS record to Plesk database includes the add_rec operation node:
<packet version="1.4.2.0"> <dns> <add_rec> </add_rec> </dns> </packet>

The add_rec node is presented by the dnsRecord type (plesk_dns.xsd). Its graphical representation is as follows:

The domain_id node is optional. If specified, the DNS record will be added to DNS records for the domain with the corresponding ID. Data type: integer. The domain_alias_id node is optional. If specified, the DNS record will be added to DNS records for the domain alias with the corresponding ID. The support of this node has started since 1.4.0.0 version of the API RPC protocol. Data type: integer. The type node is required. It specifies the type of the DNS record. For more information about DNS types, refer to the Adding a DNS Record (see page 216) section. Data type: string. Allowed values: A | NS | CNAME | MX | PTR | TXT | SOA | AXFR | SRV

Supported Operations

218

The host node is required. It specifies the IP address or name of a host that will be used by DNS. Data type: string. The value node is required. It specifies the value that will be linked with the host value. Data type: string. The opt node is optional. It holds optional information about the DNS record. Data type: string.

Note: If the domain_id and domain_alias_id parameters are omitted, the DNS record will be added to the DNS zone template. You can add multiple DNS records using a single packet. Add as many <add-rec> operations as the number of DNS records you want to add.
<dns> <add_rec> </add_rec> ... <add_rec> </add_rec> </dns>

Note: In case of SRV record, the host node stands for Target host, the value stands for Service name. The opt node can contain additional XML code in the following format:<Srv Protocol="" Port="" Priority="" Weight=""/>.

Request Samples Adding a single DNS record This packet adds an NS record which makes ns.example.com. the nameserver for the host example.com. (domain ID of example.com is 1).
<packet version="1.5.1.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>NS</type> <host/> <value>ns.example.com.</value> </add_rec> </dns> </packet>

This packet links domain mail.example.com. (domain ID of example.com is 1) to IP address 192.0.2.12.


<packet version="1.5.1.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>A</type> <host>mail</host> <value>192.0.2.12</value>

Supported Operations </add_rec> </dns> </packet>

219

This packet sets example.com. as the canonical name for domain ftp.example.com. (domain ID of example.com is 1).
<packet version="1.5.1.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>CNAME</type> <host>ftp</host> <value>example.com.</value> </add_rec> </dns> </packet>

This packet adds an MX DNS record which makes mailex.example.net. the main mail server for domain mail-exchange.example.com. (domain ID of example.com. is 1).
<packet version="1.5.1.0"> <dns> <add_rec> <type>MX</type> <host>mail-exchange</host> <value>mailex.example.net</value> <opt>0</opt> </add_rec> </dns> </packet>

This packet adds a PTR DNS record which makes domain community.example.com. the domain name pointer for the subnet 192.0.2.0/24 (domain ID of example.com. is 1).
<packet version="1.5.1.0"> <dns> <add_rec> <type>PTR</type> <host>192.0.2.0</host> <value>community</value> <opt>24</opt> </add_rec> </dns> </packet>

This packet adds a textual description to the domain about.example.com. (domain ID of example.com. is 1).
<packet version="1.5.1.0"> <dns>

Supported Operations <add_rec> <type>TXT</type> <host>about</host> <value>The best place to improve your experiences.</value> </add_rec> </dns> </packet>

220

This packet adds an SRV record for LDAP service on host 192.0.2.4.
<packet version="1.5.1.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>SRV</type> <host>192.0.2.4</host> <value>_ldap</value> <opt>&lt;Srv Protocol="_tcp" Port="115" Priority="0" Weight="10"/&gt;</opt> </add_rec> </dns> </packet>

This packet adds to the server DNS template an MX record.


<packet version="1.5.1.0"> <dns> <add_rec> <type>MX</type> <host/> <value>mymail.&lt;domain&gt;</value> <opt>25</opt> </add_rec> </dns> </packet>

Adding multiple DNS records This packet adds A and MX DNS records to DNS zone template.
<packet version="1.5.1.0"> <dns> <add_rec> <type>MX</type> <host/> <value>mymail.&lt;domain&gt;</value> <opt>25</opt> </add_rec> <add_rec> <type>A</type> <host>newsome</host> <value>&lt;ip&gt;</value> </add_rec> </dns> </packet>

Supported Operations

221

Response Packet Structure The add_rec node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the add_rec operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the add_rec operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the add_rec operation fails. Data type: string. The id node is optional. It returns the ID of the DNS record; it is required if the add_rec operation has succeeded. Returns the unique identifier of the DNS record just added to Plesk. Data type: integer.

Response Samples Adding a single DNS record This request packet adds an NS record.
<packet version="1.4.2.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>NS</type> <host>Mydomain.com.</host> <value>ns.Mydomain.com.</value> </add_rec> </dns> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_rec> <result>

Supported Operations <status>ok</status> <id>17</id> </result></add_rec> </dns> </packet>

222

If the domain ID was not found on the server, negative response from the server looks as follows:
<packet version="1.4.2.0"> <dns> <add_rec> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> </result> </add_rec> </dns> </packet>

Adding multiple DNS records This request packet adds A DNS record to DNS zone template and MX record to domain with ID 1.
<packet version="1.4.2.0"> <dns> <add_rec> <domain_id>1</domain_id> <type>NS</type> <host>Mydomain.com.</host> <value>ns.Mydomain.com. </vale> </add_rec> <add_rec> <type>A</type> <host>mail.&lt;domain&gt;.</host> <value> &lt;ip&gt;</value> </add_rec> </dns> </packet>

A possible response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_rec> <result> <status>ok</status> <id>10</id> </result> </add_rec> <add_rec> <result>

Supported Operations <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> </result> </add_rec> </dns> </packet>

223

Retrieving DNS Records


Both zone template records and domain or domain alias zone records can be retrieved using the get_rec operation. You can retrieve multiple records in a single get_rec operation using filtering rules. For more information about filters, refer to the Filtering Issues (see page 213) section. Request Packet Structure A request XML packet retrieving a DNS record from Plesk database includes the get_rec operation node:
<packet version="1.4.2.0"> <dns> <get_rec> </get_rec> </dns> </packet>

The graphical representation of the get_rec node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType(dns_input.xsd). The template node is optional. If present, only DNS zone template records are available for retrieving. In this case domain_id or domain_alias_id cannot be specified as a filtering rule. Data type: none.

Note: If you leave the filter node blank (<filter/>), all resource records (zone template records or zone records depending on presence of the template node in the request packet) will be retrieved. You can retrieve multiple DNS records in a single packet. Add as many get_rec operations as the number of different filtering rules.
<dns> <get_rec> </get_rec>

Supported Operations ... <get_rec> </get_rec> </dns>

224

Request Samples Retrieving a single DNS record This packet retrieves information on the DNS record with ID 8.
<packet version="1.4.2.0"> <dns> <get_rec> <filter> <id>8</id> </filter> </get_rec> </dns> </packet>

Retrieving multiple DNS records This packet retrieves zone parameters of the domain with ID 15.
<packet version="1.4.2.0"> <dns> <get_rec> <filter> <domain_id>8</domain_id> </filter> </get_rec> </dns> </packet>

This packet retrieves zone parameters of the domain alias with ID 1.


<packet version="1.4.2.0"> <dns> <get_rec> <filter> <domain_alias_id>1</domain_alias_id> </filter> </get_rec> </dns> </packet>

This packet retrieves zone parameters of the domain alias with ID 1 and the domain with ID 7.
<packet version="1.4.2.0"> <dns> <get_rec> <filter> <domain_alias_id>1</domain_alias_id>

Supported Operations </filter> </get_rec> <get_rec> <filter> <domain_id>7</domain_id> </filter> </get_rec> </dns> </packet>

225

This packet retrieves zone parameters all domains and domain aliases on the server.
<packet version="1.4.2.0"> <dns> <get_rec> <filter/> </get_rec> </dns> </packet>

This packet retrieves all DNS zone template records.


<packet version="1.4.2.0"> <dns> <get_rec> <filter/> <templates/> </get_rec> </dns> </packet>

Response Packet Structure The get_rec node of the output XML packet is structured as follows:

The result node is optional. It is required if the operation get_rec succeeds, and the data set retrieved from the server is not empty. Data type: resultType (common.xsd).

Supported Operations

226

The status node is required. It specifies the execution status of the get_rec operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get_rec operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the get_rec operation fails. Data type: string. The id node is required if the get_rec operation has succeeded. Returns the unique identifier of the DNS record. Data type: integer. The data node is optional. It is required if the get_rec operation has succeeded. Data type: dnsRecord (dns_input.xsd). The node is structured as follows:

The domain_id node is optional. If specified, the DNS record is retrieved from zone parameters for the domain with the corresponding ID. Data type: integer. The domain_alias_id node is optional. If specified, the DNS record is retrieved from zone parameters for the domain alias with the corresponding ID. The support of this node has started since 1.4.0.0 version of the API RPC protocol. Data type: integer. The type node is optional. It is required if the operation succeeded. It specifies the type of the DNS record. For more information about DNS types, please visit the Adding a DNS Record (see page 216) section. Data type: string. Allowed values: A | NS | CNAME | MX | PTR | TXT | SOA | AXFR | SRV The host node is optional. It is required if the operation succeeded. It specifies the IP address or name of a host, that will be used by DNS. Data type: string. The value node is optional. It is required if the operation succeeded. It specifies the value that will be linked with the host value. Data type: string. The opt node is optional. It holds optional information about the DNS record. Data type: string.

Supported Operations

227

Response Samples Retrieving a single DNS record This request packet retrieves the DNS record with ID 8.
<packet version="1.4.2.0"> <dns> <get_rec> <filter> <id>8</id> </filter> </get_rec> </dns> </packet>

If the DNS record with ID 8 was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <dns> <get_rec> </get_rec> </dns> </packet>

If the DNS record with ID 8 was found on the server, the response can look as follows:
<packet version="1.4.2.0"> <dns> <get_rec> <result> <status>ok</status> <id>8</id> <data> <domain_id>8</domain_id> <type>NS</type> <host>Mydomain.com.</host> <value>ns.Mydomain.com.</value> <opt></opt> </data> </result> </get_rec> </dns> </packet>

Retrieving multiple DNS records This request packet retrieves zone preferences of the domain with ID 8.
<packet version="1.4.2.0"> <dns> <get_rec> <filter> <domain_id>8</domain_id> </filter> </get_rec>

Supported Operations </dns> </packet>

228

If the domain with ID 8 was not found on the server, the response from the server looks as follows:
<packet version="1.4.2.0"> <dns> <get_rec> </get_rec> </dns> </packet>

If the domain with ID 8 was found on the server, a response from the server can look as follows:
<packet version="1.4.2.0"> <dns> <get_rec> <result> <status>ok</status> <id>18</id> <data> <domain_id>8</domain_id> <type>NS</type> <host>Mydomain.com</host> <value>ns.Mydomain.com. </value> <opt></opt> </data> </result> <get_rec> <result> <status>ok</status> <id>19</id> <data> <domain_id>8</domain_id> <type>PTR</type> <host></host> <value>Mydomain.com</value> <opt></opt> </data> </result> </get_rec> </dns> </packet>

Supported Operations

229

Deleting DNS Records


Both zone template records and domain or domain alias zone records can be deleted using the del_rec operation. You can retrieve multiple records in a single del_rec operation using filtering rules. For more information about filters, refer to the Filtering Issues (see page 213) section. Request Packet Structure A request XML packet deleting a DNS record from Plesk database includes the get_rec operation node:
<packet version="1.4.2.0"> <dns> <del_rec> </del_rec> </dns> </packet>

The graphical representation of the del_rec node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType(dns_input.xsd). The template node is optional. If present, only DNS zone template records are available for deleting. In this case domain_id or domain_alias_id cannot be specified as a filtering rule. Data type: none.

Note: If you leave the filter node blank (<filter/>) all records (zone template records or zone records, depending on presence of the template node in the request packet) will be removed. You can delete multiple DNS records in a single packet. Add as many del_rec operations as the number of different filtering rules.
<dns> <del_rec> </del_rec> ... <del_rec> </del_rec> </dns>

Supported Operations

230

Request Samples Deleting a single DNS record This request packet deletes DNS record with ID 75
<packet version="1.4.2.0"> <dns> <del_rec> <filter> <id>75</id> </filter> </del_rec> </dns> </packet>

Deleting multiple DNS records This request packet deletes DNS records from the zone of domain with ID 7.
<packet version="1.4.2.0"> <dns> <del_rec> <filter> <domain_id>7</domain_id> </filter> </del_rec> </dns> </packet>

This request packet deletes DNS records from zones of the domains with ID 7 and 8.
<packet version="1.4.2.0"> <dns> <del_rec> <filter> <domain_id>7</domain_id> <domain_id>8</domain_id> </filter> </del_rec> </dns> </packet>

This request packet deletes DNS records from the zone of the domain with ID 7, and the record with ID 5.
<packet version="1.4.2.0"> <dns> <del_rec> <filter> <domain_id>7</domain_id> </filter> </del_rec> <del_rec> <filter>

Supported Operations <id>5</id> </filter> </del_rec> </dns> </packet>

231

This request packet deletes DNS records from zone files of all domain aliases and domains.
<packet version="1.4.2.0"> <dns> <del_rec> <filter/> </del_rec> </dns> </packet>

This request packet deletes all DNS records from the server template.
<packet version="1.4.2.0"> <dns> <del_rec> <filter/> <template/> </del_rec> </dns> </packet>

Response Packet Structure The del_rec node of the output XML packet is structured as follows:

The result node is optional. It is required if the operation del_rec succeeds and the data set retrieved from the server is not empty. If the id was set as a filtering rule in the request packet, the result node is also required. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the del_rec operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the del_rec operation fails. Data type: unsignedInt.

Supported Operations

232

The errtext node is optional. It is used to return the error message if the del_rec operation fails. Data type: string. The id node is required if the del_rec operation has succeeded. If the id was set as a filtering rule in the request packet, the id node is also required. Returns the unique identifier of the DNS record. Data type: integer.

Response Samples Deleting a single DNS record This request packet deletes DNS record with ID 75.
<packet version="1.4.2.0"> <dns> <del_rec> <filter> <id>75</id> </filter> </del_rec> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <del_rec> <result> <status>ok</status> <id>75</id> </result> </del_rec> </dns> </packet>

If the DNS record with ID 75 was not found on the server, the response from the server looks as follows:
<packet version="1.4.2.0"> <dns> <del_rec> <result> <status>error</status> <errcode>1013</errcode> <errtext>DNS record does not exist.</errtext> <id>75</id> </result> </del_rec> </dns> </packet>

Supported Operations

233

Deleting multiple DNS records

This request packet deletes DNS records for the domain ID 7 and the record with ID 5.

<packet version="1.4.2.0"> <dns> <del_rec> <filter> <domain_id>7</domain_id> </filter> </del_rec> <del_rec> <filter> <id>5</id> </filter> </del_rec> </dns> </packet>

] Three DNS records for the domain alias were deleted. The record with ID 5 was not found on the server. A response packet can look as follows:

<packet version="1.4.2.0"> <dns> <del_rec> <result> <status>ok</status> <id>17</id> </result> <result> <status>ok</status> <id>18</id> </result> <result> <status>ok</status> <id>19</id> </result> </del_rec> <del_rec/> </dns> </packet>

Supported Operations

234

Managing ACL
The Access Control List (ACL) is a concept in computer security used to enforce privilege separation. You can define the hosts which can perform operations on your name server.

Retrieving ACL
To retrieve the ACL of your name server, use the get_acl operation. The get_acl operation in a request packet has the following graphics presentation:

Data type: none. Request packet sample


<packet version="1.4.2.0"> <dns> <get_acl/> </dns> </packet>

Response Packet Structure The get_acl operation in a response packet has the following graphics presentation:

The result node is optional. It is required in case when the get_acl operation has succeeded, or when an error (if it occurred) was not of a system type. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get_acl operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get_acl operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the get_acl operation fails. Data type: string.

Supported Operations

235

The host node is optional. It is required if the del_acl operation has succeeded. Returns the IP address or name of hosts from ACL. Data type: string.

Response Samples A response packet can look as follows:


<packet version="1.4.2.0"> <dns> <get_acl> <result> <status>ok</status> <host>127.0.0.1</host> </result> <result> <status>ok</status> <host>127.0.0.2</host> </result> </get_acl> </dns> </packet>

If the ACL list is empty, the response packet looks as follows:


<packet version="1.4.2.0"> <dns> <get_acl> <result> <status>ok</status> </result> </get_acl> </dns> </packet>

Adding Hosts to ACL


To add a new host to the ACL of your name server, use the add_to_acl operation. You can add multiple hosts to ACL using a single packet. Request Packet Structure A request XML packet adding a new host to the ACL includes the add_to_acl operation node:
<packet version="1.4.2.0"> <dns> <add_to_acl> </add_to_acl> </dns> </packet>

The graphical representation of the add_to_acl node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 214) section. Data type: aclFilter (dns_input.xsd).

Supported Operations

236

You can add multiple hosts to the ACL in a single packet using filters. Add as many host parameters to the filter node as the number of hosts you want to add to the ACL. Request Samples This packet adds host 192.168.34.56 to the ACL.
<packet version="1.4.2.0"> <dns> <add_to_acl> <filter> <host>192.168.34.56</host> </filter> </add_to_acl> </dns> </packet>

This packet adds hosts 192.168.34.56 and 12.16.34.56 to the ACL.


<packet version="1.4.2.0"> <dns> <add_to_acl> <filter> <host>192.168.34.56</host> <host>12.16.34.56</host> </filter> </add_to_acl> </dns> </packet>

Response Packet Structure The add_to_acl node of the output XML packet is structured as follows:

The result node is optional. It is required in case when an error (if it occurred) was not of a system type. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get_acl operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get_acl operation fails. Data type: unsignedInt.

Supported Operations

237

The errtext node is optional. It is used to return the error message if the get_acl operation fails. Data type: string. The host node is optional. It is required in case when an error (if it occurred) was not of a common type. Returns the IP address or name of hosts from the ACL. Data type: string.

Response Samples Adding a single host to ACL This request packet adds host 192.168.34.56 to the ACL.
<packet version="1.4.2.0"> <dns> <add_to_acl> <filter> <host>192.168.34.56</host> </filter> </add_to_acl> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <add_to_acl> <result> <status>ok</status> <host>192.168.34.56</host> </result> </add_to_acl> </dns> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_to_acl> <result> <status>error</status> <errcode>1007</errcode> <errtext>IP address 127.0.0.1 already exists.</errtext> </result> </add_to_acl> </dns> </packet>

Adding a single host to ACL This request packet adds host 192.168.34.56 to the ACL two times.
<packet version="1.4.2.0"> <dns> <add_to_acl> <filter> <host>192.168.34.56</host> </filter>

Supported Operations </add_to_acl> <add_to_acl> <filter> <host>192.168.34.56</host> </filter> </add_to_acl> </dns> </packet>

238

A response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_to_acl> <result> <status>ok</status> <host>192.168.34.56</host> </result> </add_to_acl> <add_to_acl> <result> <status>error</status> <errcode>1007</errcode> <errtext>IP address 192.168.34.56 already exists.</errtext> </result> </add_to_acl> </dns> </packet>

Removing Host From ACL


To remove a host from the ACL of your name server, use the remove_from_acl operation. You can remove multiple hosts from the ACL using a single packet. Request Packet Structure A request XML packet removing a host from the ACL includes the remove_from_acl operation node:
<packet version="1.4.2.0"> <dns> <remove_from_acl> </remove_from_acl> </dns> </packet>

The graphical representation of the remove_from_acl node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 214) section. Data type: aclFilter (dns_input.xsd).

Supported Operations

239

You can remove multiple hosts from the ACL in a single packet using filters. Add as many host parameters to the filter node as the number of hosts you want to remove from ACL. Request Samples This packet removes host 192.168.34.56 from the ACL.
<packet version="1.4.2.0"> <dns> <remove_from_acl> <filter> <host>192.168.34.56</host> </filter> </remove_from_acl> </dns> </packet>

This packet removes hosts 192.168.34.56 and 12.16.34.56 from the ACL.
<packet version="1.4.2.0"> <dns> <remove_from_acl> <filter> <host>192.168.34.56</host> <host>12.16.34.56</host> </filter> </remove_from_acl> </dns> </packet>

Response Packet Structure The remove_from_acl node of the output XML packet is structured as follows:

The result node is optional. It is required in case when an error (if it occurred) was not of a common type. For more information about common errors, refer to the Common Errors (see page 992) section. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the remove_from_acl operation. Data type: string. Allowed values: ok | error.

Supported Operations

240

The errcode node is optional. It is used to return the error code when the remove_from_acl operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the remove_from_acl operation fails. Data type: string. The host node is optional. It is required in case an error (if it was) was not of a common type. Returns the IP address or name of hosts from the ACL. Data type: string.

Response Samples Removing a single host to ACL This request packet removes host 192.168.34.56 from the ACL.
<packet version="1.4.2.0"> <dns> <remove_from_acl> <filter> <host>192.168.34.56</host> </filter> </remove_from_acl> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <remove_from_acl> <result> <status>ok</status> <host>192.168.34.56</host> </result> </remove_from_acl> </dns> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <remove_from_acl> <result> <status>error</status> <errcode>1007</errcode> <errtext>IP address 192.168.34.56 does not exists.</errtext> </result> </remove_from_acl> </dns> </packet>

Supported Operations

241

Removing a single host to ACL This request packet adds host 192.168.34.56 to the ACL two times.
<packet version="1.4.2.0"> <dns> <remove_from_acl> <filter> <host>192.168.34.56</host> </filter> </remove_from_acl> <remove_from_acl> <filter> <host>192.168.34.56</host> </filter> </remove_from_acl> </dns> </packet>

A response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <remove_from_acl> <result> <status>ok</status> <host>192.168.34.56</host> </result> </remove_from_acl> <remove_from_acl> <result> <status>error</status> <errcode>1007</errcode> <errtext>IP address 192.168.34.56 already exists.</errtext> </result> </remove_from_acl> </dns> </packet>

Supported Operations

242

Managing SOA Records and Zone Parameters


The first resource record in any Domain Name System (DNS) Zone file should be a Start of Authority (SOA) resource record. The SOA resource record indicates that this DNS name server is the best source of information for the data within this DNS domain. The zone status is the status of DNS service for the specified zone. If you do not specify the zone, the status of the local DNS server is returned.

SOA Parameters
The soa node is presented by type SOAType (plesk_dns.xsd). This type has the following graphics representation:

The ttl node is optional. This is the amount of time (in seconds) that slave DNS servers should store the record in a cache. Plesk sets the default value of one day. Data type: unsignedInt. The refresh node is optional. This is how often (in seconds) the slave name servers check with the primary name server to see if any changes have been made to the domain's zone file. Plesk sets the default value of three hours. RFC 1912 recommends to vary this parameter from 1200 to 43200. Use the 1200 value if your data is volatile and 43200 if not. Data type: integer. Data type: unsignedInt. The retry node is optional. This is the time (in seconds) a slave (secondary) DNS server waits before retrying a failed zone transfer. This time is typically less than the refresh interval. Typical values vary from 180 (three minutes) to 900(15 minutes). Plesk sets the default value of one hour. Data type: unsignedInt. The expire node is optional. Signed 32-bit value in seconds. Indicates when the zone data is no longer authoritative. Applies to Slaves or Secondaries servers only. BIND9 slaves stop responding to queries for the zone when this time has expired and no contact has been made with the master. Thus when the ref values expires the slave will attempt to read the SOA record for the zone - and request a zone transfer AXFR/ IXFR if the sn has changed. If contact is made the expiry and refresh values are reset and the cycle starts again. If the slave fails to contact the master, it will retry every retry period but continue to supply authoritative data for the zone until the expiry value is reached, at which point it will stop answering queries for the domain. RFC 1912 recommends 1209600 to 2419200 seconds (2-4 weeks) to allow for major outages of the master. Plesk sets the default value of one week. Data type: unsignedInt.

Supported Operations

243

The minimum node is optional. This is the time (in seconds) during which a secondary server should cache a negative response. The maximum value allowed by BIND 9 for this parameter is 3 hours (10800 seconds). Plesk sets the default value of three hours. Data type: unsignedInt.

Updating SOA Record


Use the set operation to update a SOA record for the DNS zone template, or for the domain (domain alias) specified by ID. The parameters in the SOA record of the zone template will be applied to a new domain or domain alias on creation. You can update multiple SOA records in a single packet. For more information about SOA records, refer to the SOA preferences (see page 242) section. Note: The set operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet updating a SOA record includes the set operation node:
<packet version="1.4.2.0"> <dns> <set> </set> </dns> </packet>

The graphical representation of the set node is as follows:

The filter node is optional. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 214) section. Data type: simpleFilterType (dns_input.xsd). The soa node is required. Specifies the SOA parameters. Data type: SOAType (plesk_dns.xsd).

Note: If you omit the filter node, the operation will update SOA parameters for the DNS zone template. You can update multiple SOA records in a single packet. Add as many set operations as the number of different filtering rules.
<dns> <set> </set> ... <set> </set> </dns>

Supported Operations

244

Request Samples Updating a single SOA record This packet updates a SOA record of the domain with ID 12.
<packet version="1.4.2.0"> <dns> <set> <filter> <domain_id>12</domain_id> </filter> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> </set> </dns> </packet>

This packet updates a SOA record of the DNS zone template.


<packet version="1.4.2.0"> <dns> <set> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> </set> </dns> </packet>

Updating multiple SOA records This packet updates SOA records of the domains with ID 12 and 13.
<packet version="1.4.2.0"> <dns> <set> <filter> <domain_id>12</domain_id> <domain_id>13</domain_id> </filter> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa>

Supported Operations </set> </dns> </packet>

245

This packet updates SOA records of the domains with ID 5 and ID 7 and the server template SOA record.
<packet version="1.4.2.0"> <dns> <set> <filter> <domain_id>5</domain_id> </filter> <soa> <ttl>8640</ttl> <refresh>1080</refresh> <retry>3600</retry> <expire>60480</expire> <minimum>1080</minimum> </soa> </set> <set> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> </set> </dns> </packet>

Response Packet Structure The set node of the output XML packet is structured as follows:

The result node is optional. It is required in case when an error (if it occurred) was not of a system type. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the set operation. Data type: string. Allowed values: ok | error.

Supported Operations

246

The errcode node is optional. It is used to return the error code when the set operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the set operation fails. Data type: string. The domain_id node is optional. It is required if the domain ID was set as a filtering rule in the request packet. Data type: integer. The domain_alias_id node is optional. It is required if the domain alias ID was set as a filtering rule in the request packet. Data type: integer.

Response Samples Updating a single SOA record This request packet updates a SOA record of the domain with ID 12.
<packet version="1.4.2.0"> <dns> <set> <filter> <domain_id>12</domain_id> </filter> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> </set> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <set> <result> <status>ok</status> <domain_id>12</domain_id> </result> </set> </dns> </packet>

If the domain with ID 12 was not found on the server, the negative response looks as follows:
<packet version="1.4.2.0"> <dns> <set> <result> <status>error</status> <errcode>1015</errcode>

Supported Operations <errtext>Domain does not exist</errtext> <domain_id>12</domain_id> </result> </set> </dns> </packet>

247

Updating multiple SOA records This request packet updates SOA records of the domains with ID 12 and ID 13.
<packet version="1.4.2.0"> <dns> <set> <filter> <domain_id>12</domain_id> <domain_id>13</domain_id> </filter> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> </set> </dns> </packet>

If the domain with ID 13 was not found on the server, and the domain with ID 12 was updated, the response packet looks as follows:
<packet version="1.4.2.0"> <dns> <set> <result> <status>ok</status> <domain_id>12</domain_id> </result> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain alias does not exist.</errtext> <domain_id>13</domain_id> </result> </set> </dns> </packet>

Supported Operations

248

Retrieving Parameters of SOA Record and Zone


Use the get operation to perform the following: retrieve SOA record, zone type, zone status of the zone specified by domain or domain alias ID retrieve SOA record, zone status of the server template

Local DNS server can be enabled (see page 271) or disabled (see page 274) for the specified zone. When it is enabled, it can act as a "primary" or "slave" name server. If you want to change the type of zone, please refer to the Switching Name Server Mode (see page 254) section. Note: The support of the get operation is started since 1.4.0.0 version of API RPC protocol. Request Packet Structure A request XML packet retrieving a SOA record includes the get operation node:
<packet version="1.4.2.0"> <dns> <get> </get> </dns> </packet>

The graphical representation of the get node is as follows:

The filter node is optional. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 214) section. Data type: simpleFilterType (dns_input.xsd). The soa node is required. If specified, the SOA parameters will be returned in the response packet. Data type: none.

The following table shows the response parameters, if either filter or soa node is omitted.
SOA present Filter present SOA record, zone type, zone status of a domain or alias Filter omitted zone status, SOA record of the server template SOA omitted zone type, zone status of a domain or domain alias

Supported Operations

249

You can retrieve the parameters of multiple domains or domain aliases in a single packet. Add as many get operations as the number of different filtering rules.
<dns> <get> </get> ... <get> </get> </dns>

Request Samples This packet retrieves a zone type and zone status of the domain with ID 1.
<packet version="1.4.2.0"> <dns> <get> <filter> <domain_id>1</domain_id> </filter> </get> </dns> </packet>

This packet retrieves the SOA record, zone type, and zone status of the domain with ID 1.
<packet version="1.4.2.0"> <dns> <get> <filter> <domain_id>1</domain_id> </filter> <soa/> </get> </dns> </packet>

This packet retrieves the SOA record of the server template and the status of the DNS server.
<packet version="1.4.2.0"> <dns> <get> <soa/> </get> </dns> </packet>

Supported Operations

250

This packet retrieves the following parameters: the SOA record of the server template the status of the DNS server a zone type of the domain with ID 1 a zone status of the domain with ID 1

<packet version="1.4.2.0"> <dns> <get> <soa/> </get> <get> <filter> <domain_id>1</domain_id> </filter> </get> </dns> </packet>

Response Packet Structure The set node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get operation fails. Data type: unsignedInt.

Supported Operations

251

The errtext node is optional. It is used to return the error message if the set operation fails. Data type: string. The domain_id node is optional. It is required if the domain ID was set as a filtering rule in the request packet. Data type: integer. The domain_alias_id node is optional. It is required if the domain alias ID was set as a filtering rule in the request packet. Data type: integer. The soa node is optional. It is required if the soa node was specified in the request packet. Data type: SOAType (plesk_dns.xsd). The zone_type is optional. It is required if the filter node was specified in the request packet. Specifies the type of the DNS name server. Data type: string. Allowed values: master | slave. The zone_status is optional. It is required if the get operation succeeds. Specifies the status of the local DNS name server. Data type: string. Allowed values: enabled | disabled.

Response Samples This request packet retrieves the zone type and zone status of the domain with ID 1.
<packet version="1.4.2.0"> <dns> <get> <filter> <domain_id>1</domain_id> </filter> </get> </dns> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get> <result> <status>ok</status> <domain_id>1</domain_id> <zone_type>master</zone_type> <zone_status>enabled</zone_status> </result> </get> </dns> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext>

Supported Operations <domain_id>1</domain_id> </result> </get> </dns>

252

This request packet retrieves the SOA record, zone type, and zone status of the domain with ID 1.
<packet version="1.4.2.0"> <dns> <get> <filter> <domain_id>1</domain_id> </filter> <soa/> </get> </dns> </packet>

A possible response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get> <result> <status>ok</status> <domain_id>1</domain_id> <soa> <ttl>86400</ttl> <refresh>10800</refresh> <retry>3600</retry> <expire>604800</expire> <minimum>10800</minimum> </soa> <zone_type>master</zone_type> <zone_status>enabled</zone_status> </result> </get> </dns> </packet>

This request packet retrieves a zone type, and zone status of the domain with ID 2 and domain alias with ID 1.
<packet version="1.4.2.0"> <dns> <get> <filter> <domain_alias_id>1</domain_alias_id> </filter> </get> <get> <filter> <domain_id>2</domain_id> </filter> </get> </dns> </packet>

Supported Operations

253

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <get> <result> <status>ok</status> <domain__alias_id>1</domain_alias_id> <zone_type>master</zone_type> <zone_status>enabled</zone_status> </result> </get> <get> <result> <status>ok</status> <domain_id>2</domain_id> <zone_type>master</zone_type> <zone_status>enabled</zone_status> </result> </get> </dns> </packet>

Supported Operations

254

Managing Name Servers


Name servers are defined by domain or domain alias ID. They can be primary or secondary for the zone they manage. Secondary name servers are used when you turn the primary name server to slave mode.

Switching Name Server Mode


To switch a name server between master and slave mode, use the switch operation. You can switch multiple name servers in a single packet. To retrieve the zone type, refer to the Retrieving Parameters of SOA Record and Zone (see page 248) section. Note: The switch operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet changing name server mode includes the switch operation node:
<packet version="1.4.2.0"> <dns> <switch> </switch> </dns> </packet>

The graphical representation of the switch node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 214) section. Data type: simpleFilterType (dns_input.xsd). The zone_type node is required. Specifies the zone parameters. Data type: string. Allowed values: master | slave.

You can change mode of multiple name servers in a single packet. Add as many switch operations as the number of different filtering rules, you use to change the mode of name servers you need.
<dns> <switch> </switch> ... <switch> </switch> </dns>

Supported Operations

255

Request Samples Changing status of a single name server This packet makes the name server for the zone specified by domain ID 1 act as a secondary.
<packet version="1.4.2.0"> <dns> <switch> <filter> <domain_id>1</domain_id> </filter> <zone_type>slave</zone_type> </switch> </dns> </packet>

Changing status of multiple name servers This packet makes the name server for the zones specified by domains ID 1 and ID 2 act as a secondary.
<packet version="1.4.2.0"> <dns> <switch> <filter> <domain_id>1</domain_id> <domain_id>2</domain_id> </filter> <zone_type>slave</zone_type> </switch> </dns> </packet>

This packet performs the following: makes the name server for the zone specified by domain ID 1 act as a primary name server makes the name server for the zone specified by domain ID 2 act as secondary name server

<packet version="1.4.2.0"> <dns> <switch> <filter> <domain_id>1</domain_id> </filter> <zone_type>master</zone_type> </switch> <switch> <filter> <domain_id>2</domain_id> </filter> <zone_type>slave</zone_type> </switch> </dns> </packet>

Supported Operations

256

Response Packet Structure The switch node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the switch operation fails. Data type: unsignedInt The errtext node is optional. It is used to return the error message if the switch operation fails. Data type: string. The domain_id node is optional. It is required if the domain ID was set as a filtering rule in the request packet. Data type: integer. The domain_alias_id node is optional. It is required if the domain alias ID was set as a filtering rule in the request packet. Data type: integer.

Response Samples Changing status of a single name server This request packet makes the DNS server act as a secondary for the zone specified by domain ID 1.
<packet version="1.4.2.0"> <dns> <switch> <filter> <domain_id>1</domain_id> </filter> <zone_type>slave</zone_type> </switch> </dns> </packet>

Supported Operations

257

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <switch> <result> <status>ok</status> <domain_id>1</domain_id> </result> </switch> </dns> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <switch> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> <domain_id>1</domain_id> </result> </switch> </dns> </packet>

Changing status of multiple name servers This packet makes the DNS server act as a secondary for the zones specified by domains ID 1 and ID 2.
<packet version="1.4.2.0"> <dns> <switch> <filter> <domain_id>1</domain_id> <domain_id>2</domain_id> </filter> <zone_type>slave</zone_type> </switch> </dns> </packet>

A response packet from the server can look as follows:


<packet version="1.4.2.0"> <dns> <switch> <result> <status>ok</status> <domain_id>1</domain_id> </result> <result>

Supported Operations <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> <domain_id>2</domain_id> </result> </switch> </dns> </packet>

258

Adding Primary Name Server


Use the add_master_server operation to add a primary name server. This server will be primary for the zone specified by the domain ID or domain alias ID. You can add multiple primary servers in a single packet. Note: The add_master_server operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet adding a primary name server includes the add_master_server operation node:
<packet version="1.4.2.0"> <dns> <add_master_server> </add_master_server> </dns> </packet>

The graphical representation of the add_master_server node is as follows:

The domain_id node is required. Specifies the ID of the domain, which zone will be served by the primary name server. Data type: integer. The domain_alias_id node is required. Specifies the ID of the domain alias, which zone will be served by the primary name server. Data type: integer. The ip_address node is required. Specifies the IP address of a primary name server. Data type: integer.

You can add multiple primary name servers in a single packet. Add as many add_master_server operations as the number of different servers you want to add.
<dns> <add_master_server> </add_master_server>

Supported Operations ... <add_master_server> </add_master_server> </dns>

259

Request Samples Adding a single primary name server This packet adds a primary name server to the zone of the domain with ID 5.
<packet version="1.4.2.0"> <dns> <add_master_server> <domain_id>5</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> </dns> </packet>

Adding multiple primary name servers This packet adds a primary name server to the zone of the domain with ID 5 and ID 7.
<packet version="1.4.2.0"> <dns> <add_master_server> <domain_id>5</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> <add_master_server> <domain_id>7</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> </dns> </packet>

Response Packet Structure The add_master_server node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultType (common.xsd).

Supported Operations

260

The status node is required. It specifies the execution status of the add_master_server operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the add_master_server operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the add_master_server operation fails. Data type: string. The id node is optional. It is required if the operation add_master_server has succeeded. Returns the ID of the primary name server in Plesk database. Data type: integer.

Response Samples Adding a single primary name server This request packet adds a primary name server to the zone of the domain with ID 5.
<packet version="1.4.2.0"> <dns> <add_master_server> <domain_id>5</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> </dns> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_master_server> <result> <status>ok</status> <id>4</id> </result> </add_master_server> </dns> </packet>

If the IP address parameter has invalid format, the response looks as follows:
<packet version="1.4.2.0"> <dns> <add_master_server> <result> <status>error</status> <errcode>1014</errcode> <errtext>Parser error: Cannot parse the XML from the source specified</errtext> <id>4</id> </result> </add_master_server> </dns> </packet>

Supported Operations

261

If the domain specified by the ID was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <dns> <add_master_server> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist.</errtext> <id>4</id> </result> </add_master_server> </dns> </packet>

Adding multiple primary name servers This request packet adds a primary name server to the zone of the domain with ID 5 and ID 7.
<packet version="1.4.2.0"> <dns> <add_master_server> <domain_id>5</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> <add_master_server> <domain_id>7</domain_id> <ip_address>10.6.45.18</ip_address> </add_master_server> </dns> </packet>

A possible response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <add_master_server> <result> <status>ok</status> <id>4</id> </result> </add_master_server> <add_master_server> <result> <status>ok</status> <id>5</id> </result> </add_master_server> </dns> </packet>

Supported Operations

262

Retrieving Primary Name Servers


Use the get_master_server operation to retrieve IP addresses of the primary name servers for the specified zone. You can retrieve multiple primary servers in a single packet. Note: The get_master_server operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet retrieving a primary name server includes the get_master_server operation node:
<packet version="1.4.2.0"> <dns> <get_master_server> </get_master_server> </dns> </packet>

The graphical representation of the get_master_server node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType (dns_input.xsd).

Note: If the filter node is left blank (<filter/>), the operation will retrieve all primary name servers available for a packet sender on the server. You can retrieve multiple primary name servers in a single packet. Add as many get_master_server operations as the number of different filtering rules you use.
<dns> <get_master_server> </get_master_server> ... <get_master_server> </get_master_server> </dns>

Request Samples Retrieving a single name server This packet retrieves the IP address of the primary name server with ID 5.
<packet version="1.4.2.0"> <dns> <get_master_server> <filter><id>5</id></filter> </get_master_server>

Supported Operations </dns> </packet>

263

Retrieving multiple name servers This packet retrieves primary name servers for the zones specified by domain ID 5 and ID 6.
<packet version="1.4.2.0"> <dns> <get_master_server> <filter> <domain_id>5</domain_id> <domain_id>5</domain_id> </filter> </get_master_server> </dns> </packet>

This packet retrieves primary name servers for the zones specified by domain ID 5 and domain alias ID 6..
<packet version="1.4.2.0"> <dns> <get_master_server> <filter> <domain_id>5</domain_id> </filter> </get_master_server> <get_master_server> <filter> <domain_alias_id>6</domain_alias_id> </filter> </get_master_server> </dns> </packet>

This packet retrieves all primary name servers on the server available for a packet sender.
<packet version="1.4.2.0"> <dns> <get_master_server> <filter/> </get_master_server> </dns> </packet>

Supported Operations

264

Response Packet Structure The get_master_server node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the get_master_server operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get_master_server operation fails. Data type: unsignedInt The errtext node is optional. It is used to return the error message if the get_master_server operation fails. Data type: string. The id node is optional. It is required if the operation get_master_server has succeeded. Returns the ID of the primary name server in Plesk database. Data type: integer. The filter-id node is optional. It holds the filtering rule parameter. For info on filters, refer to the Filtering Issues (see page 213) section. Data type: integer. The domain_id node is required. Specifies the ID of the domain, which zone will be served by the primary name server. Data type: integer. The domain_alias_id node is required. Specifies the ID of the domain alias, which zone will be served by the primary name server. Data type: integer. The ip_address node is required. Specifies the IP address of a primary name server. Data type: integer.

Supported Operations

265

Response Samples Retrieving a single name server This packet retrieves the IP address of the primary name server with ID 5.
<packet version="1.4.2.0"> <dns> <get_master_server> <filter><id>5</id></filter> </get_master_server> </dns> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get_master_server> <result> <status>ok</status> <filter-id>5</filter-id> <id>5</id> <domain_id>1</domain_id> <ip_address>115.16.17.18</ip_address> </result> </get_master_server> </dns> </packet>

If the name server specified by the ID was not found, the response can look as follows:
<packet version="1.4.2.0"> <dns> <get_master_server> <result> <status>error</status> <errcode>1013</errcode> <errtext>Master server is not found. ID : 5</errtext> </result> </get_master_server> </dns> </packet>

If the domain specified by the ID was not found, the response can look as follows:
<packet version="1.4.2.0"> <dns> <get_master_server> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist.</errtext> </result> </get_master_server> </dns> </packet>

Supported Operations

266

Retrieving multiple name servers This packet retrieves primary name servers for the zones specified by domain ID 5 and ID 6, and domain alias ID 16.
<packet version="1.4.2.0"> <dns> <get_master_server> <filter> <domain_id>5</domain_id> <domain_id>6</domain_id> </filter> </get_master_server> <get_master_server> <filter> <domain_alias_id>16</domain_alias_id> </filter> </get_master_server> </dns> </packet>

Two primary servers on domain with ID 5, one on the domain with ID 6 are found. The domain alias with ID 16 was not found on the server. A possible response from the server can look as follows:
<packet version="1.4.2.0"> <dns> <get_master_server> <result> <status>ok</status> <filter-id>5</filter-id> <id>15</id> <domain_id>5</domain_id> <ip_address>15.16.17.18</ip_address> </result> <result> <status>ok</status> <filter-id>5</filter-id> <id>16</id> <domain_id>5</domain_id> <ip_address>11.16.17.18</ip_address> </result> <result> <status>ok</status> <filter-id>6</filter-id> <id>28</id> <domain_id>6</domain_id> <ip_address>10.6.17.18</ip_address> </result> </get_master_server> <get_master_server> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain alias does not exist.</errtext> </result> </get_master_server> </dns> </packet>

Supported Operations

267

Deleting Primary Name Servers


Use the del_master_server operation to delete primary name servers from the specified zone. You can delete multiple primary servers in a single packet. Note: The del_master_server operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet deleting a primary name server includes the del_master_server operation node:
<packet version="1.4.2.0"> <dns> <del_master_server> </del_master_server> </dns> </packet>

The graphical representation of the del_master_server node is as follows:

The filter node is required. It specifies the filtering rule. For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType (dns_input.xsd).

Note: If the filter node is left blank (<filter/>), the operation removes all primary name servers available for a packet sender on the server. You can delete multiple primary name servers in a single packet. Add as many del_master_server operations as the number of different filtering rules you use.
<dns> <del_master_server> </del_master_server> ... <del_master_server> </del_master_server> </dns>

Request Samples Deleting a single name server This packet removes the primary name server specified by ID 5.
<packet version="1.4.2.0"> <dns> <del_master_server> <filter><id>5</id></filter>

Supported Operations </del_master_server> </dns> </packet>

268

Deleting multiple name servers This packet removes primary name servers for the zones specified by domain ID 5 and ID 6.
<packet version="1.4.2.0"> <dns> <del_master_server> <filter> <domain_id>5</domain_id> <domain_id>5</domain_id> </filter> </del_master_server> </dns> </packet>

This packet removes all primary name servers available for a packet sender from Plesk database.
<packet version="1.4.2.0"> <dns> <del_master_server> <filter/> </del_master_server> </dns> </packet>

Response Packet Structure The get_master_server node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the del_master_server operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the del_master_server operation fails. Data type: unsignedInt The errtext node is optional. It is used to return the error message if the del_master_server operation fails. Data type: string.

Supported Operations

269

The id node is optional. It is required if the operation del_master_server has succeeded. Returns the ID of the primary name server in Plesk database. Data type: integer.

Response Samples Removing a single name server This packet removes the primary name server specified by ID 5.
<packet version="1.4.2.0"> <dns> <del_master_server> <filter><id>5</id></filter> </del_master_server> </dns> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <del_master_server> <result> <status>ok</status> <id>5</id> </result> </del_master_server> </dns> </packet>

If the name server specified by the ID was not found, the response can look as follows:
<packet version="1.4.2.0"> <dns> <del_master_server> <result> <status>error</status> <errcode>1013</errcode> <errtext>Master server is not found. ID : 5</errtext> </result> </del_master_server> </dns> </packet>

If the domain specified by the ID was not found, the response can look as follows:
<packet version="1.4.2.0"> <dns> <del_master_server> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist.</errtext>

Supported Operations </result> </del_master_server> </dns> </packet>

270

Removing multiple name servers This packet deletes primary name servers for the zones specified by domain ID 5 and ID 6, and primary server with ID 25.
<packet version="1.4.2.0"> <dns> <del_master_server> <filter> <domain_id>5</domain_id> <domain_id>6</domain_id> </filter> </del_master_server> <del_master_server> <filter> <id>25</id> </filter> </del_master_server> </dns> </packet>

Three primary servers on the domains with ID 5 and ID 6 were removed. The primary server with ID 25 was not found on the server. A possible response from the server can look as follows:
<packet version="1.4.2.0"> <dns> <del_master_server> <result> <status>ok</status> <id>15</id> </result> <result> <status>ok</status> <id>16</id> </result> <result> <status>ok</status> <id>28</id> </result> </del_master_server> <del_master_server> <result> <status>error</status> <errcode>1015</errcode> <errtext>Master server is not found. ID : 25</errtext> </result> </del_master_server> </dns> </packet>

Supported Operations

271

Managing Local or Remote DNS Servers


All zones on the server can be served by local or remote DNS servers. When the local DNS server is disabled, the zone is served by a remote DNS server.

Enabling Local DNS


The enable operation is used to enable local DNS support for the current zone. With the operation, you can also enable or disable the local DNS support for the DNS zone template. All the domains or domain alias zones, which were added according to the template with the enabled status, will be supported by local DNS. You can enable the local DNS support for multiple zones in a single packet. To learn how to retrieve the status information for the local DNS server, refer to the Managing SOA Records and Zone Parameters (see page 248) section. Note: The enable operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet switching on the local DNS support includes the enable operation node:
<packet version="1.4.2.0"> <dns> <enable> </enable> </dns> </packet>

The graphical representation of the enable node is as follows:

The filter node is optional. It specifies the filtering rule. If the filter node is omitted, the DNS zone template will change status to "enable". For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType (dns_input.xsd).

You can enable the local DNS support for multiple zones. Add as many enable operations as the number of different filtering rules.
<dns> <enable> </enable> ... <enable> </enable> </dns>

Supported Operations

272

Request Samples This packet enables the local DNS for the zones specified by domain ID 8 and ID 9.
<packet version="1.4.2.0"> <dns> <enable> <filter> <domain_id>8</domain_id> <domain_id>9</domain_id> </filter> </enable> </dns> </packet>

This packet enables the local DNS for the zones specified by domain ID 8.
<packet version="1.4.2.0"> <dns> <enable> <filter> <domain_id>8</domain_id> </filter> </enable> </dns> </packet>

This packet enables the local DNS for the DNS zone template .
<packet version="1.4.2.0"> <dns> <enable/> </dns> </packet>

Response Packet Structure The enable node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultOpType (dns_output.xsd). The status node is required. It specifies the execution status of the enable operation. Data type: string. Allowed values: ok | error.

Supported Operations

273

The errcode node is optional. It is used to return the error code when the enable operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the enable operation fails. Data type: string. The domain_id node is optional. It is required if the domain ID was set as a filtering rule in the response packet. Specifies the ID of the domain, which zone will use local DNS. Data type: integer. The domain_alias_id node is optional. It is required if the domain ID was set as a filtering rule in the response packet. Specifies the ID of the domain alias, which zone will use local DNS. Data type: integer.

Response Samples This request packet enables the local DNS for the zones specified by domain ID 8 and ID 9.
<packet version="1.4.2.0"> <dns> <enable> <filter> <domain_id>8</domain_id> <domain_id>9</domain_id> </filter> </enable> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <enable> <result> <status>ok</status> <domain_id>8</domain_id> </result> <result> <status>ok</status> <domain_id>9</domain_id> </result> </enable> </dns> </packet>

If the second zone was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <dns> <enable> <result> <status>ok</status> <domain_id>8</domain_id> </result>

Supported Operations

274

<result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist.</errtext> </result> </enable> </dns> </packet>

Disabling Local DNS


The disable operation is used to disable the local DNS support for the current zone. With the operation, you can also disable the local DNS support for the DNS zone template. All the domains or domain alias zones, which were added according to the template with the disabled status, will not be supported by local DNS. You can enable the local DNS support for multiple zones in a single packet. To learn how to retrieve the status information for the local DNS server, refer to the Managing SOA Records and Zone Parameters (see page 248) section. Note: The disable operation is supported starting with API RPC protocol v.1.4.0.0. Request Packet Structure A request XML packet switching off the local DNS support includes the disable operation node:
<packet version="1.4.2.0"> <dns> <disable> </disable> </dns> </packet>

The graphical representation of the disable node is as follows:

The filter node is optional. It specifies the filtering rule. If the filter node is omitted, the DNS zone template will changes status to "disable". For more information, refer to the Filtering Issues (see page 215) section. Data type: dnsSelectionFilterType (dns_input.xsd).

You can disable the local DNS support for multiple zones. Add as many disable operations as the number of different filtering rules.
<dns> <disable> </disable> ... <disable> </disable> </dns>

Supported Operations

275

Request Samples This packet disables the local DNS for the zones specified by domain ID 8 and ID 9.
<packet version="1.4.2.0"> <dns> <disable> <filter> <domain_id>8</domain_id> <domain_id>9</domain_id> </filter> </disable> </dns> </packet>

This packet disables the local DNS for the DNS zone template .
<packet version="1.4.2.0"> <dns> <disable/> </dns> </packet>

Response Packet Structure The disable node of the output XML packet is structured as follows:

The result node is required. It wraps the response from the server. Data type: resultOpType (dns_output.xsd). The status node is required. It specifies the execution status of the disable operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the disable operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the disable operation fails. Data type: string. The domain_id node is optional. It is required if the domain ID was set as a filtering rule in the response packet. Specifies the ID of the domain, which zone will use local DNS. Data type: integer.

Supported Operations

276

The domain_alias_id node is optional. It is required if the domain ID was set as a filtering rule in the response packet. Specifies the ID of the domain alias, which zone will use local DNS. Data type: integer.

Response Samples This request packet disables the local DNS for the zones specified by domain ID 8 and ID 9.
<packet version="1.4.2.0"> <dns> <disable> <filter> <domain_id>8</domain_id> <domain_id>9</domain_id> </filter> </disable> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <disable> <result> <status>ok</status> <domain_id>8</domain_id> </result> <result> <status>ok</status> <domain_id>9</domain_id> </result> </disable> </dns> </packet>

If the second zone was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <dns> <disable> <result> <status>ok</status> <domain_id>8</domain_id> </result> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist.</errtext> </result> </disable> </dns> </packet>

Supported Operations

277

Enabling Remote DNS Support


The enable-remote-dns operation is used to disable the local DNS server, and you can use remote DNS servers. This node is available only in Plesk for Windows 8.1 and next versions. Note: The enable-remote-dns operation is supported starting with API RPC protocol v.1.4.2.0. A request XML packet, that enables use of remote DNS servers, includes the enableremote-dns operation node:
<packet version="1.4.2.0"> <dns> <enable-remote-dns/> </dns> </packet>

The graphical representation of the enable-remote-dns node is as follows:

Request packet sample This request packet enables use of remote DNS servers.
<packet version="1.4.2.0"> <dns> <enable-remote-dns/> </dns> </packet>

Response Packet Structure The enable-remote-dns node is presented by type DNSEnableRemoteDNS (dns_output.xsd) and is structured as follows:

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd).

Supported Operations

278

The status node is required. It specifies the execution status of the enable-remote-dns operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the enableremote-dns operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the enableremote-dns operation fails. Data type: string.

Response Samples This request packet enables use of remote DNS servers.
<packet version="1.4.2.0"> <dns> <enable-remote-dns/> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <enable-remote-dns> <result> <status>ok</status> </result> </enable-remote-dns> </dns> </packet>

If the packet is sent to Plesk for Unix server, the response is as follows:
<packet version="1.4.2.0"> <dns> <enable-remote-dns> <result> <status>error</status> <errcode>1014</errcode> <errtext>Parser error: Request is invalid</errtext> </result> </enable-remote-dns> </dns> </packet>

Supported Operations

279

Disabling Remote DNS Support


The disable-remote-dns operation is used to disable remote DNS servers, and you can use the local DNS server. This node is available only in Plesk for Windows 8.1 and next versions. Note: The disable-remote-dns operation is supported starting with API RPC protocol v.1.4.2.0. A request XML packet, that disables use of remote DNS servers, includes the disableremote-dns operation node:
<packet version="1.4.2.0"> <dns> <disable-remote-dns/> </dns> </packet>

The graphical representation of the disable-remote-dns node is as follows:

Request packet sample This request packet disables use of remote DNS servers.
<packet version="1.4.2.0"> <dns> <disable-remote-dns/> </dns> </packet>

Response Packet Structure The disable-remote-dns node is presented by type DNSEnableRemoteDNS (dns_output.xsd) and is structured as follows:

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd).

Supported Operations

280

The status node is required. It specifies the execution status of the enable-remote-dns operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the enableremote-dns operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the enableremote-dns operation fails. Data type: string.

Response Samples This request packet disables use of remote DNS servers.
<packet version="1.4.2.0"> <dns> <disable-remote-dns/> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <disable-remote-dns> <result> <status>ok</status> </result> </disable-remote-dns> </dns> </packet>

If the packet is sent to Plesk for Unix server, the response is as follows:
<packet version="1.4.2.0"> <dns> <disable-remote-dns> <result> <status>error</status> <errcode>1014</errcode> <errtext>Parser error: Request is invalid</errtext> </result> </disable-remote-dns> </dns> </packet>

Supported Operations

281

Retrieving Remote DNS Status


Remote DNS servers are enabled or disabled. If remote DNS servers are disabled, all zones are served by the local DNS server. Use the get-status-remote-dns to retrieve the status of remote DNS servers. This node is available only in Plesk for Windows 8.1 and next versions. Note: The get-status-remote-dns operation is supported starting with API RPC protocol v.1.4.2.0. A request XML packet, that retrieves the status of remote DNS servers, includes the get-status-remote-dns operation node:
<packet version="1.4.2.0"> <dns> <get-status-remote-dns/> </dns> </packet>

The graphical representation of the get-status-remote-dns node is as follows:

Request packet sample This request packet retrieves the status of remote DNS servers.
<packet version="1.4.2.0"> <dns> <get-status-remote-dns/> </dns> </packet>

Response Packet Structure The get-status-remote-dns node is presented by type DNSEnableRemoteDNS (dns_output.xsd) and is structured as follows:

Supported Operations

282

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get-status-remotedns operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get-statusremote-dns operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the get-statusremote-dns operation fails. Data type: string. The dns-status node is optional. It is required if the operation get-status-remote-dns succeeds. Data type: boolean.

Response Samples This request packet retrieves the status of remote DNS servers.
<packet version="1.4.2.0"> <dns> <get-status-remote-dns> </dns> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <dns> <get-status-remote-dns <result> <status>ok</status> <dns_status>true</dns_status&gt; </result> </get-status-remote-dns> </dns> </packet>

If the packet is sent to Plesk for Unix server, the response is as follows:
<packet version="1.4.2.0"> <dns> <disable-remote-dns> <result> <status>error</status> <errcode>1014</errcode> <errtext>Parser error: Request is invalid</errtext> </result> </disable-remote-dns> </dns> </packet>

Supported Operations

283

Managing DNS Recursion


When a DNS server receives a recursive request from a client that it is willing to perform recursion for, it will go through the process of resolving the requested domain name by first asking the root servers, which respond with a referral to the top level DNS servers, then asking one of those servers, which respond with a referral to the next level DNS servers, etc. When a DNS server receives a non-recursive request or a request from a client that it is not willing to perform recursion for, it typically responds immediately with whatever local data it has available at the time without doing any additional processing. Four types of recursive requests to the local DNS sever in Plesk are available: off. The recursion is not allowed. on. The recursion is allowed for all requests. localhost. The recursion is allowed for requests from local machine. localnets. The recursion is allowed for requests from local net.

Note: Not all of the following types can be supported by the server. Before setting the recursion type, use the get-supported-recursion to make sure it is supported by the server.

Setting Recursion Type


The type of recursion can be changed by the set-recursion operation. Before setting the recursion type, make sure it is supported by the server. Note: The set-recursion operation is supported starting with API RPC protocol v.1.4.2.0. Request Packet Structure A request XML packet changing the recursion type includes the set-recursion operation node:
<packet version="1.4.2.0"> <dns> <set-recursion> </set-recursion> </dns> </packet>

The set-recursion node is presented by type DNSSetRecursionInputType (dns_input.xsd) and structured as follows:

The value node is required. Specifies the type of recursion. Data type: DNSRecursionValueType (plesk_dns.xsd). Allowed values: on | off | local | localnets.

Supported Operations

284

Request Samples This packet allows all recursive requests to the local DNS server.
<packet version="1.4.2.0"> <dns> <set-recursion> <value>on</value> </set-recursion> </dns> </packet>

This packet allows recursive requests coming from the local net to the local DNS server.
<packet version="1.4.2.0"> <dns> <set-recursion> <value>localnets</value> </set-recursion> </dns> </packet>

Response Packet Structure The set-recursion node is presented by type DNSEnableRemoteDNS (dns_output.xsd) and is structured as follows:

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the set-recursion operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the setrecursion operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the set-recursion operation fails. Data type: string.

Supported Operations

285

Response Samples This request packet allows all recursive requests to the local DNS server.
<packet version="1.4.2.0"> <dns> <set-recursion> <value>on</value> </set-recursion> </dns> </packet>

If the recursion type is supported by the server, the response is as follows:


<packet version="1.4.2.0"> <dns> <set-recursion> <result> <status>ok</status> </result> </set-recursion> </dns> </packet>

If the recursion type is not supported by the server, the response is as follows:
<packet version="1.4.2.0"> <dns> <set-recursion> <result> <status>error</status> <errcode>4605</errcode> <errtext>Not supported type for DNS recursion</errtext> </result> </set-recursion> </dns> </packet>

Retrieving Recursion Type


A request XML packet, that retrieves a type of recursion, includes the get-recursion operation node:
<packet version="1.4.2.0"> <dns> <get-recursion/> </dns> </packet>

The graphical representation of the get-recursion node is as follows:

Note: The get-recursion operation is supported starting with API RPC protocol v.1.4.2.0.

Supported Operations

286

Request packet sample This request packet retrieves the recursion type.
<packet version="1.4.2.0"> <dns> <get-recursion/> </dns> </packet>

Response Packet Structure The get-recursion node is presented by type DNSGetRecursionOutputType (dns_output.xsd) and is structured as follows:

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get-recursion operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the getrecursion operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the get-recursion operation fails. Data type: string. The value node is optional. It is used to return a type of recursion if the get-recursion operation succeeds. Data type: string.

Supported Operations

287

Response Samples This request packet retrieves the recursion type.


<packet version="1.4.2.0"> <dns> <get-recursion/> </dns> </packet>

A response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get-recursion> <result> <status>ok</status> <value>on</value> </result> </get-recursion> </dns> </packet>

Retrieving Supported Recursion Types


The get-supported-recursion operation retrieves the types of recursive requests, supported by the local DNS server. For more information on types of requests, please refer to the Managing DNS recursion (see page 283) section. A request XML packet, that retrieves the supported types of recursion, includes the getsupported-recursion operation node:
<packet version="1.4.2.0"> <dns> <get-supported-recursion/> </dns> </packet>

The graphical representation of the get-supported-recursion node is as follows:

Note: The set-recursion operation is supported starting with API RPC protocol v.1.4.2.0. Request packet sample This request packet retrieves the types of recursive requests supported by the server.
<packet version="1.4.2.0"> <dns> <get-supported-recursion/> </dns> </packet>

Supported Operations

288

Response Packet Structure The get-supported-recursion node is presented by type DNSGetSupportedRecursionOutputType (dns_output.xsd) and is structured as follows:

The result node is required. It wraps the information got from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get-supportedrecursion operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the getsupported-recursion operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the getsupported-recursion operation fails. Data type: string. The value node is optional. It is used to return the supported types of recursion if the get-supported-recursion operation succeeds. Data type: string.

Response Samples This request packet retrieves the types of recursive requests supported by the server.
<packet version="1.4.2.0"> <dns> <get-supported-recursion/> </dns> </packet>

A response from the server can look as follows:


<packet version="1.4.2.0"> <dns> <get-supported-recursion> <result> <status>ok</status> <value>on</value>

Supported Operations <value>localnets</value> <value>local</value> </result> </get-supported-recursion> </dns> </packet>

289

Supported Operations

290

Managing Domain Accounts


Operator: <domain> XML Schema: domain_input.xsd, domain_output.xsd, plesk_domain.xsd Plesk version: all versions API RPC version: all versions Plesk user: Plesk Administrator, Plesk Client Description Adding a new domain in Plesk is equivalent to creating a new domain account. A domain account holds the information about the domain administrator and various domain settings (hosting settings, limits on use of Plesk resources, performance settings, etc. ). Domain accounts can be created by Plesk users who are allowed to manage domains (Plesk Administrator and Plesk Client). Plesk Administrator can create a domain for any Client registered in Plesk, while Plesk Client can create a domain for their own needs only. A domain account is created as subordinate to a certain Plesk Client. This domain is visible to/ can be managed by Plesk Administrator and the parent Plesk Client only. Managing domain accounts includes creating, deleting, settings various domain/ Domain Administrator settings. Settings Domain accounts are used to store a collection of domain settings. These settings specify various resources at the domains disposal, and the capabilities of Domain Administrator as well. These settings are as follows: General account information Domain Administrator settings Domain Administrator permissions Hosting settings Limits on use of Plesk resources Disk usage settings Domain statistics settings Domain preferences Performance settings

Refer to the Domain Settings (on page 295) section for details.

Supported Operations

291

Supported operations

ADD (see page 329) creates a new domain account and sets general information, hosting settings, limits, preferences, and domain administrator settings; GET (see page 334) gets the getting information on the specified domain(s) from Plesk database; SET (see page 348) sets new preferences, limits, etc., of the specified domain(s) to Plesk database; DEL (see page 343) deletes the specified domain account(s) from Plesk database; CFORM_BUTTONS_LIST (see page 355) gets the list of buttons displayed on the page of the specified domain; GET_TRAFFIC (see page 361) gets the information about traffic spent by the domain(s) between two dates; SET_TRAFFIC (see page 368) sets the information about traffic spent by the specified domain(s) to the database.

Supported Operations

292

Filtering Issues
Filtering is the way the request packets pick out domains to which the requested operation will be applied. The filter node is presented by the DomainFilterType complex type (domain_input.xsd). This data type is structured as follows:

The id node is optional. It specifies the domain id. Data type: integer. The client_id node is optional. It specifies id of Plesk Client that owns requested domains. Data type: integer. The domain_name node is optional. It specifies the domain name. Data type: string. The client_login node is optional. It specifies the login of Plesk Client who owns requested domains. Data type: string.

The filter allows two kinds of filtering: Nodes id and domain_name serve to filter one to many domains individually. Individual filtering is allowed for Plesk Administrator and for Plesk Clients (they can manage their own domains only). Nodes client_id and client_login serve to filter all domains of a certain Plesk Client (or several) at one stroke. This kind of filtering is allowed for Plesk Administrator only.

Individual filtering The following packet requests hosting settings of three domains specified by their id:
<packet version=1.4.2.0> <domain> <get> <filter> <id>124</id> <id>125</id> <id>127</id> </filter>

Supported Operations <dataset> <hosting/> </dataset> </get> </domain> </packet>

293

The following packet is identical except it specifies domains by their names:


<packet version=1.4.2.0> <domain> <get> <filter> <domain_name>advent.co.uk</domain_name> <domain_name>freescale.co.uk</domain_name> <domain_name>talkmore.co.uk</domain> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

The following packet is invalid as both the id node and the domain_name node are used in the same filter:
<packet version=1.4.2.0> <domain> <get> <filter> <domain_name>advent.co.uk</domain_name> <id>125</id> <domain_name>talkmore.co.uk</domain> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

To fix this problem, use two different <get> sections:


<packet version=1.4.2.0> <domain> <get> <filter> <domain_name>advent.co.uk</domain_name> <domain_name>talkmore.co.uk</domain> </filter> <dataset> <hosting/> </dataset> </get> <get>

Supported Operations <filter> <id>125</id> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

294

Bulk filtering The following packet deletes all domains belonging to two Plesk Clients specified by ID:
<packet version=1.4.2.0> <domain> <del> <filter> <client_id>1324</client_id> <client_id>1325</client_id> </filter> </del> </domain> </packet>

The same packet specifies Plesk Clients by login:


<packet version=1.4.2.0> <domain> <del> <filter> <client_login>FirstClient</client_login> <client_login>LastClient</client_login> </filter> </del> </domain> </packet>

The following packet is invalid as it uses both the client_id node and the client_login node within one filter:
<packet version=1.4.2.0> <domain> <del> <filter> <client_id>1324</client_id> <client_login>LastClient</client_login> </filter> </del> </domain> </packet>

Supported Operations

295

To fix this packet, use two different <del> sections:


<packet version=1.4.2.0> <domain> <del> <filter> <client_id>1324</client_id> </filter> </del> <del> <filter> <client_login>LastClient</client_login> </filter> </del> </domain> </packet>

The following packet sent by Plesk Administrator deletes all domains available in Plesk. If sent by Plesk Client, it will delete all domains of this Client:
<packet version=1.4.2.0> <domain> <del> <filter/> </del> </domain> </packet>

Domain Settings
This section describes a collection of domain and Domain Administrator settings. These settings can be defined when creating a new domain or later, and retrieved from Plesk database as well. These settings are as follows: General account information (see page 296) Domain Administrator settings (see page 301) Limits, hosting settings and domain administrator's permissions (see page 305) Disk usage settings (see page 322) Domain statistics settings (see page 324) Domain preferences (see page 326) Performance settings (see page 327)

Supported Operations

296

General Account Information


General domain information can be added, updated, or read. General domain information is always set when creating a domain account (the add operation). This is done using the gen_setup node (no data type, defined within the add operation node). See the structure of this node in the Node gen_setup (see page 299) section. General information about the specified domains can be retrieved from Plesk database (the get operation). It is returned in the gen_info node of type domainGenInfoType (plesk_domain.xsd). See the structure of this node in the Node gen_info (see page 296) section. General domain information can be updated/modified (the set operation). This is done using the gen_setup node of type SetGenSetupType (plesk_domain.xsd). See the structure of this node in the Node gen_setup (type SetGenSetupType) (see page 300) section.

Node gen_info (type domainGenInfoType) This node is used in the get response packets. It is defined by complex type domainGenInfoType (plesk_domain.xsd) and holds a collection of common domain settings. In API RPC 1.4.1.2 and earlier, this node is structured as follows:

The cr_date node is required. It holds the creation date of the specified domain. Data type: date. Format: YYYY-MM-DD. The name node is required. It holds the domain name. Data type: string. The display_name node is required. It holds the domain name displayed in Plesk GUI. Data type: string.

Supported Operations

297

The status node is required. It holds the current status of the specified domain. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 4 (under backup/restore) | 16 (disabled by Plesk Administrator) | 64 (disabled by Plesk Client) | 256 (expired). The real_size node is required. It holds the actual size of the domain (in bytes). Data type: unsignedLong. The client_id node is required. It holds the identifier of Plesk Client who owns this domain account. Data type: integer. The dns_ip_address node is optional. It holds the domain's IP address shown in the DNS record. Data type: ip_address (common.xsd). The htype node is required. It specifies the type of hosting set on the domain. Data type: string. Allowed values: vrt_hst | std_fwd | frm_fwd | none.

The following packet with general domain information can be received from Plesk server:
<packet version=1.4.1.2> <domain> <get> <result> <status>ok</status> <id>1234</id> <data> <gen_info> <cr_date>2000-12-12</cr_date> <name>alterzone.co.uk</name> <display_name>www.alterzone.co.uk</display_name> <status>256</status> <real_size>54687742156789</real_size> <client_id>111</client_id> <dns_ip_address>123.123.13.123</dns_ip_address> <htype>vrt_hst</htype> </gen_info> </data> </result> </get> </domain> </packet>

Supported Operations

298

Starting from API RPC 1.4.2.0, the gen_info node has got some changes as follows: The display_name node is now called name The name node was renamed into ascii-name

The cr_date node is required. It holds the creation date of the specified domain. Data type: date. Format: YYYY-MM-DD. The name node is required. It holds the domain name displayed in Plesk GUI. Data type: string. The ascii-name node is required. It holds the domain name in ASCII format. Data type: string. The status node is required. It holds the current status of the specified domain. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 4 (under backup/restore) | 16 (disabled by Plesk Administrator) | 64 (disabled by Plesk Client) | 256 (expired). The real_size node is required. It holds the actual size of the domain (in bytes). Data type: unsignedLong. The client_id node is required. It holds the identifier of Plesk Client who owns this domain account. Data type: integer. The dns_ip_address node is optional. It holds the domain's IP address shown in the DNS record. Data type: ip_address (common.xsd). The htype node is required. It specifies the type of hosting set on the domain. Data type: string. Allowed values: vrt_hst | std_fwd | frm_fwd | none.

The following packet with general domain information can be received from Plesk server if API RPC 1.4.2.0 is used:
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status>

Supported Operations <filter-id>1234</filter-id> <id>1234</id> <data> <gen_info> <cr_date>2000-12-12</cr_date> <name>www.alterzone.co.uk</name> <ascii-name>www.alterzone.co.uk</ascii-name> <status>256</status> <real_size>54687742156789</real_size> <client_id>111</client_id> <dns_ip_address>123.123.13.123</dns_ip_address> <htype>vrt_hst</htype> </gen_info> </data> </result> </get> </domain> </packet>

299

This packet is specific for API RPC 1.4.2.0: The response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain id, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature. Node gen_setup This node is used in the add request packets to set general settings for the newly created domain account. This node does not have its own type, it is defined within the parent node and has the following structure:

The name node is required. It specifies the domain name. Data type: string. The client_id node is optional. It specifies the owner of the new domain account (Plesk Client) when the domain is created by Plesk Administrator. If the domain account is created by Plesk Client, the node should not be specified. Data type: integer. The htype node is optional. It specifies one of the following hosting types: virtual hosting, standard forwarding, frame forwarding, none. Data type: string. Allowed values: vrt_hst | std_fwd | frm_fwd | none.

Note: If you specify this node, you should also include the hosting node into the request packet.

Supported Operations

300

The ip_address node is required. It specifies the ip address associated with the domain. Data type: ip_address (common.xsd). The status node is optional. It specifies the status of the domain just created. Data type: string. Allowed values: 0 | 16 | 64. Meanings: 0 - active, 16 - disabled by Plesk Administrator, 64 - disabled by Client.

The following packet creates a domain and sets all necessary general information for it:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <htype>vrt_hst</htype> <ip_address>192.0.2.11</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.168.45.54</ip_address> </vrt_hst> </hosting> </add> </domain> </packet>

Node gen_setup (type setGenSetupType) This node is used in the set request packets to set the general information for the specified domain(s). It is defined by data type setGenSetupType (plesk_domain.xsd). The gen_setup node is structured as follows:

The status node is optional. It is used to set the current status of the specified domain. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 16 (disabled by Plesk Administrator) | 64 (disabled by Plesk Client). The name node is optional. It is used to modify the domain name. Data type: string. The client_id node is required. It is used to change the domain owner (Plesk Client) specified by ID. Data type: integer.

Supported Operations

301

The ip_address node is required. It is used to modify the ip address associated with the domain. Data type: ip_address (common.xsd).

The following packet assigns all domains of one Plesk Client (id = 1111) to another Plesk Client (id = 1122). This packet can be sent by Plesk Administrator only.
<packet version=1.4.2.0> <domain> <set> <filter> <client_id>1111</client_id> </filter> <values> <gen_setup> <status>0</status> <client_id>1122</client_id> <ip_address>192.0.2.121</ip_address> </gen_setup> </values> </set> </domain> </packet>

Supported Operations

302

Domain Administrator Settings


Domain Administrator settings are defined by two data types. Type domainUserSet (see page 302) is used in the add and set request packets Type domainUserGet (see page 303) is used in the get response packets Type domainUserSet The user node is used in the add and set request packets. It is specified by complex type domainUserSet (plesk_domain.xsd). This node is structured as follows (pared-down variant):

The enabled node is optional. It is used to enable/disable the domain account. Data type: Boolean. The password node is optional. It specifies the password of the domain administrator. Data type: string (5 to 14 characters long). The global-login and the uid nodes are deprecated. The cname node is optional. It specifies the company where the domain administrator works. Data type: string (0 to 255 characters long).

The pname node is optional. It specifies the name of the domain administrator. Data type: string (0 to 255 characters long). The phone node is optional. It specifies the phone number of the domain administrator. Data type: string (0 to 255 characters long). The fax node is optional. It specifies the fax number of the domain administrator. Data type: string (0 to 255 characters long). The email node is optional. It specifies the email address of the domain administrator. Data type: string (0 to 255 characters long).

Supported Operations

303

The address node is optional. It specifies the postal address of the domain administrator. Data type: string (0 to 255 characters long). The city node is optional. It specifies the city of the domain administrator. Data type: string (0 to 255 characters long). The state node is optional. It specifies the state of the domain administrator. Is required for US only. Data type: string (0 to 255 characters long). The pcode node is optional. It specifies the zip code of the domain administrator. Is required for US only. Data type: string (0 to 10 characters long). The country node is optional. It specifies the country code of the domain administrator. Data type: string (0 to 2 characters long). The multiply_login node is optional. It indicates whether multiple logins with the same domain administrator credentials are allowed. Data type: Boolean. The perms node is optional. It specifies a collection of permissions set for the domain administrator. Data type: domainPerms (plesk_domain.xsd). See the structure of this node in the Domain Administrator Permissions (see page 305) topic.

The following sample packet creates a domain account and sets Domain Administrator information:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>192.0.2.123</ip_address> </gen_setup> <user> <enabled>false</enabled> <password>123456</password> <cname>technolux</cname> <pname>Stephen Holmes</pname> <phone>2121342526</phone> <fax>2121342527</fax> <email>sholmes@technolux.ca</email> <address>Gray Lake Road, 12</address> <city>Totonto</city> <state/> <pcode/> <country>CA</country> <multiply_login>false</multiply_login> <permissions/> </user> </add> </domain> </packet>

Type domainUserGet

Supported Operations

304

The user node used in the get response packets is specified by complex type domainUserGet (plesk_domain.xsd). It is structured as follows:

The enabled node is optional. It shows whether the domain account is enabled. Data type: Boolean. The cname node is optional. It specifies the company where the domain administrator works. Data type: string (0 to 255 characters long). The pname node is optional. It specifies the name of the domain administrator. Data type: string (0 to 255 characters long). The phone node is optional. It specifies the phone number of the domain administrator. Data type: string (0 to 255 characters long). The fax node is optional. It specifies the fax number of the domain administrator. Data type: string (0 to 255 characters long). The email node is optional. It specifies the email address of the domain administrator. Data type: string (0 to 255 characters long). The address node is optional. It specifies the postal address of the domain administrator. Data type: string (0 to 255 characters long).

The city node is optional. It specifies the city of the domain administrator. Data type: string (0 to 255 characters long). The state node is optional. It specifies the state of the domain administrator. Is required for US only. Data type: string (0 to 255 characters long). The pcode node is optional. It specifies the zip code of the domain administrator. Is required for US only. Data type: string (0 to 10 characters long). The country node is optional. It specifies the country code of the domain administrator. Data type: string (0 to 2 characters long). The multiply_login node is optional. It indicates whether multiple logins are allowed under the same domain administrator credentials. Data type: Boolean. The perms node is optional. It specifies a collection of permissions set for the domain administrator. Data type: domainPerms (plesk_domain.xsd). See the structure of this node in the Domain Administrator Permissions (see page 305) topic. The global-login and the uid nodes are deprecated.

Supported Operations

305

The following response packet demonstrates the domain administrator information returned from Plesk server:
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> <data> <user> <enabled>true</enabled> <cname>technolux</cname> <pname>Stephen Lowell</pname> <phone>2121342526</phone> <fax>2121342527</fax> <email>slowell@technolux.ca</email> <address>Gray Lake Road, 12</address> <city>Totonto</city> <state> </state> <pcode> </pcode> <country>CA</country> <multiply_login>false</multiply_login> <permissions> </permissions> </user> </data> </result> </get> </domain> </packet>

This packet is specific for API RPC 1.4.2.0: the response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain ID, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature.

Supported Operations

306

Limits, Permissions and Hosting Settings


This section contains limits and permissions settings for domain administrators. Starting from API RPC 1.5.0.0 you can manage the settings using descriptors. For details on descriptors, refer to the Presentation of Object Descriptor (on page 16) section in API Reference and the Descriptors section in the Programming Guide. API RPC 1.5.0.0 and Later Versions This section contains domain limits and domain administrator permissions' settings, that are available in API RPC v.1.5.0.0 and later.

Limits The limits node is presented by domainLimits type (plesk_domain.xsd), and its graphical representation is as follows:

The limit node is required. It specifies parameters of a limit. Data type: PleskLimitType (plesk_client.xsd). The name node is required. It specifies a limit name. Data type: sting. The value node is required. It specifies a limit value. Data type: any.

Note: You can specify multiple limit parameters in one limits node.

The following code represents mailbox quota limit:


<limits> <limit> <name>mbox_quota</name> <value>100</value> </limit> </limits>

Note: To manage limits, you should first retrieve limits descriptor, containing names of limits. For details, refer to the Retrieving Descriptor of Limits (on page 372) section.

Supported Operations

307

Permissions The perms node is presented by domainPerms type (plesk_domain.xsd), and its graphical representation is as follows:

The permission node is required. It specifies parameters of a permission. Data type: PleskPermissionType (plesk_common.xsd). The name node is required. It specifies a permission name. Data type: sting. The value node is required. It specifies a permission value. Data type: any.

Note: You can specify multiple permission parameters in one perms node.

The following code represents permission to access shell:

<permissions> <permission> <name>manage_sh_access</name> <value>100</value> </permission> ... </permissions>

Note: To manage preferences, you should first retrieve permissions descriptor, containing names of permissions. For details, refer to the Retrieving Descriptor of Permissions (on page 378) section.

Supported Operations

308

Hosting Settings The hosting node in API RPC 1.5.0.0 and later versions is the same as in API RPC 1.4.2.0 except for the vrt_hst node. For details on the hosting node, refer to the Hosting Settings (see page 305) (API RPC 1.4.2.0) section. The graphical representation of the vrt_hst node (API RPC 1.5.0.0) is as follows:

The property node is required. It specifies a hosting parameter. Data type: PleskPhysHostingPropertyType (plesk_domain.xsd). The name node is required. It specifies a hosting parameter name. Data type: sting. The value node is required. It specifies a hosting parameter value. Data type: any.

Note: You can specify multiple property parameters in one vrt_hst node.

The ip_address node is required. It specifies the IP address of the domain. Data type: ip_address (common.xsd).

The following code represents FTP login parameter:


<vrt_hst> <property> <name>ftp_login</name> <value>MyFTPlogin</value> </property> ... </vrt_hst>

Note: To manage hosting settings, you should first retrieve a hosting settings descriptor, containing names of the settings. For details, refer to the Retrieving Descriptor of Hosting Settings (on page 382) section.

Supported Operations

309

API RPC 1.4.2.0 and Earlier Versions This section contains domain limits and domain administrators' permissions settings, that are available in API RPC v.1.4.2.0 and earlier. Limits Limits imposed on use of system resources are defined by the limits node. This node is specified by complex type domainLimits (plesk_domains.xsd). It is structured as follows:

The max_webapps node is optional. Specifies the maximum number of web applications allowed on the domain. Data type: integer. The max_maillists node is optional. Specifies the maximum number of mailing lists on the domain. Data type: integer. The max_resp node is optional. Specifies the maximum number of autoresponders (preset messages sent automatically) on the domain. Data type: integer. The max_mg node is optional. Specifies the maximum number of mail groups on the domain. Data type: integer. The max_redir node is optional. Specifies the maximum number of redirects on the domain. Data type: integer. The mbox_quota node is optional. Restricts the maximum amount of disk space (in bytes) allotted for a single mailbox on the domain. Data type: integer. The max_box node is optional. Specifies the maximum number of email boxes on the domain. Data type: integer. The max_db node is optional. It specifies the maximum number of MySQL databases for the domain. Data type: integer.

Supported Operations

310

The max_wu node is optional. Specifies the maximum number of web pages (web users) hosted on the domain. Data type: integer. The max_traffic node is optional. Specifies the maximum data traffic per month (in bytes) for the domain. Data type: integer. The disk_space node is optional. Restricts the amount of disk space (in bytes) for the domain. Data type: integer. The max_subdom node is optional. Specifies the maximum number of subdomains that can be created on the domain. Data type: integer. The expiration node is optional. Specifies the validity period for the domain account. Data type: integer (a UNIX timestamp format). The max_dom_aliases node is optional. Specifies the maximum number of aliases for the domain. Data type: integer. The total_mboxes_quota node is optional. Restricts the maximum amount of disk space (in bytes) occupied by all mail boxes on the domain. Data type: integer. Is used for Plesk for Windows only. The mysql_dbase_space node is optional. Sets the disk space limit (in bytes) on MySQL databases belonging to the domain. Data type: integer. The mssql_dbase_space node is optional. Sets the disk space limit (in bytes) on Microsoft SQL databases belonging to the domain. Data type: integer. Is used for Plesk for Windows only. The max_mssql_db node is optional. Limits the number of Microsoft SQL databases for the domain. Data type: integer. Is used for Plesk for Windows only. The max_shared_ssl_links node is optional. Specifies the maximum number of shared SSL links for the domain. Data type: integer. The max_subftp_users node is optional. Specifies the maximum number of additional FTP accounts on the domain. Data type: integer. Is used for Plesk for Windows only. The max_fpse_users node is optional. Specifies the maximum number of additional MS FrontPage accounts on the domain. Data type: integer. Is used for Plesk for Windows only.

The max_odbc node is optional. Specifies the maximum number of ODBC connections allowed on teh domain. Data type: integer. Is supported by API RPC 1.4.2.0 and later. Is used for Plesk for Windows only. Note: The limits on Plesk resources set for the domain account are restricted by similar limits set for the parent client account. The following sample packet creates a domain account and limits the use of Plesk resources for this domain:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>192.0.2.123</ip_address> </gen_setup> <limits> <disk_space>209715200</disk_space> <max_traffic>209715200</max_traffic>

Supported Operations <max_subdom>20</max_subdom> <max_wu>10000</max_wu> <max_subftp_users>10000</max_subftp_users> <max_db>100</max_db> <mysql_dbase_space>52428800</mysql_dbase_space> <max_mssql_db>100</max_mssql_db> <mysql_dbase_space>52428800</mysql_dbase_space> </limits> </add> </domain> </packet>

311

Supported Operations

312

Permissions The perms node is specified by complex type domainPerms (plesk_domain.xsd). It is structured as follows:

The manage_phosting node is optional. It indicates whether the domain administrator can manage physical hosting parameters of the domain. Data type: Boolean. The manage_quota node is optional. It indicates whether the domain administrator can change the hard disk quota set for the domain. Data type: Boolean. The manage_subdomains node is optional. It indicates whether the domain administrator can manage subdomains created on the domain. Data type: Boolean. The manage_not_chroot_shell node is optional. It indicates whether the domain administrator can manage non-chrooted shell access. Data type: Boolean. The manage_dns node is optional. It indicates whether the domain administrator can manage DNS settings on the domain. Data type: Boolean. The manage_log node is optional. It indicates whether the domain administrator can manage logging on the domain. Data type: Boolean. The manage_crontab node is optional. It indicates whether the domain administrator can manage the task scheduler on the domain. Data type: Boolean. The manage_anonftp node is optional. It indicates whether the domain administrator can manage anonymous FTP account settings on the domain. Data type: Boolean.

Supported Operations

313

The manage_webapps node is optional. It indicates whether the domain administrator can manage Tomcat web applications installed on the domain. Data type: Boolean. The manage_sh_access node is optional. It indicates whether the domain administrator can manage system shell access on the domain. Data type: Boolean. The manage_maillists node is optional. It indicates whether the domain administrator can manage mailing lists on the domain. Data type: Boolean. The manage_drweb node is optional. It indicates whether the domain administrator can manage DrWeb antivirus software on the domain (if supported by the key). Data type: Boolean. The make_dumps node is optional. It indicates whether the domain administrator can make dumps of the domain using backup/restore facilities of Plesk. Data type: Boolean. The site_builder node is optional. It indicates whether the domain administrator can use SiteBuilder. Data type: Boolean . This feature is not supported on Plesk 8.0 for Unix and later. The manage_ftp_password node is optional. It indicates whether the domain administrator can change the password of the FTP account on the domain. Data type: Boolean. The manage_performance node is optional. It indicates whether the domain administrator can manage hosting performance on the domain. Data type: Boolean. The manage_domain_aliases node is optional. It indicates whether the domain administrator can manage domain aliases. Data type: Boolean. The manage_iis_app_pool node is optional. It indicates whether the domain administrator can manage IIS application pool settings on the domain. Data type: Boolean. The dashboard node is optional. It indicates whether the domain administrator can manage the domain via Plesk desktop. Data type: Boolean. The stdgui node is optional. It indicates whether the domain administrator can use the standard GUI of Plesk. Data type: Boolean. The manage_dashboard node is optional. It indicates whether the domain administrator can customize Plesk desktop. Data type: Boolean. The manage_subftp node is optional. It indicates whether the domain administrator can manage additional FTP accounts created on the domain. Data type: Boolean. The element is supported beginning with version 1.4.1.0 of API RPC. The manage_spamfilter node is optional. It indicates whether the domain administrator can manage the spam filter. Data type: Boolean. Is supported by API RPC 1.4.2.0 and later. Is used for Plesk for UNIX only. The allow_local_backups node is optional. It indicates whether the domain administrator can use the local repository for backup/restore operations. Data type: Boolean. Is supported by API RPC 1.4.2.0 and later. Is used for Plesk for UNIX only. The allow_ftp_backups node is optional. It indicates whether the domain administrator can use the FTP repository for backup/restore operations. Data type: Boolean. Is supported by API RPC 1.4.2.0 and later.

Supported Operations

314

The following sample packet creates a domain account and sets Domain Administrator information and permissions:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>192.0.2.123</ip_address> </gen_setup> <user> <enabled>true</enabled> <password>123456</password> <cname>technolux</cname> <pname>Stephen Holmes</pname> <phone>2121342526</phone> <fax>2121342527</fax> <email>sholmes@technolux.ca</email> <address>Gray Lake Road, 12</address> <city>Totonto</city> <state/> <pcode/> <country>CA</country> <multiply_login>false</multiply_login> <permissions> <manage_quota>true</manage_quota> <manage_subdomains>true</manage_subdomains> <manage_anonftp>true</manage_anonftp> <manage_webapps>true</manage_webapps> <manage_maillists>true</manage_maillists> <manage_drweb>true</manage_drweb> <make_dumps>true</make_dumps> <manage_ftp_password>true</manage_ftp_password> <manage_performance>true</manage_performance> <manage_domain_aliases>true</manage_domain_aliases> <dashboard>true</dashboard> <manage_dashboard>true</manage_dashboard> <manage_subftp>true</manage_subftp> <allow_ftp_backups>true</allow_ftp_backups> </permissions> </user> </add> </domain> </packet>

Supported Operations

315

Hosting Settings Hosting settings are described by two data types. Complex type domainHostingAgentSet is used in the add and set request packets. Complex type domainHostingAgentGet is used in the get response packets.

Both data types are similar, except they specify their vrt_hst nodes using different data types: The vrt_hst node is required if physical hosting is specified on the domain. Data type: none. Extended by: domainPhHostingSet (plesk_domain.xsd). See the structure of this node in the Node vrt_hst (type domainPhHostingSet) (see page 317) subtopic. The vrt_hst node is required if physical hosting is specified on the domain. Data type: none. Extended by: domainPhHostingGet (plesk_doman.xsd). See the structure of this node in the Node vrt_hst (type domainPhHostongGet) sub-topic.

The std_fwd node is required if standard forwarding is specified on the domain. Data type: none. Extended by: domainFFHostingBase (plesk_domain.xsd). See the structure of this node in the Node std_fwd (see page 320) sub-topic. The frm_fwd node is required if frame forwarding is specified on a domain. Data type: none. Extended by: domainSFHostingBase (plesk_domain.xsd). See the structure of this node in the Node frm_fwd (see page 321) sub-topic. The none node is required if no hosting is specified on a domain. If specified, hosting settings will be deleted. Data type: none.

The following request add packet sent by Administrator creates a domain with disabled hosting :
<packet version=1.4.1.2> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <status>0</status> </gen_setup> <hosting>

Supported Operations <none/> </hosting> </add> </domain> </packet>

316

Supported Operations

317

Node vrt_hst (type domainPhHostingSet) The vrt_hst node is used in the add and set request packets. It is presented by complex type domainPhHostingSet. This node is structured as follows: The ftp_login node is required. It specifies the login name of the FTP account created on the domain. Data type: string (1 to 17 characters long, allowed characters: a-z, A-Z, 0-9, _, .). The ftp_password node is required. It specifies the password of the FTP account created on the domain. Data type: string (up to 64 characters long, not equal to FTP login). The ftp_quota node is optional. It restricts the disk space (in bytes) allotted for FTP needs on the domain. Data type: integer. For details on unlimited values for FTP quota, refer to the table below. The fp node is optional. It enables/disables FrontPage support on the domain. Data type: Boolean. The fp_ssl node is optional. It enables/disables support for FrontPage via SSL. Data type: Boolean. The fp_auth node is optional. It allows/disallows authoring using FrontPage on the domain. Data type: Boolean. The fp_admin_login node is optional. It specifies the login name of the FrontPage administrator (if FP is supported on the domain). Data type: string (up to 16 characters long). The fp_admin_password node is optional. It specifies the password of the FrontPage administrator (if FP is supported on the domain). Data type: string (up to 20 characters long).

The ssl node is optional. It indicates whether the domain is accessed via SSL connection. Data type: Boolean.

Supported Operations

318

The shell node is optional. It allows/disallows shell access to Plesk with FTP user login credentials. Data type: string (up to 255 characters long). Allowed values in UNIX: the default value (/bin/false) disables shell access. A path of a shell command interpreter (like /bin/sh or /bin/bash) allows shell access. Allowed values in Windows: Login Enabled | Login Disabled. Starting with API RPC v.1.4.1.0, you can choose between nodes <shell> and <shell-forbidden> (the latter node prohibits shell access to Plesk). The shell-forbidden node is optional. It is used to prohibit shell access to Plesk for FTP users of the domain. Data type: none. This node is used in API RPC 1.4.1.0 and higher. The php node is optional. It enables/disables PHP support on the domain. Data type: Boolean. The php_isapi node in optional. If set to true, it indicates that PHP scripts are executed by IIS as ISAPI extensions (otherwise they are executed as CGI applications). Data type: Boolean. This parameter makes sense for Plesk for Windows only. It is supported by API RPC beginning with version 1.4.1.0. The ssi node is optional. It enables/disables SSI support on the domain. Data type: Boolean. The ssi_html node is optional. If set to true, it indicates that the web server should look in HTML and HTM files for SSI scenarios (they are normally used in SHTML, SHTM, STM files). Data type: Boolean. This parameter makes sense for Plesk for Windows only. It is supported by API RPC beginning with version 1.4.1.0. The cgi node is optional. It enables/disables CGI support on the domain. Data type: Boolean. The mod_perl mode is optional. It enables/disables Perl support on the domain. Data type: Boolean. The mod_python node is optional. It enables/disables Python support on the domain. Data type: Boolean. The asp node is optional. It enables/disables Apache ASP support on the domain. Data type: Boolean The asp_dot_net node is optional. It enables/disables support for ASP.NET on the domain. Data type: Boolean. This parameter makes sense for Plesk for Windows only. The managed_runtime_version node is optional. It specifies ASP.NET version which is default for the domain. Data type: string. Allowed values: 1.0 | 2.0. This parameter makes sense for Plesk for Windows only. It is supported by API RPC beginning with version 1.4.0.0 The coldfusion node is optional. It enables/disables Coldfusion support on the domain. Data type: Boolean. The webstat node is optional. It specifies the web server statistics processor to be used on the domain. Data type: string. Allowed values: none | awstats | webalizer | smarterstats | urchin. The webstat_protected node is optional. If set to true, indicates that statistics is accessible via a password protected directory (/plesk-stat/). Data type: Boolean. The errdocs node is optional. If set to true, indicates that the use of custom error documents is enabled on the domain. Data type: Boolean. The wuscripts node is optional. Indicates whether web user scripts are allowed for execution on the domain. Data type: Boolean. Is supported by API RPC 1.4.2.0 and later.

Supported Operations

319

The at_domains node is optional. It enables/disables support for the @<domain_name> format on the domain. Data type: Boolean. The sb_publishing node is optional. It enables/disables publishing web site on the domain using SiteBuilder. Data type: Boolean. This element is supported starting with API RPC v.1.4.2.0. Makes sense for Plesk for Windows only. The php_safe_mode node is optional. It enables/disables executing php script files in the safe mode on the domain. Data type: Boolean. The iis_app_pool node is optional. It enables/disables IIS application pool on the domain. Data type: Boolean. This element is supported beginning with version 1.4.1.0 of API RPC. Makes sense for Plesk for Windows only. The fastcgi node is optional. It indicates whether the FastCGI technology is supported on the domain. Data type: Boolean. This feature is supported by API RPC 1.4.2.0 and later. Makes sense for Plesk for UNIX only. The php-version node is optional. It specifies what version of PHP should be default for domain directory. Data type: string. Allowed values: 4 | 5. This element is supported starting with API RPC v.1.4.2.0. Makes sense for Plesk for Windows only. The create-sb-subdomains node is optional. It specifies if the SiteBuilder blog and photo gallery subdomains should be created on the domain. Data type: boolean. This element is supported starting with API RPC v.1.4.2.0. Makes sense for Plesk for Windows only. The ip_address node is required. It specifies the IP address associated with the domain. Data type: ip_address (common.xsd).

Values for unlimited FTP quota parameter.


API RPC 1.4.2.0 and earlier Plesk for Windows Plesk for Unix 0 -1 API RPC 1.5.0.0 and later -1 -1

The following sample packet creates a new domain and specifies physical hosting settings for it:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>123.123.123.123</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>ftpuser</ftp_login> <ftp_password>12345</ftp_password> <php>true</php> <ssi>true</ssi> <cgi>true</cgi>

Supported Operations <php_safe_mode>true</php_safe_mode> <ip_address>123.123.123.123</ip_address> </vrt_hst> </hosting> </add> </domain> </packet>

320

If the gen_setup node specifies an IP address and the hosting node indicates a different IP address then the second IP address will be valid. Node std_fwd The std_fwd node is used to specify standard forwarding on a domain. When the user goes to the domain on which standard forwarding is set, Plesk redirects this user from the requested URL to the destination URL. This is done explicitly: the user sees the real destination address in the path bar of the browser. The std_fwd node is structured as follows: The dest_url node is required. It specifies the URL to which the user will be redirected explicitly at the attempt to visit the specified domain. Data type: forwardingUrl (string, 1 to 255 characters long, spaces not allowed). The ip_address node is required. It specifies the IP address associated with the domain. Data type: ip_address (common.xsd).

The following sample packet specifies standard forwarding for a new domain:
<packet version=1.4.1.2> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>123.123.123.123</ip_address> <status>0</status> </gen_setup> <hosting> <std_fwd> <dest_url>www.olddomain.com</dest_url> <ip_address>123.123.123.123</ip_address> </std_fwd> </hosting> </add> </domain> </packet>

Supported Operations

321

Node frm_fwd The frm_fwd node is used to specify frame forwarding on a domain. When the user goes to the domain on which frame forwarding is set, Plesk redirects this user from the requested URL to the destination URL implicitly (the user still sees the initial URL in the path bar of the browser).

The dest_url node is required. It specifies the URL to which the user will be redirected implicitly at the attempt to visit the specified domain. Data type: forwardingUrl (string, 1 to 255 characters long, spaces not allowed). The ip_address node is required. It specifies the IP address associated with the domain. Data type: ip_address (common.xsd).

The following sample packet specifies frame forwarding for a new domain:

<packet version=1.4.1.2> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>123.123.123.123</ip_address> <status>0</status> </gen_setup> <hosting> <frm_fwd> <dest_url>www.testdomain.com</dest_url> <ip_address>123.123.123.123</ip_address> </frm_fwd> </hosting> </add> </domain> </packet>

Supported Operations

322

Disk Space Usage Settings


Disk usage settings restrict the amount of disk space set for various entities (logs, folders, databases, etc.) on a domain. To get these settings from Plesk database, send the get packet and receive the response. The returned disk_usage node has no data type, it is nested within the data node (described in plesk_domain.xsd) and has the following structure.

The httpdocs node is required. Specifies the amount of disk space (in bytes) occupied by the /httpdocs directory. Data type: long. The httpsdocs node is required. Specifies the amount of disk space (in bytes) occupied by the /httpsdocs directory. Data type: long. The subdomains node is required. Specifies the amount of disk space (in bytes) occupied by subdomains of this domain. Data type: long. The web_users node is required. Specifies the amount of disk space (in bytes) allotted for web users on the domain. Data type: long. The anonftp node is required. Specifies the amount of disk space (in bytes) occupied by anonymous FTP. Data type: long.

Supported Operations

323

The logs node is required. Specifies the amount of disk space (in bytes) occupied by logs. Data type: long. The dbases node is required. Specifies the amount of disk space (in bytes) occupied by databases created for the domain. Data type: long. Makes sense for Plesk for UNIX only. The mysql_dbases node is required. Specifies the amount of disk space (in bytes) occupied by MySQL databases created for the domain. Data type: integer. Makes sense for Plesk for Windows only. The mssql_dbases node is required. Specifies the amount of disk space (in bytes) occupied by MSSQL databases created for the domain. Data type: integer. Makes sense for Plesk for Windows only. The mailboxes node is required. Specifies the amount of disk space (in bytes) allotted by mailboxes of the domain. Data type: long. The webapps node is required. Specifies the amount of disk space (in bytes) occupied by Tomcat web applications deployed on the domain. Data type: long. The maillists node is required. Specifies the amount of disk space (in bytes) occupied by mailing lists created on the domain. Data type: long. The domaindumps node is required. Specifies the amount of disk space (in bytes) occupied by dumps of the domain. Data type: long. The configs node is required. Specifies the amount of disk space (in bytes) occupied by configuration files of the domain. Data type: long. Makes sense for Plesk for UNIX only. It is supported beginning with API RPC 1.3.5.0. The chroot node is required. Specifies the amount of disk space (in bytes) occupied by the /chroot directory on the domain. Data type: long. Makes sense for Plesk for UNIX only. It is supported beginning with API RPC 1.3.5.0.

Most of these settings cannot be set up directly. You can set only two of them: mailboxes and maillists. The disk_usage node of the set request packet does not have its own data type and is structured as follows:

The mailboxes node is optional. Specifies the amount of disk space (in bytes) allotted by mailboxes of the domain. Data type: long. The maillists node is optional. Specifies the amount of disk space (in bytes) occupied by mailing lists created on the domain. Data type: long.

The following set request packet sets the limits on the hard disk space for email boxes and mailing lists:
<packet version=1.4.2.0> <domain> <set> <filter> <id>123</id> <id>124</id> </filter> <values> <disk_usage>

Supported Operations <mailboxes>1073741824</mailboxes> <maillists>1048576</maillists> </disk_usage> </values> </set> </domain> </packet>

324

The following get response packet returns the disk usage information for the specified domain:
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status> <filter-id>technolux.co.uk</filter-id> <id>2435</id> <data> <disk_usage> <httpdocs>2097152</httpdocs> <httpsdocs>1572864</httpsdocs> <subdomains>12582945</subdomains> <web_users>130023456</web_users> <anonftp>12582975</anonftp> <logs>4194312</logs> <dbases>4194325</dbases> <mailboxes>12582978</mailboxes> <webapps>3145728</webapps> <maillists>1048523</maillists> <domaindumps>209715200</domaindumps> <configs>25078</configs> <chroot>2095647</chroot> </disk_usage> </data> </result> </get> </domain> </packet>

This packet is specific for API RPC 1.4.2.0: the response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain name, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature.

Supported Operations

325

Statistics Settings
Statistics settings can be received from Plesk server in the get response packet. The stat node of the get response packet is defined by the domainStat data type (plesk_domain.xsd) and contains a collection of statistics data for the specified domains. This node is structured as follows:

The traffic node is required. It returns the traffic (in bytes) spent by the domain during the current day. Data type: size (unsignedLong). The subdom node is required. It holds the number of subdomains created on the domain. Data type: unsignedInt. The wu node is required. It holds the number of web users created on the domain. Data type: unsignedInt. The box node is required. It holds the number of email boxes created for the domain. Data type: unsignedInt. The redir node is required. It returns the number of redirects created for the domain. Data type: unsignedInt. The mg node is required. It returns the number of mailing groups created on the domain. Data type: unsignedInt. The resp node is required. It returns the number of autoresponders created on the domain. Data type: unsignedInt.

The maillists node is required. It returns the number of mailing lists created on the domain. Data type: unsignedInt. The db node is required. It holds the number of databases created for the domain. Data type: unsignedInt. The webapps node is required. It returns the number of Java applications installed on the domain. Data type: unsignedInt. The traffic_prevday node is required. It returns the traffic (in bytes) spent by the domain during the previous day. Data type: unsignedLong.

Supported Operations

326

The following response packet returns statistics settings for two filtered domains (ID 2435 and ID 2567):
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> <data> <stat> <traffic>12458966221478885</traffic> <subdom>12</subdom> <wu>134</wu> <box>1024</box> <redir>2</redir> <mg>16</mg> <resp>124</resp> <maillists>4<maillists> <db></db> <webapps>8</webapps> <traffic_prevday>15241632184739856</traffic_prevday> </stat> </data> </result> <result> <status>ok</status> <filter-id>2567</filter-id> <id>2567</id> <data> <stat> <traffic>5896615637124</traffic> <subdom>10</subdom> <wu>18</wu> <box>102</box> <redir></redir> <mg>11</mg> <resp>12</resp> <maillists>6<maillists> <db>2</db> <webapps>5</webapps> <traffic_prevday>152562874868127</traffic_prevday> </stat> </data> </result> </get> </domain> </packet>

This packet is specific for API RPC 1.4.2.0: the response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain ID, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature.

Supported Operations

327

Domain Preferences
Domain preferences are defined by the prefs node. This node is specified by the domainPrefs (plesk_domain.xsd). It is structured as follows:

The www node is optional. It enables/disables the use of the www prefix with the domain name. Data type: Boolean. The stat_ttl node is optional. It specifies the number of months during which the domain traffic statistics is kept. Data type: integer. The maximal value: 999999.

The following sample packet creates a domain account and sets domain preferences:

<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>192.0.2.123</ip_address> </gen_setup> <prefs> <www>false</www> <stat_ttl>6</stat_ttl> </prefs> </add> </domain> </packet>

Supported Operations

328

Performance Settings
Domain performance settings are defined by the performance node. This node is specified by complex type DomainPerformanceType (plesk_domain.xsd). This type is structured as follows:

The bandwidth node is optional. It restricts the network use by the specified value (Kb/sec) for the domain. Data type: integer. If set to -1, the bandwidth is unlimited. The max_connections node is optional. It restricts the number of connections by the specified value for the domain. Data type: integer. If set to -1, the number of connections is unlimited.

Note: All operations on domain performance settings are supported in API RPC beginning with version 1.4.1.0.

The following sample packet creates a domain account and sets performance settings:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>192.0.2.123</ip_address> </gen_setup> <performance> <bandwidth>1000</bandwidth> <max_connections>20</max_connections> </performance> </add> </domain> </packet>

To undo the performance settings for this domain, send a packet as follows:
<packet version=1.4.2.0> <domain> <set> <filter> <domain_name>newdomain.com</domain_name> </filter>

Supported Operations <values> <performance> <bandwidth>-1</bandwidth> <max_connections>-1</max_connections> </performance> </values> </set> </domain> </packet>

329

Creating Domain Account


A domain account can be created by Plesk Administrator or by Plesk Client. To register a new domain account in Plesk database, it is enough to specify some general setup information, namely: the domain name, the IP address. If the domain is created by Plesk Administrator, the domain owner (a certain Plesk Client) needs to be specified too. In addition, you can specify various domain settings when creating a domain account (all of them are optional): Hosting settings (see page 305) Hosting performance settings (see page 327) Limits (see page 305) on use of Plesk resources Domain preferences (see page 326) Domain administrator settings (see page 302) Domain template

A domain account can have all these settings specified, or it can hold just some of them. You can specify domain settings when creating a domain account or later (they can be set using the set operation). The only exception from this rule is a domain template: it cannot be applied to the domain after it is created. To learn more about the domain templates management via API RPC, proceed to section Managing Domain Templates (see page 411).

Request Packet Structure


A request XML packet adding a new domain account to Plesk database includes the add operation node:
<packet version=1.4.2.0> <domain> <add> </add> </domain> </packet>

Supported Operations

330

The add node does not have a separate type, it is nested within type DomainTypeRequest (domain_input.xsd). The add node has the following graphics representation:

The gen_setup node is required. It is used to specify the most important information about the domain account, that is: the name of the new domain, the Plesk client who owns this domain, the hosting type used for this domain, the IP address associated with the domain, and the status got by the domain right after it is created. Data type: setGenSetupType (plesk_domain.xsd). See the structure of this node in the General Account Information (see page 299) topic. The hosting node is optional. It specified hosting settings set for the domain. Data type: domainHostingAgentSet (plesk_domain.xsd). See the structure of this node in the Hosting Settings (see page 305) topic. The limits node is optional. It specifies limits imposed on use of Plesk resources for this domain. Data type: domainLimits (plesk_domain.xsd). See the structure of this node in the Limits (see page 305)topic. The prefs node is optional. It specifies a collection of domain preferences. Data type: domainPrefs (plesk_domain.xsd). See the structure of this node in the Domain Preferences (see page 326) topic. The user node is optional. Is specifies Domain Administrator settings (login, password, phone, fax, email address, postal address, and so on.). Data type: domainUserSet (plesk_domain.xsd). See the structure of this node in the Domain Administrator Settings (see page 302) topic. The performance node is optional. It specifies a collection of domain performance settings (bandwidth, the maximal number of connections). Data type: DomainPerformanceType (plesk_domain.xsd). This node is available in API RPC 1.4.1.0 and later. See the structure of this node in the Performance Settings (see page 327) topic. The template-id node is optional. It specifies the domain template by id if it is necessary to create a domain using a domain template. Data type: id_type (integer). This node is available in API RPC 1.4.1.0 and later. To learn more about domain templates, proceed to section Managing Domain Templates (see page 411).

Supported Operations

331

The template-name node is optional. It specifies the domain template by name if it is necessary to create a domain using a domain template. Data type: string. This node is available in API RPC 1.4.1.0 and later. To learn more about domain templates, proceed to section Managing Domain Templates (see page 411).

Request Samples
Creating domain accounts under different Plesk users Domain accounts can be created by Plesk Administrator and Plesk Clients. Here is a sample request packet that can be used by Plesk Client to create a domain account. The domain account is created with a minimal collection of settings.
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <htype>vrt_hst</htype> <ip_address>192.0.2.123</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.0.2.54</ip_address> </vrt_hst> </hosting> </add> </domain> </packet>

The same packet sent by Plesk Administrator should specify the client that will own this domain:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <htype>vrt_hst</htype> <ip_address>192.0.2.123</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.0.2.54</ip_address> </vrt_hst> </hosting> </add> </domain> </packet>

Supported Operations

332

Creating multiple domain accounts To create two domain accounts with a single packet, include two different add nodes:
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <htype>vrt_hst</htype> <ip_address>192.0.2.123</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.0.2.54</ip_address> </vrt_hst> </hosting> </add> <add> <gen_setup> <name>testdomain.com</name> <ip_address>192.0.2.124</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.0.2.54</ip_address> </vrt_hst> </hosting> </add> </domain> </packet>

Using a domain template The following sample packet creates a domain account based on the domain template.
<packet version=1.4.2.0> <domain> <add> <gen_setup> <name>newdomain.com</name> <htype>vrt_hst</htype> <ip_address>192.0.2.123</ip_address> <status>0</status> </gen_setup> <hosting> <vrt_hst> <ftp_login>c4u7dwbc2y8</ftp_login> <ftp_password>qweqwe</ftp_password> <ip_address>192.0.2.54</ip_address> </vrt_hst> </hosting>

Supported Operations <template-name>base_template</template-name> </add> </domain> </packet>

333

Note: To see the sample packets that set optional domain settings (hosting settings, limits, preferences, and others), proceed to a related topic in the Domain Settings (on page 295)section.

Response Packet Structure


The add node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested add operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the add operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the add operation fails. Data type: string. The id node is optional. It is required if the add operation succeeds. Returns the unique identifier of the domain account just added to Plesk. Data type: integer.

Response Samples
A positive response got from the server after adding a new domain account looks as follows:
<packet version=1.4.2.0> <domain> <add> <result> <status>ok</status> <id>2435</id>

Supported Operations </result> </add> </domain> </packet>

334

A negative response can look as follows (you can get a different error code depending on what caused the failure):
<packet version=1.4.2.0> <domain> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </domain> </packet>

Getting Information About Domain Accounts


Plesk Administrator can request any information about any domain account registered in Plesk database. Plesk Client can get this information about own domain accounts. This information is as follows: general information (domain name and id, hosting type, the owner) hosting settings performance settings limits on use of Plesk resources domain preferences domain administrator settings disk usage a domain template used to create a domain

Plesk user can get all information in bulk or specify certain kinds of information (e.g., only hosting settings). The information can be selected for a certain domain, for a group of domains, for all domains belonging to a certain client (or several), or for all domains registered in Plesk. To request the information about domains, use a request XML packet with the get operation.

Supported Operations

335

Request Packet Structure


A request XML packet getting information about the specified domain(s) includes the get operation node:
<packet version=1.4.2.0> <domain> <get> </get> </domain> </packet>

The get node does not have a separate data type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The get node has the following graphics representation:

The filter node is required. It specifies domains whose information will be got from Plesk database. Data type: DomainFilterType (domain_input.xsd). To see the structure of this node, proceed to topic Filtering Issues (see page 292). The dataset node is required. It specifies what type of information about the specified domains is requested. Data type: domainDatasetType (plesk_domain.xsd). The gen_info node is optional. It is used to request general information about the specified domains. Data type: none. The hosting node is optional. It is used to request hosting settings of the specified domains. Data type: none. The limits node is optional. It is used to request the limits on Plesk resources set for the specified domains. Data type: none. The stat node is optional. It is used to request statistics settings of the specified domains. Data type: none. The prefs node is optional. It is used to request preferences set for the specified domains. Data type: none.

Supported Operations

336

The user node is optional. It is used to request the disk usage information for the specified domains. Data type: none. The performance node is optional. It is used to request performance settings set for the specified domains. Data type: none. This node is supported in API RPC 1.4.0.0 and higher.

Request Samples
Getting multiple domains under Plesk Administrator Multiple domains can be specified within one filter either by id, or by domain_name. The following packet is invalid as it uses both id and domain_name nodes within one filter:
<packet version=1.4.2.0> <domain> <get> <filter> <id>123</id> <id>124</id> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

To specify some domains by id and others by domain_name, use different <get> sections:
<packet version=1.4.2.0> <domain> <get> <filter> <id>123</id> <id>124</id> </filter> <dataset> <hosting/> </dataset> </get> <get> <filter> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

Supported Operations

337

To get the information about all domains registered in Plesk, the following packet can be used:
<packet version=1.4.2.0> <domain> <get> <filter/> <dataset> <hosting/> </dataset> </get> </domain> </packet>

To get all domains of a certain Plesk Client, use group filtering (see topic Filtering Issues (see page 292) for details). Plesk Clients whose domains are requested can be specified within one filter either by client_id or by client_login.
<packet version=1.4.2.0> <domain> <get> <filter> <client_login>technolux</client_login> <client_login>technologic</client_login> </filter> <dataset> <hosting/> </dataset> </get> <get> <filter> <client_id>1342</client_id> <client_id>1452</client_id> </filter> <dataset> <hosting/> </dataset> </get> </domain> </packet>

You cannot specify clients by login and by id in one filter. Use different filters (and <get> sections) instead. Getting multiple domains under Plesk Client Plesk Clients can manage their own domain accounts only. They cannot apply group filtering using nodes client_id and client_login. In all other respects, the request packets shown above can be used by Plesk Clients too.

Supported Operations

338

One more exception is: the following packet gets the information about all domains belonging to the calling Plesk Client.
<packet version=1.4.2.0> <domain> <get> <filter/> <dataset> <hosting/> </dataset> </get> </domain> </packet>

Getting different types of information To get the whole set of information about domains registered in Plesk, use the following packet:
<packet version=1.4.2.0> <domain> <get> <filter> <client_login>technolux</client_login> </filter> <dataset/> </get> </domain> </packet>

This packet gets the whole information about all domains belonging to a certain Plesk Client. To specify a particular kind of information (e.g. hosting settings, limits, and statistics settings), show it in the dataset section as follows:
<packet version=1.4.2.0> <domain> <get> <filter> <id>123</id> </filter> <dataset> <hosting/> <limits/> <stat/> </dataset> </get> </domain> </packet>

Supported Operations

339

Response Packet Structure


The get node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested get operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Ii is used to return the error code when the get operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the get operation fails. Data type: string. The filter-id node is optional. Is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple. The id node is optional. The node is always missing if the request packet fails before the validation on the server side. If present, it returns the identifier of the domain whose settings are requested. Data type: integer. The data node is optional. It is used to return a collection of requested domain settings if the get operation succeeds. Data type: none.

Supported Operations

340

The data node of the response get packet is structured as follows:

The gen_info node is optional. If specified in the request packet, it returns a collection of general domain settings. Data type: domainGenInfoType (plesk_domain.xsd). See the General Account Information (see page 296) topic for details. The hosting node is optional. If specified in the request packet, it returns hosting settings of the specified domain. Data type: domainHostingAgentGet (plesk_domain.xsd). See the Hosting Settings (see page 305)topic for details. The limits node is optional. If specified in the request packet, it returns a collection of limits set for the specified domains. Data type: domainLimits (plesk_domain.xsd). See the Limits (see page 305)topic for details. The stat node is optional. If specified in the request packet, it returns a collection of statistics settings set for the specified domain(s). Data type: domainStat (plesk_domain.xsd). See the Statistics Settings (see page 324) topic for details. The prefs node is optional. If specified in the request packet, it returns a collection of preferences set for the specified domains. Data type: domainPrefs (plesk_domain.xsd). See the Domain Preferences (see page 326) topic for details. The user node is optional. If specified in the request packet, it returns a collection of domain administrator settings. Data type: domainUserGet (plesk_domain.xsd). See the Domain Administrator Settings (see page 303)topic for details. The disk_usage node is optional. If specified in the request packet, it returns a collection of hard disk limits set for the specified domains. Data type: none. See the Disk Usage Settings (see page 322)topic for details. The performance node is optional. If specified in the request packet, it returns a collection of performance settings set for the specified domains. Data type: DomainPerformanceType (plesk_domain.xsd). See the Performance Settings (see page 327) topic for details. This node is supported in API RPC 1.4.0.0 and higher.

Supported Operations

341

Response Samples
A positive response received from the server contains the information for each requested domain in a separate result block. The following response packet returns domain preferences for two specified domains:
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> <data> <prefs> <www>true</www> </prefs> </data> </result> <result> <status>ok</status> <id>2567</id> <data> <prefs> <www>true</www> <stat_ttl>6</stat_ttl> </prefs> </data> </result> </get> </domain> </packet> <packet version=1.4.1.2> <domain> <get> <result> <status>ok</status> <id>2435</id> <data> <prefs> <www>true</www> </prefs> </data> </result> <result> <status>ok</status> <id>2567</id> <data> <prefs> <www>true</www> <stat_ttl>6</stat_ttl> </prefs> </data> </result> </get> </domain> </packet>

Supported Operations

342

Notice the difference in these identical packets sent using different versions of API RPC: versions 1.4.1.2 and earlier return the domain identifier in its id node; versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

If you need an example of a particular setting returned in the response get packet, proceed to a related topic of the Domain Settings (on page 295) section. If the request get packet asks for a certain kind of settings, but the specified domain is missing these settings in the database, the response get packet will return the requested node (e.g. prefs) empty:
<packet version=1.4.2.0> <domain> <get> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> <data> <prefs/> </data> </result> </get> </domain> </packet> <packet version=1.4.1.2> <domain> <get> <result> <status>ok</status> <id>2435</id> <data> <prefs/> </data> </result> </get> </domain></packet>

If the get operation fails, a negative response can look as follows (you can get a different error code depending on the cause of the failure):
<packet version=1.4.2.0> <domain> <get> <result> <status>error</status> <errcode>1013</errcode>

Supported Operations <errtext>Object not found.</errtext> <filter-id>1234</filter-id> </result> </get> </domain> </packet> <packet version=1.4.1.2> <domain> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </get> </domain> </packet>

343

The left packet is sent via API RPC 1.4.1.2 and does not return the domain identifier. The right packet is sent using API RPC 1.4.2.0, it indicates the filtering parameter (this time the domain ID) in the filter-id node.

Deleting Domain Accounts


Domain accounts can be deleted individually or in bulk. Plesk Administrator can delete any domain account available in Plesk, while Plesk Clients can delete their own domain accounts only. Domain accounts are deleted by sending a del request packet to Plesk server.

Request Packet Structure


A request XML packet that deletes domain accounts should include the del operation node:
<packet version=1.4.2.0> <domain> <del> </del> </domain> </packet>

The del node does not have a separate type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The del node has the following graphics representation:

Supported Operations

344

The filter node is required. It indicates domains to be deleted. Data type: DomainFilterType (domain_input.xsd). To see the structure of this node, proceed to topic Filtering Issues (see page 292).

Request Samples
Deleting multiple domain accounts under Plesk Administrator To delete multiple domains, the request packet should filter them either by id, or by domain_name. The following packet is invalid as it uses both id and domain_name nodes within one filter:
<packet version=1.4.2.0> <domain> <del> <filter> <id>123</id> <id>124</id> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> </del> </domain> </packet>

To filter some domains by id and others by domain_name, use different <del> sections:
<packet version=1.4.2.0> <domain> <del> <filter> <id>123</id> <id>124</id> </filter> </del> <del> <filter> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> </del> </domain> </packet>

To delete all domains registered in Plesk, the following packet can be used:
<packet version=1.4.2.0> <domain> <del> <filter/> </del> </domain> </packet>

Supported Operations

345

To delete all domains of a certain Plesk Client, use group filtering (see topic Filtering Issues (see page 292) for details). Plesk Clients whose domains are deleted can be specified within one filter either by client_id or by client_login.
<packet version=1.4.2.0> <domain> <del> <filter> <client_login>technolux</client_login> <client_login>technologic</client_login> </filter> </del> <del> <filter> <client_id>1342</client_id> <client_id>1452</client_id> </filter> </del> </domain> </packet>

You cannot specify clients by login and by id in one filter. Use different filtering rules instead.

Response Packet Structure


The del node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested del operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the del operation. Data type: string. Allowed values: ok | error.

Supported Operations

346

The errcode node is optional. It is used to return an error code when the del operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the del operation fails. Data type: string. The filter-id node is optional. Is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple. The id node is optional. It is missing if the request packet fails before the validation on the server side. If present, this node identifies the deleted domain. Data type: integer.

Supported Operations

347

Response Samples
A positive response got from the server after deleting the specified domains (e.g. with id = 2435 and id = 2446) looks as follows:
<packet version=1.4.1.2> <domain> <del> <result> <status>ok</status> <id>2435</id> </result> <result> <status>ok</status> <id>2446</id> </result> </del> </domain> </packet> <packet version=1.4.2.0> <domain> <del> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> </result> <result> <status>ok</status> <filter-id>2446</filter-id> <id>2446</id> </result> </del> </domain> </packet>

Notice the difference in these identical packets sent using different versions of API RPC: versions 1.4.1.2 and earlier return the domain identifier in its id node; versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

A negative response can look as follows:


<packet version=1.4.1.2> <domain> <del> <result> <status>ok</status> <id>2435</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </del> </domain> </packet> <packet version=1.4.2.0> <domain> <del> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> <filter-id>2446</filter-id> </result> </del> </domain> </packet>

The left packet is sent via API RPC 1.4.1.2 and does not return the domain identifier. The right packet is sent using API RPC 1.4.2.0, it indicates the filtering parameter (this time the domain id) in the filter-id node.

Supported Operations

348

Setting Domain Parameters


Plesk Administrator can set any setting for any domain account registered in Plesk database. Plesk Clients are allowed to manage their own domains only. The settings are as follows: General domain account information (see page 296) Hosting settings (see page 305) Performance settings (see page 327) Limits (see page 305) on use of Plesk resources Disk usage settings (see page 322) Domain preferences (see page 326) Domain administrator settings (see page 302)

Plesk Administrator can change the base domain settings - the domain name, the IP address, and the domain owner (Plesk Client). A collection of domain settings can be applied to one or several domain accounts at a time. Plesk Administrator can set domain settings for all domains belonging to a certain Plesk Client, or for several clients. Domain settings are set by sending a request set packet to Plesk server.

Request Packet Structure


A request XML packet that sets a collection of domain settings should include the set operation node:
<packet version=1.4.2.0> <domain> <set> </set> </domain> </packet>

Supported Operations

349

The set node does not have a separate type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The set node has the following graphics representation:

The filter node is required. It indicates domains to be updated with the specified information. Data type: DomainFilterType (domain_input.xsd). To see the structure of this node, proceed to topic Filtering Issues (see page 292). The values node is required. It contains a collection of settings that will be set for the filtered domains. Data type: none. The gen_setup node is optional. It specifies a collection of general domain settings that will be set for the filtered domains. Data type: SetGenSetupType (plesk_domain.xsd). To see the structure of this node, proceed to topic General Account Information (see page 300). The limits node is optional. It specifies the limits on use of Plesk resources for the filtered domains. Data type: domainLimits (plesk_domain.xsd). To see the structure of this node, proceed to the Limits (see page 305)topic. The prefs node is optional. It specifies a collection of preferences for the filtered domains. Data type: domainPrefs (plesk_domain.xsd). To see the structure of this node, proceed to topic Domain Preferences (see page 326). The hosing node is optional. It specifies hosting settings for the filtered domains. Data type: domainHostingAgentSet (plesk_domain.xsd). To see the structure of this node, proceed to topic Hosting Settings (see page 305). The user node is optional. It specifies domain administrator settings. Data type: domainUserSet (plesk_domain.xsd). To see the structure of this node, proceed to topic Domain Administrator Settings (see page 302). The disk_usage node is optional. It specifies the amount of disk space allotted for email boxes and mailing lists on the filtered domain(s). Data type: none. To see the structure of this node, proceed to topic Disk Space Usage Settings (see page 322). The performance node is optional. It specifies a collection of performance settings for the filtered domains. Data type: DomainPerformanceType (plesk_domain.xsd). This node is actual beginning with API RPC 1.4.1.0 only. To see the structure of this node, proceed to topic Performance Settings (see page 327).

Supported Operations

350

Request Samples
Setting data for multiple domains under Plesk Administrator Multiple domains can be specified within one filter either by id, or by domain_name. The following packet is invalid as it uses both id and domain_name nodes within one filter:
<packet version=1.4.2.0> <domain> <set> <filter> <id>123</id> <id>124</id> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> </domain> </packet>

To specify some domains by id and others by domain_name, use different set nodes:
<packet version=1.4.2.0> <domain> <set> <filter> <id>123</id> <id>124</id> </filter> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> <set> <filter> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> </domain> </packet>

Supported Operations

351

To set the same settings for all domains registered in Plesk, the following packet can be used:
<packet version=1.4.2.0> <domain> <set> <filter/> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> </domain> </packet>

To set the same settings for all domains of a certain Plesk Client, use group filtering (see topic Filtering Issues (see page 292) for details). Plesk Clients whose domains are requested can be specified within one filter either by client_id or by client_login.
<packet version=1.4.2.0> <domain> <set> <filter> <client_login>technolux</client_login> <client_login>technologic</client_login> </filter> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> <set> <filter> <client_id>1342</client_id> <client_id>1452</client_id> </filter> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> </domain> </packet>

You cannot specify clients by login and by ID in one filter. Use different filters (and set operations) instead.

Supported Operations

352

Setting data for multiple domains under Plesk Client Plesk Clients can manage their own domain accounts only. Thus, they cannot apply group filtering using nodes client_id and client_login. In all other respects, the request packets shown for Plesk Administrator (above) can be used by Plesk Clients too. One more exception is: the following packet sets the data for all domains belonging to the calling Plesk Client.
<packet version=1.4.2.0> <domain> <set> <filter/> <values> <performance> <bandwidth>-1</bandwidth> </performance> </values> </set> </domain> </packet>

Since the set packet means the update of domain settings in Plesk database, the values node cannot be left empty. The following packet will cause the error:
<packet version=1.4.2.0> <domain> <set> <filter> <id>123</id> </filter> <values/> </set> </domain> </packet>

The values node can specify some or all kinds of settings. To see the sample packet for a certain setting, proceed to the relevant sub-topic of Domain Settings (on page 295).

Supported Operations

353

Response Packet Structure


The set node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested set operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code if the set operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the set operation fails. Data type: string. The filter-id node is optional. It is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple. The id node is optional. It is missing if the request packet fails before the validation on the server side. If present, this node identifies the domain whose settings are updated. Data type: integer.

Response Samples
A positive response got from the server after updating the specified domains (e.g. with ID 2435 and ID 2446) looks as follows:
<packet version=1.4.1.2> <domain> <set> <result> <status>ok</status> <id>2435</id> </result>

Supported Operations <result> <status>ok</status> <id>2446</id> </result> </set> </domain> </packet> <packet version=1.4.2.0> <domain> <set> <result> <status>ok</status> <filter-id>2435</filter-id> <id>2435</id> </result> <result> <status>ok</status> <filter-id>2446</filter-id> <id>2446</id> </result> </set> </domain> </packet>

354

Notice the difference in these identical packets sent using different versions of API RPC: versions 1.4.1.2 and earlier return the domain identifier in its id node; versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

A negative response can look as follows:


<packet version=1.4.1.2> <domain> <set> <result> <status>ok</status> <id>2435</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </set> </domain> </packet> <packet version=1.4.2.0> <domain> <set> <result> <status>ok</status>

Supported Operations <filter-id>2435</filter-id> <id>2435</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> <filter-id>2446</filter-id> </result> </set> </domain> </packet>

355

The left packet is sent via API RPC 1.4.1.2 and does not return the domain identifier. The right packet is sent using API RPC 1.4.2.0, it indicates the filtering parameter (this time the domain ID) in the filter-id node.

Getting the Domain Buttons List


Each domain account has its own page in Plesk GUI (Domains -> select any domain from the list). This page displays a collection of buttons. This list of buttons can be got from Plesk database for the specified domain. To do so, you need to send the cform_buttons_list request packet to Plesk server.

Request Packet Structure


A request XML packet getting the list of domain buttons includes the cform_buttons_list operation node:
<packet version=1.4.2.0> <domain> <cform_buttons_list> </cform_buttons_list> </domain> </packet>

The cform_buttons_list node does not have a separate data type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The cform_buttons_list node has the following graphics representation:

The filter node is required. It indicates domains whose buttons are requested. Data type: DomainFilterType (domain_input.xsd). To see the structure of this node, proceed to topic Filtering Issues (see page 292).

Supported Operations

356

Request Samples
Getting buttons under Plesk Administrator To get buttons for multiple domains, the cform_buttons_list request packet should filter them in the filter node either by id, or by domain_name. The following packet is invalid as it uses both id and domain_name nodes within one filter:
<packet version=1.4.2.0> <domain> <cform_buttons_list> <filter> <id>123</id> <id>124</id> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> </cform_buttons_list> </domain> </packet>

To filter some domains by id and others by domain_name, use different cform_buttons_list nodes:
<packet version=1.4.2.0> <domain> <cform_buttons_list> <filter> <id>123</id> <id>124</id> </filter> </cform_buttons_list> <cform_buttons_list> <filter> <domain_name>techservice.co.uk</domain_name> <domain_name>techknowledge.co.uk</domain_name> </filter> </cform_buttons_list> </domain> </packet>

To get buttons of all domains registered in Plesk, the following packet can be used:
<packet version=1.4.2.0> <domain> <cform_buttons_list> <filter/> </cform_buttons_list> </domain> </packet>

Supported Operations

357

To get buttons of all domains belonging to a certain Plesk Client, use group filtering (see topic Filtering Issues (see page 292) for details). Plesk Clients whose domains are filtered can be specified within one filter either by client_id or by client_login.
<packet version=1.4.2.0> <domain> <cform_buttons_list> <filter> <client_login>technolux</client_login> <client_login>technologic</client_login> </filter> </cform_buttons_list> <cform_buttons_list> <filter> <client_id>1342</client_id> <client_id>1452</client_id> </filter> </cform_buttons_list> </domain> </packet>

You cannot specify clients by login and by ID in one filter. Use different filters (and cform_buttons_list nodes) instead.

Response Packet Structure


The cform_buttons_list node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested cform_buttons_list operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd).

Supported Operations

358

The status node is required. It returns the execution status of the cform_buttons_list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return an error code if the cform_buttons_list operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the cform_buttons_list operation fails. Data type: string. The filter-id node is optional. It is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple. The id node is optional. Returns the identifier of the domain whose buttons are requested. It is missing if the request packet fails before the validation on the server side. Data type: integer. The button node is optional. It returns a collection of parameters that describe the button (see the details below). It is missing if the request packet fails before the validation on the server side. Data type: buttonDataType (plesk_common.xsd).

Buttons are described by complex type buttonDataType (plesk_common.xsd) as follows:

The code node is required. It returns the identifier of the button. Data type: string. The type node is required. It specifies the button type. Data type: string. Allowed values: link_button (a typical link that references some URL) | comm_button (a typical button whose click event calls a related event handler). The name node is required. It contains the localized button name displayed in Plesk Control Panel. Data type: string. The name_id node is required. It specifies the localization key associated with the button. Data type: string. The group_name node is required. It returns the localized name of the group containing the button. Data type: string. The group_name_id node is required. It specifies the localization key of the group name. Data type: string.

The href node is required. It returns the URL referenced by the button. Data type: string.

Supported Operations

359

The js_onclick node is optional. It returns the JavaScript code executed at the button click. Data type: text (string, white spaces are allowed). The enabled node is required. It indicates whether the button in enabled. If true, the button is active and can be used. Data type: Boolean. The new_window node is optional. It indicates whether a new window should be opened in the browser when the button is clicked. Data type: Boolean. The tabindex node is optional. It returns the buttons tabulation index. Data type: integer. Default value: 0. The conhelp_id node is optional. It specifies the localization key of the context help message associated with the button. Data type: string. The conhelp node is optional. It returns a context help message displayed in the HELP section of the Plesk navigation pane when pointing at the button with a mouse. Data type: text (string, white spaces are allowed). The icon_url node is optional. It specifies the location of the buttons icon. Data type: string.

Response Samples
A positive response with a single button displayed for the specified domain (ID 1324) looks as follows:
<packet version=1.4.1.2> <domain> <cform_buttons_list> <result> <status>ok</status> <id>1324</id> <button> <code>EDIT_BUTTON</code> <type>link_button</type> <name>Edit</name> <name_id>edit</name_id> <group_name>Tools</group_name> <group_name_id>__tools</group_name_id> <href>/domains/d_ed.php3</href> <enabled>true</enabled> <new_window>false</new_window> </button> </result> </cform_buttons_list> </domain> </packet> <packet version=1.4.2.0> <domain> <cform_buttons_list> <result> <status>ok</status> <filter-id>1324</filter-id> <id>1324</id> <button> <code>EDIT_BUTTON</code> <type>link_button</type>

Supported Operations <name>Edit</name> <name_id>edit</name_id> <group_name>Tools</group_name> <group_name_id>__tools</group_name_id> <href>/domains/d_ed.php3</href> <enabled>true</enabled> <new_window>false</new_window> </button> </result> </cform_buttons_list> </domain> </packet>

360

Notice the difference in these identical packets sent using different versions of API RPC: versions 1.4.1.2 and earlier return the domain identifier in its id node; versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

If the operation fails, a negative response can look as follows:


<packet version=1.4.1.2> <domain> <cform_buttons_list> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1324</id> </result> </cform_buttons_list> </domain> </packet> <packet version=1.4.2.0> <domain> <cform_buttons_list> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <filter-id>1324</filter-id> <id>1324</id> </result> </cform_buttons_list> </domain> </packet>

Supported Operations

361

Getting Traffic Usage Information


The get_traffic is used to retrieve information about the traffic spent by a domain between two dates. The resulting information got for each domain lists all days between the specified dates and shows the daily traffic spent by the domain during this day.

Request Packet Structure


A request XML packet getting traffic information for the specified domains includes the get_traffic operation node:
<packet version=1.4.2.0> <domain> <get_traffic> </get_traffic> </domain> </packet>

The get_traffic node does not have a separate data type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The get_traffic node has the following graphics representation:

The filter node is required. It specifies domains whose traffic information will be got from Plesk database. Data type: DomainFilterType (domain_input.xsd). To see the structure of this node, proceed to topic Filtering Issues (see page 292). The since_date node is optional. It specifies the starting date of the period. If the packet is missing this node, the analyzed days will not be limited below. Data type: date. Format: YYYY-MM-DD. The to_date node is optional. It specifies the end date of the period. If the packet is missing this element, the period will be limited by the date of the request execution. Data type: date. Format: YYYY-MM-DD.

If the packet is missing both nodes since_date and to_date, the response packet will show the traffic of the specified domain day by day since its creation and up to the date of the request execution.

Supported Operations

362

Request Samples
Getting traffic info under Plesk Administrator Plesk Administrator can get traffic information for all domains available in Plesk. Domains are specified within one filter either by id, or by domain_name. The following packet is invalid as it uses both id and domain_name nodes within one filter:
<packet version=1.4.2.0> <domain> <get_traffic> <filter> <id>1234</id> <id>1235</id> <domain_name>technolux.co.uk</domain_name> <domain_name>softlux.com</domain_name> </filter> <since_date>2006-10-01</since_date> </get_traffic> </domain> </packet>

A valid packet will use two different filter nodes (in two different get_traffic operations):
<packet version=1.4.2.0> <domain> <get_traffic> <filter> <id>1234</id> <id>1235</id> </filter> <since_date>2006-10-01</since_date> </get_traffic> <get_traffic> <filter> <domain_name>technolux.co.uk</domain_name> <domain_name>softlux.com</domain_name> </filter> <since_date>2006-10-01</since_date> </get_traffic> </domain> </packet>

To get traffic information for all domains belonging to a certain Plesk Client, use group filtering (see topic Filtering Issues (see page 292) for details). Plesk Clients whose domains are filtered can be specified within one filter either by client_id or by client_login.
<packet version=1.4.2.0> <domain> <get_traffic> <filter> <client_login>technolux</client_login> <client_login>technologic</client_login> </filter> <since_date>2006-10-01</since_date> </get_traffic>

Supported Operations <get_traffic> <filter> <client_id>1342</client_id> <client_id>1452</client_id> </filter> <since_date>2006-10-01</since_date> </get_traffic> </domain> </packet>

363

You cannot specify clients by login and by ID in one filter. Use different filters (and cform_buttons_list nodes) instead. To get traffic information for all domains available in Plesk, send the following packet:
<packet version=1.4.2.0> <domain> <get_traffic> <filter/> <since_date>2006-10-01</since_date> </get_traffic> </domain> </packet>

Response Packet Structure


The get_traffic node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested get_traffic operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the get_traffic operation. Data type: string. Allowed values: ok | error.

Supported Operations

364

The errcode node is optional. It is used to return an error code if the get_traffic operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the get_traffic operation fails. Data type: string. The filter-id node is optional. Is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple. The id node is optional. Returns the identifier of the domain whose traffic is requested. It is missing if the request packet fails before the validation on the server side. Data type: integer. The traffic node is optional. It contains a collection of traffic data obtained from Plesk server (see below). Data type: trafficType (plesk_domain.xsd).

The traffic node is defined by type trafficType (plesk_domain.xsd). It is structured as follows:

The date node is required. It specifies the date for which the traffic is shown. Data type: date. Format: YYYY-MM-DD. The http_in node is required. It shows the incoming traffic (in bytes) got via HTTP protocol. Data type: integer. The http_out node is required. It shows the outgoing HTTP traffic (in bytes). Data type: integer. The ftp_in node is required. It shows the incoming traffic (in bytes) got via FTP protocol. Data type: integer. The ftp_out node is required. It shows the outgoing FTP traffic (in bytes). Data type: integer. The smtp_in node is required. It shows the incoming traffic (in bytes) got via SMTP protocol. Data type: integer. The smtp_out node is required. It shows the outgoing SMTP traffic (in bytes). Data type: integer.

Supported Operations

365

The pop3_imap_in node is required. It shows the incoming traffic (in bytes) got via POP3 and IMAP protocols. Data type: integer. The pop3_imap_out node is required. It shows the outgoing POP3/IMAP traffic (in bytes). Data type: integer.

Response Samples
A positive response that returns the traffic spent by the specified domains can look as shown below. This packet returns the information about traffic for two dates for two domains.
<packet version=1.4.1.2> <domain> <get_traffic> <result> <status>ok</status> <id>1234</id> <traffic> <date>2005-12-12</date> <http_in>4371212365846</http_in> <http_out>1234111122</http_out> <ftp_in>4121253</ftp_in> <ftp_out>163553</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341156</smtp_out> <pop3_imap_in>1545682</pop3_imap_in> <pop3_imap_out>15434674</pop3_imap_out> </traffic> <traffic> <date>2005-12-13</date> <http_in>4371978643846</http_in> <http_out>1234548722</http_out> <ftp_in>4121153</ftp_in> <ftp_out>123653</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1511112</pop3_imap_in> <pop3_imap_out>16458674</pop3_imap_out> </traffic> </result> <result> <status>ok</status> <id>1247</id> <traffic> <date>2005-12-12</date> <http_in>4371243251846</http_in> <http_out>1234111122</http_out> <ftp_in>4125453</ftp_in> <ftp_out>123153</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1543512</pop3_imap_in> <pop3_imap_out>15436374</pop3_imap_out> </traffic> <traffic> <date>2005-12-13</date> <http_in>4371243251846</http_in>

Supported Operations <http_out>1234111122</http_out> <ftp_in>4125453</ftp_in> <ftp_out>123153</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1543512</pop3_imap_in> <pop3_imap_out>15436374</pop3_imap_out> </traffic> </result> </get_traffic> </domain> </packet> <packet version=1.4.2.0> <domain> <get_traffic> <result> <status>ok</status> <filter-id>1234</filter-id> <id>1234</id> <traffic> <date>2005-12-12</date> <http_in>4371212365846</http_in> <http_out>1234111122</http_out> <ftp_in>4121253</ftp_in> <ftp_out>163553</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341156</smtp_out> <pop3_imap_in>1545682</pop3_imap_in> <pop3_imap_out>15434674</pop3_imap_out> </traffic> <traffic> <date>2005-12-13</date> <http_in>4371978643846</http_in> <http_out>1234548722</http_out> <ftp_in>4121153</ftp_in> <ftp_out>123653</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1511112</pop3_imap_in> <pop3_imap_out>16458674</pop3_imap_out> </traffic> </result> <result> <status>ok</status> <filter-id>1247</filter-id> <id>1247</id> <traffic> <date>2005-12-12</date> <http_in>4371243251846</http_in> <http_out>1234111122</http_out> <ftp_in>4125453</ftp_in> <ftp_out>123153</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1543512</pop3_imap_in> <pop3_imap_out>15436374</pop3_imap_out> </traffic> <traffic>

366

Supported Operations <date>2005-12-13</date> <http_in>4371243251846</http_in> <http_out>1234111122</http_out> <ftp_in>4125453</ftp_in> <ftp_out>123153</ftp_out> <smtp_in>123535</smpt_in> <smtp_out>341356</smtp_out> <pop3_imap_in>1543512</pop3_imap_in> <pop3_imap_out>15436374</pop3_imap_out> </traffic> </result> </get_traffic> </domain> </packet>

367

Notice the difference in these identical packets sent using different versions of API RPC: Versions 1.4.1.2 and earlier return the domain identifier in its id node. Versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

If the operation fails, a negative response can look as follows:


<packet version=1.4.1.2> <domain> <get_traffic> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1324</id> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1247</id> </result> </get_traffic> </domain> </packet> <packet version=1.4.2.0> <domain> <get_traffic> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <filter-id>1234</filter-id> <id>1324</id> </result> <result>

Supported Operations <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <filter-id>1247</filter-id> <id>1247</id> </result> </get_traffic> </domain> </packet>

368

The right packet is sent using API RPC 1.4.2.0, it indicates the filtering parameter (this time the domain ID) in the filter-id node.

Setting Domain Traffic Settings


If the traffic usage is calculated on a domain by statistics facilities of Plesk, this data is added to Plesk automatically. If this data is gathered using some external statistics means, the set_traffic operation can help add this data to Plesk database.

Request Packet Structure


A request XML packet that sets traffic data for a certain domain should include the set_traffic operation node:
<packet version=1.4.2.0> <domain> <set_traffic> </set_traffic> </domain> </packet>

The set_traffic node does not have a separate type, it is nested within the DomainTypeRequest complex type (domain_input.xsd). The set_traffic node has the following graphics representation:

The dom_id node is required. It identifies the domain whose traffic settings are set. Data type: integer. The date node is required. It specifies the date for which the traffic data is set. Data type: date. Format: YYYY-MM-DD.

Supported Operations

369

The smtp_in node is required. It specifies the incoming traffic (in bytes) got via SMTP protocol. Data type: integer. The smtp_out node is required. It is used to show the outgoing SMTP traffic (in bytes). Data type: integer. The pop3_imap_in node is required. It specifies the incoming traffic (in bytes) got via POP3 and IMAP protocols. Data type: integer. The pop3_imap_out node is required. It is used to show the outgoing POP3/IMAP traffic (in bytes). Data type: integer.

Request Samples
To set traffic information for the specified domain, use the following packet:
<packet version=1.4.2.0> <domain> <set_traffic> <dom_id>1134</dom_id> <date>2005-12-12</date> <smtp_in>514237124628</smtp_in> <smtp_out>6153462547</smtp_out> <pop3_imap_in>49769379</pop3_imap_in> <pop3_imap_out>7236487263<pop3_imap_out> </set_traffic> </domain> </packet>

To set traffic information for multiple domains in one packet, use multiple <set_traffic> nodes:
<packet version=1.4.2.0> <domain> <set_traffic> <dom_id>1134</dom_id> <date>2005-12-12</date> <smtp_in>127417</smtp_in> <smtp_out>342899</smtp_out> <pop3_imap_in>384769</pop3_imap_in> <pop3_imap_out>37947<pop3_imap_out> </set_traffic> <set_traffic> <dom_id>1135</dom_id> <date>2005-12-12</date> <smtp_in/> <smtp_out/> <pop3_imap_in>7835683295457</pop3_imap_in> <pop3_imap_out>32876583765<pop3_imap_out> </set_traffic> </domain> </packet>

Supported Operations

370

Response Packet Structure


The set_traffic node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested set_traffic operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the set_traffic operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return an error code when the set_traffic operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the set_traffic operation fails. Data type: string. The id node is optional. Returns the identifier of the domain whose traffic is set. It is missing if the request packet fails before the validation on the server side. Data type: integer.

Response Samples
After the traffic data is put to Plesk database, a positive response sent back by Plesk server looks as follows:
<packet version=1.4.2.0> <domain> <set_traffic> <result> <status>ok</status> <id>1234</id> </result> </set_traffic> </domain> </packet>

If the request packet sets traffic data for multiple domains, the response packet will look as follows:
<packet version=1.4.2.0> <domain> <set_traffic>

Supported Operations <result> <status>ok</status> <id>1234</id> </result> </set_traffic> <set_traffic> <result> <status>ok</status> <id>1247</id> </result> </set_traffic> </domain> </packet>

371

The packet will return the result for every filtered domain within a separate set_traffic node. If the operation fails, a negative response can look as follows:
<packet version=1.4.2.0> <domain> <set_traffic> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>1324</id> </result> </set_traffic> </domain> </packet>

Supported Operations

372

Retrieving Descriptor of Limits


Use the get-limit-descriptor operation to retrieve descriptor of domain limits. For details on descriptors, refer to the Representation of Object Descriptor (on page 16) section. For details on limits of a domain, refer to the Limits (on page 306) section.

Request Packet Structure


A request XML packet retrieving domain limits descriptors includes the get-permitdescriptor operation node:
<packet version=1.5.0.0> <domain> <get-limit-descriptor> </get-limit-descriptor> </domain> </packet>

You can retrieve limits descriptor for the specified domain (or multiple domains specified by client ID or login name), or the server-level domain limits descriptor. The get-limit-descriptor node has the following graphical representation:

Supported Operations

373

The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors (on page 16) section. Data type: domainFilterType (domain_input.xsd). The id node is optional. It specifies the domain ID. Data type: integer. The client_id node is optional. It specifies the client ID. Data type: integer. The domain_name is optional. It specifies the domain name. Data type: string (UTF-8). The client_login is optional. It specifies the client name. Data type: string.

Note: You can specify multiple id, client_id, domain_name and client_login parameters in one filter node.

Request Samples
The request packet retrieving limits descriptor for the domain with ID 5 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-limit-descriptor> <filter> <id>5</id> </filter> </get-limit-descriptor> </domain> </packet>

The request packet retrieving limits descriptor for MyDomain.com and MySample.com domains looks as follows:
<packet version ="1.5.0.0"> <domain> <get-limit-descriptor> <filter> <domain_name>5</domain_name> <domain_name>7</domain_name> </filter> </get-limit-descriptor> </domain> </packet>

The request packet retrieving limits descriptor for domains of the client specified by ID 3 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-limit-descriptor> <filter> <client_id>3</client_id> </filter> </get-limit-descriptor> </domain> </packet>

Supported Operations

374

The request packet retrieving the server-level descriptor of domain limits looks as follows:
<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <filter/> </get-limit-descriptor> </client> </packet>

Response Packet Structure


The get-limit-descriptor node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd). The status node is required. It specifies the execution status of the get-limit-descriptor operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get-limitdescriptor operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the get-limitdescriptor operation fails. Data type: string. The filter-id node is optional. It is required if the get-limit-descriptor operation succeeds. Returns either domain name, domain ID, client name, or client ID depending on a way of descriptor specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. For info on filters, refer to the Filters of Descriptors (on page 23) section. Data type: anySimple.

Supported Operations

375

The id node is optional. It is required if the get-limit-descriptor operation succeeds. Returns the unique identifier of the domain. Data type: integer. The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor (on page 16). Data type: string.

Note: This descriptor contains limits extensions. For details, refer to the Extension of Limits Descriptor (see page 20) section.

Response Samples
A positive response from the server can look as follows:
<packet version="1.5.0.0"> <domain> <get-limit-descriptor> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>10</id> <descriptor> <property> <name>max_subdom</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_subdom</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_dom_aliases</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_dom_aliases</label> <extension> <shared>false</shared> </extension> </property> <property> <name>disk_space</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__disk_space</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_traffic</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__max_traffic</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_wu</name>

Supported Operations <type>int</type> <writable-by>admin</writable-by> <label>limit__max_wu</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_db</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_db</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_box</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_box</label> <extension> <shared>false</shared> </extension> </property> <property> <name>mbox_quota</name> <type>bytes</type> <writable-by>admin</writable-by> <label>limit__mbox_quota</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_redir</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_redir</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_mg</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_mg</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_resp</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_resp</label> <extension> <shared>false</shared> </extension>

376

Supported Operations </property> <property> <name>max_maillists</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_maillists</label> <extension> <shared>false</shared> </extension> </property> <property> <name>max_webapps</name> <type>int</type> <writable-by>admin</writable-by> <label>limit__max_webapps</label> <extension> <shared>false</shared> </extension> </property> <property> <name>expiration</name> <type>date</type> <writable-by>admin</writable-by> <label>limit__expiration</label> <extension> <shared>true</shared> </extension> </property> </descriptor> </result> </get-limit-descriptor> </domain> </packet>

377

If the domain specified in the request packet was not found on the server, the result is as follows:
<packet version="1.5.0.0"> <domain> <get-limit-descriptor> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>MyDomain.com</filter-id> </result> </get-limit-descriptor> </domain> </packet>

Supported Operations

378

Retrieving Descriptor of Permissions


Use the get-permission-descriptor operation to retrieve descriptor of domain administrator's permissions. For details on descriptors, refer to the Representation of Object Descriptor (on page 16) section. For details on permissions of a domain administrator, refer to the Permissions (on page 306) section.

Request Packet Structure


A request XML packet retrieving descriptor of domain administrator's permissions includes the get-permission-descriptor operation node:
<packet version=1.5.0.0> <domain> <get-limit-descriptor> </get-limit-descriptor> </domain> </packet>

You can retrieve descriptor for the specified domain (or multiple domains specified by client ID or login name) or the server-level descriptor of domain administrator permissions descriptor. The get-permission-descriptor node has the following graphical representation:

The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors (on page 16) section. Data type: domainFilterType (domain_input.xsd). The id node is optional. It specifies the domain ID. Data type: integer. The client_id node is optional. It specifies the client ID. Data type: integer. The domain_name is optional. It specifies the domain name. Data type: string (UTF-8). The client_login is optional. It specifies the client name. Data type: string.

Supported Operations

379

Note: You can specify multiple id, client_id, domain_name and client_login parameters in one filter node.

Request Samples
The request packet retrieving permissions descriptor for the domain with ID 5 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-permission-descriptor> <filter> <id>5</id> </filter> </get-permission-descriptor> </domain> </packet>

The request packet retrieving permissions descriptor for MyDomain.com and MySample.com domains looks as follows:
<packet version ="1.5.0.0"> <domain> <get-permission-descriptor> <filter> <domain_name>5</domain_name> <domain_name>7</domain_name> </filter> </get-permission-descriptor> </domain> </packet>

The request packet retrieving permissions descriptor for domains of the client specified by ID 3 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-permission-descriptor> <filter> <client_id>3</client_id> </filter> </get-permission-descriptor> </domain> </packet>

The request packet retrieving the server-level descriptor of domain administrator's permissions looks as follows:
<packet version ="1.5.0.0"> <client> <get-limit-descriptor> <filter/> </get-limit-descriptor> </client>

Supported Operations </packet>

380

Response Packet Structure


The get-permission-descriptor node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd). The status node is required. It specifies the execution status of the get-permissiondescriptor operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the getpermission-descriptor operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the getpermission-descriptor operation fails. Data type: string. The filter-id node is optional. It is required if the get-permission-descriptor operation succeeds. Returns either domain name, domain ID, client name, or client ID depending on a way of descriptor's specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. For info on filters, refer to the Filters of Descriptors (on page 23) section. Data type: anySimple. The id node is optional. It is required if the get-permission-descriptor operation succeeds. Returns the unique identifier of the domain. Data type: integer. The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor (on page 16). Data type: string.

Note: This descriptor contains permissions extensions. For details, refer to the Extension of Permissions Descriptor (on page 18) section.

Supported Operations

381

Response Samples
A positive response from the server can look as follows:
<packet version="1.5.0.0"> <domain> <get-permission-descriptor> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>10</id> <property> <name>manage_sh_access</name> <type>boolean</type> <default-value>false</default-value> <writable-by>admin</writable-by> <label>cl_perm__manage_sh_access</label> <extension> <level>client</level> <level>domain</level> </extension> </property> ... <property> <name>manage_dashboard</name> <type>boolean</type> <default-value>true</default-value> <writable-by>admin</writable-by> <writable-by>client</writable-by> <label>cl_perm__manage_dashboard</label> <extension> <level>client</level> <level>domain</level> </extension> </property> </descriptor> </result> </get-permission-descriptor> </domain> </packet>

If the domain specified in the request packet was not found on the server, the result is as follows:
<packet version="1.5.0.0"> <domain> <get-permission-descriptor> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>MyDomain.com</filter-id> </result> </get-permission-descriptor> </domain> </packet>

Supported Operations

382

Retrieving Descriptor of Hosting Settings


Use the get-physical-hosting-descriptor operation to retrieve descriptor of domain hosting settings. For details on descriptors, refer to the Representation of Object Descriptor (on page 16) section. For details on hosting settings, refer to the Hosting Settings (on page 307) section.

Request Packet Structure


A request XML packet retrieving descriptor of hosting settings includes the get-physicalhosting-descriptor operation node:
<packet version=1.5.0.0> <domain> <get-physical-hosting-descriptor> </get-physical-hosting-descriptor> </domain> </packet>

You can retrieve descriptor for the specified domain (or multiple domains specified by client ID or login name) or the server-level descriptor of hosting settings. The getphysical-hosting-descriptor node has the following graphical representation:

The filter node is required. It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors (on page 16) section. Data type: domainFilterType (domain_input.xsd). The id node is optional. It specifies the domain ID. Data type: integer. The client_id node is optional. It specifies the client ID. Data type: integer. The domain_name is optional. It specifies the domain name. Data type: string (UTF-8). The client_login is optional. It specifies the client name. Data type: string.

Supported Operations

383

Note: You can specify multiple id, client_id, domain_name and client_login parameters in one filter node.

Request Samples
The request packet retrieving descriptor of hosting settings for the domain with ID 5 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-physical-hosting-descriptor> <filter> <id>5</id> </filter> </get-physical-hosting-descriptor> </domain> </packet>

The request packet retrieving descriptor of hosting settings for MyDomain.com and MySample.com domains looks as follows:
<packet version ="1.5.0.0"> <domain> <get-physical-hosting-descriptor> <filter> <domain_name>5</domain_name> <domain_name>7</domain_name> </filter> </get-physical-hosting-descriptor> </domain> </packet>

The request packet retrieving descriptor of hosting settings for domains of the client specified by ID 3 looks as follows:
<packet version ="1.5.0.0"> <domain> <get-physical-hosting-descriptor> <filter> <client_id>3</client_id> </filter> </get-physical-hosting-descriptor> </domain> </packet>

The request packet retrieving the server-level descriptor of hosting settings looks as follows:
<packet version ="1.5.0.0"> <client> <get-physical-hosting-descriptor> <filter/> </get-physical-hosting-descriptor> </client> </packet>

Supported Operations

384

Response Packet Structure


The get-physical-hosting-descriptor node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (plesk_common.xsd). The status node is required. It specifies the execution status of the get-physicalhosting-descriptor operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get-physicalhosting-descriptor operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the getphysical-hosting-descriptor operation fails. Data type: string. The filter-id node is optional. It is required if the get-physical-hosting-descriptor operation succeeds. Returns either domain name, domain ID, client name, or client ID depending on a way of descriptor's specification in the request packet. This node is available in API RPC 1.5.0.0 and later versions. For info on filters, refer to the Filters of Descriptors (on page 23) section. Data type: anySimple. The id node is optional. It is required if the get-physical-hosting-descriptor operation succeeds. Returns the unique identifier of the domain. Data type: integer. The descriptor node is optional. It specifies the object descriptor. For details, refer to Representation of Object Descriptor (on page 16). Data type: string.

Note: This descriptor contains hosting settings extensions. For details, refer to the Extension of Hosting Settings Descriptor (on page 19) section.

Supported Operations

385

Response Samples
A positive response from the server can look as follows:
<packet version="1.5.0.0"> <domain> <get-physical-hosting-descriptor> <result> <status>ok</status> <filter-id>MyDomain.com</filter-id> <id>15</id> <descriptor> <property> <name>ftp_login</name> <type>string</type> <writable-by>admin</writable-by> <label>hst_def__fp_admin_login</label> </property> <property> <name>fp_admin_password</name> <type>passwordString</type> <writable-by>none</writable-by> <label>hst_def__fp_admin_passwd</label> </property> <property> <name>shell</name> <type>string</type> <enum> <value>/bin/false</value> <label>Forbidden</label> </enum> <enum> <value>/bin/ash</value> <label>/bin/ash</label> </enum> <enum> <value>/bin/bash</value> <label>/bin/bash</label> </enum> ... <enum> <value>/usr/local/psa/bin/chrootsh</value> <label>/bin/bash (chrooted)</label> </enum> <enum> <value>/bin/rbash</value> <label>/bin/rbash</label> </enum> <writable-by>admin</writable-by> <label>hst_def__shell</label> </property>

If the domain specified in the request packet was not found on the server, the result is as follows:
<packet version="1.5.0.0"> <domain> <get-permission-descriptor>

Supported Operations <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>MyDomain.com</filter-id> </result> </get-permission-descriptor> </domain> </packet>

386

Supported Operations

387

Managing Domain Aliases


Operator: <domain_alias> XML Schema: domainalias_input.xsd, domainalias_output.xsd Plesk version: Plesk 7.5.6 Win | Unix 8.0 and later API RPC version: 1.4.0.0 and higher Plesk user: Plesk Administrator Description Domain Aliases are alternative names for the domain name. You can also use domain aliases to redirect mail and Java applications from the domain alias to your original domain name. Tomcat (Java) redirection means that the Tomcat server set on the primary domain (port 9080) handles requests coming from domain aliases (from port 9080). Plesk Administrators can manage all domain aliases registered on Plesk server. Note: The Tomcat support is provided from the 1.4.2.0 version of API RPC. Supported operations

CREATE (see page 391) creates an alias for the specified domain GET (see page 395) retrieves the alias settings for the alias specified by ID name, or the primary domain ID, name SET (see page 401) updates the alias settings for the alias specified by ID name, or the primary domain ID, name DELETE (see page 405) removes the specified alias from the domain RENAME (see page 408) renames the alias related to the specified domain GET-SUPPORTED-SERVICES (see page 411) retrieves the list of domain alias supported services which can be managed on the server

Supported Operations

388

Remarks When you set up a domain alias, resource records in its DNS zone are copied from the original domain name. This means that if your original domain points to an external mail server, your domain alias will point to that mail server, too. However, to accept mail for the domain alias, the external mail server should be configured accordingly. Whenever you change mail exchange records in the domain DNS zone, be sure to introduce the respective changes in the DNS zone of the domain alias. If you need to serve several domain names that point to a web site hosted on another server, you should set up domain forwarding.

Domain Alias Settings


This section describes settings that can be predefined for a domain alias. These settings can be set on creation of a domain alias, or they can be set for this domain alias later, or read from the database. Domain alias settings are defined by the settings node and presented by type Settings (plesk_domainalias.xsd). It has the following graphics representation:

The status node is optional. It specifies the current status of the domain alias. This node is used only in Plesk for Unix. Data type: byte. Allowed values: 0 (alias enabled) 1 (alias disabled) 2 (primary domain disabled) 3 (alias disabled, primary domain disabled)

The pref node is optional. If specified, it defines the alias form. To specify the alias form, choose between the following options: (API RPC 1.4.2.0 and earlier versions)

Supported Operations

389

(API RPC 1.5.0.0 and later versions)

The web node is used when you want to redirect web content from a domain alias name to your original domain name. This node is required in API RPC v.1.4.2.0 (and earlier) and optional in API RPC v.1.5.0.0 (and later). Data type: boolean. The mail node is used when you want to redirect mail from a domain alias name to your original domain name. This node is required in API RPC v.1.4.2.0 (and earlier) and optional in API RPC v.1.5.0.0 (and later) Data type: boolean. The tomcat node is optional. It is used when you want to redirect Java applications from a domain alias to the Tomcat server on the primary domain (Tomcat server port 9080). Tomcat redirection is supported from the 1.4.2.0 version of API RPC.This node is used only in Plesk for Unix. Data type: boolean. The full node is used when you want to create both web, mail and tomcat aliases. Data type: none.

The manage-dns node is optional. It defines if you can manage DNS zone for the domain alias. This node is supported starting from API RPC v.1.5.0.0. Data type: boolean.

Note: Before performing any operations on domain alias settings, be sure to call operation get-supported-services (see page 411) retrieving from server information on which of them are operable. AliasInfoType (plesk_domainalias.xsd) is an extension of the Settings type. It contains the following additional nodes:

The domain_id node is required. It specifies the id of the primary domain. Data type: integer.

Supported Operations

390

The name node is required. It specifies the name (in Unicode) of the primary domain. Data type: string. The ascii_name node is optional. It specifies the name (in ASCII) of the primary domain. Data type: string.

Filtering Issues
This section describes some peculiarities of domain alias filtering. Filtering is the way the request XML packet indicates the object (one or several domain aliases) to which the operation will be applied. The request XML filters domain aliases using a special filter section. When created, a domain alias is given a unique identifier and a unique name. Thus, to specify a domain alias (e.g. for the set or get operation), the packet needs a special filter section structured as follows:

The DomainAliasFilterType (domainalias_input.xsd) allows you to specify a domain alias either by id, name, primary domain id, or primary domain name. In addition, it allows you to specify multiple domain aliases within one filter. Finally, the filter can be left empty, which means that all domain aliases are selected. The id node is optional. It specifies the domain alias by id. Data type: integer. The name node is optional. It specifies the domain alias by name. Data type: string (Unicode). The domain_id node is optional. It specifies the domain alias by id of the primary domain. Data type: integer. The domain_name is optional. It specifies the domain alias by name of the primary domain. Data type: string (Unicode).

Note: Use <filter/> to update settings of all domain aliases on the server or delete all domain aliases from the server.

Supported Operations

391

For example, a packet that retrieves the information about all domain aliases looks as follows:
<packet version="1.4.2.0"> <domain_alias> <get> <filter/> </get> </domain_alias> </packet>

Creating Domain Aliases


Only Plesk Administrator can create domain aliases via API RPC. To create a domain alias, it is enough to specify the domain ID and the domain name.

You can also specify alias settings when creating a domain alias (all of them are optional): Alias status Alias preferences

You can specify alias settings during or after creation of an alias. Alias settings can be set using the set (see page 401) operation. To get information on which domain alias settings can be set on a particular server, use the get-supported-services (see page 411) operation.

Request Packet Structure


A request XML packet creating a new domain alias in Plesk database includes the create operation node:
<packet version="1.4.2.0"> <domain_alias > <create> </create> </domain_alias> </packet>

Supported Operations

392

The create node is presented by the AliasInfoType type (plesk_domainalias.xsd). Its graphical representation is as follows:

The status node is optional. It specifies the status of a domain alias. For more information, see the Domain Alias Settings (see page 388) section. Data type: string. Allowed values: ok | error. The pref node is optional. It specifies preferences of a domain alias. For more information, see the Domain Alias Settings (see page 388) section. Data type: none. The manage-dns node is optional. It defines if you can manage DNS zone for the domain alias.

Note: This node is supported starting from API RPC v.1.5.0.0. Data type: boolean. The domain_id node is required. It specifies the id of the primary domain. Data type: integer. The name node is required. It specifies the name of the primary domain. Data type: string (Unicode). The ascii-name node is optional. It specifies the name of the primary domain. Data type: string (ASCII).

Remarks The ascii-name node is supported by API RPC 1.4.2.0 and later versions.

Request Samples
Creating a single domain alias To create a domain alias, specify the ID of the primary domain (the alias will be linked to) and name of the alias.
<packet version="1.4.2.0"> <domain_alias> <create> <domain_id>12</domain_id> <name>myalias.com</name> </create> </domain_alias> </packet>

Supported Operations

393

Creating multiple domain aliases To create two domain aliases with a single packet, include two different create operations:
<packet version="1.4.2.0"> <domain_alias> <create> <domain_id>12</domain_id> <name>MyAlias.com</name> </create> <create> <domain_id>12</domain_id> <name>MySecondAlias.com</name> </create> </domain_alias> </packet>

Alias settings The following packet creates three domain aliases to the domain with ID 12. The alias settings are as follows: DisabledAlias is disabled. EnabledWebOnlyAlias is enabled and has only web content redirection. DisWebMaillAlias is disabled because the primary domain (ID 12) is disabled and has both mail, web and tomcat redirection.

<packet version="1.4.2.0"> <domain_alias> <create> <status>1</status> <domain_id>12</domain_id> <name>DisabledAlias.com</name> </create> <create> <status>0</status> <pref> <web>1</web> <mail>0</mail> <tomcat>0</tomcat> </pref> <domain_id>12</domain_id> <name>DisabledAlias.com</name> </create> <create> <status>2</status> <pref> <full/> </pref> <domain_id>12</domain_id> <name>DisWebMailAlias.com</name> </create>

Supported Operations </domain_alias> </packet>

394

Response Packet Structure


The create node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: AliasResultType (domainalias_output.xsd). The status node is required. It specifies the execution status of the create operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the create operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the create operation fails. Data type: string. The id node is optional. It returns the ID of the domain alias; it is required if the create operation has succeeded. Returns the unique identifier of the domain alias just added to Plesk. Data type: integer. The name node is optional. It does not hold any value for this operation. This node is absent starting from API RPC v.1.5.0.0. Data type: string.

Response Samples
Creating a single domain alias A positive response received from the server after adding a new domain alias can look as follows:
<packet version="1.4.2.0"> <domain_alias> <create> <result> <status>ok</status> <id>34</id> </result>

Supported Operations </create> </domain_alias> </packet>

395

A negative response can look as follows:


<packet version="1.4.2.0"> <domain_alias> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </domain_alias> </packet>

Retrieving Information On Domain Aliases


The get operation is used to retrieve info on domain aliases from Plesk database that includes the following parameters: Domain alias preferences Primary domain id and name

Request Packet Structure


A request XML packet retrieving a domain alias settings from Plesk database includes the get operation node:
<packet version="1.4.2.0"> <domain_alias > <get> </get> </domain_alias> </packet>

Supported Operations

396

The get node graphical representation is as follows:

The filter node is required. It specifies the filtering rule. For information on filters,refer to the Filtering Issues (see page 390) section. Data type: domainAliasFilterType (domainalias_input.xsd). The id node is optional. It specifies the domain alias by id. Data type: integer. The name node is optional. It specifies the domain alias by name. Data type: string (Unicode). The domain_id node is optional. It specifies the domain alias by ID of the primary domain. Data type: integer. The domain_name is optional. It specifies the domain alias by name of the primary domain. Data type: string (Unicode).

Note: You can create filtering rules for multiple domain_id and domain_name parameters in API RPC 1.4.2.0 and later versions. In the elder versions of API RPC you can use only one domain_id or domain_name in a single filter.

Request Samples
Retrieving settings of a single domain alias This packet retrieves preferences of the domain alias called MyAlias.com.
<packet version="1.4.2.0"> <domain_alias> <get> <filter> <name>MyAlias.com</name> </filter> </get> </domain_alias> </packet>

Supported Operations

397

Retrieving settings of multiple domain aliases This packet retrieves preferences of the domain aliases called MyAlias.com and MySecondAlias.com.
<packet version="1.4.2.0"> <domain_alias> <get> <filter> <name>MyAlias.com</name> <name>MySecondAlias.com</name> </filter> </get> </domain_alias> </packet>

The following packet is wrong because both name and domain_id are used for identification.
<packet version="1.4.2.0"> <domain_alias> <get> <filter> <name>MyAlias.com</name> <domain_id>12</domain_id> </filter> </get> </domain_alias> </packet>

This packet retrieves preferences of all domain aliases on the server.


<packet version="1.4.2.0"> <domain_alias> <get> <filter/> </get> </domain_alias> </packet>

Supported Operations

398

Response Packet Structure


The get node of the output XML packet is structured as follows:

The result node is required. It wraps the response received from the server. Data type: resultFilterType (common.xsd). The status node is required. Specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the get operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the get operation fails. Data type: string. The id node is optional. It returns the domain alias id; it is required if the get operation has succeeded or if this id was specified in the request packet. Data type: integer. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues section. Data type:anySimple.

Note: In API RPC v.1.4.2.0 and earlier, response packets contain the name node instead of the filter-id node. The name node is optional. It is required if the operation succeeds or if this name was specified in the request packet. The node holds the domain alias name Data type: string. The info node is optional. It is present if the get operation succeeds and contains the alias preferences. For more information, refer to the Domain Alias Settings (see page 388)section. Data type: AliasInfoType (plesk_domainalias.xsd).

Note: If the get operation has succeeded, both id and name nodes are required.

Supported Operations

399

Response Samples
Retrieving settings of a single domain alias A positive response received from the server after retrieving info on the domain alias can look as follows:
<packet version="1.4.2.0"> <domain_alias> <get> <result> <status>ok</status> <id>34</id> <name>MyAlias.com</name> <info> <prefs> <web>true</web> <mail>false</mail> <tomcat>false</tomcat> </prefs> <domain_id>3</domain_id> <name>PrimaryForThisAlias.com</name> <ascii-name>PrimaryForThisAlias.com</ascii-name> </info> </result> </get> </domain_alias> </packet>

If a request packet tried to retrieve settings of the non-existent domain alias (MyAlias.com), the negative response can look as follows:
<packet version="1.4.2.0"> <domain_alias> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>Domain alias does not exist</errtext> <name>MyAlias.com</name> </result> </get> </domain_alias> </packet>

Retrieving settings of multiple domain alias A possible request packet is:


<packet version="1.4.2.0"> <domain_alias> <get> <filter> <domain_name>PrimaryDomain.com</domain_name> </filter> </get>

Supported Operations </domain_alias> </packet>

400

A possible negative response got from the server is (the domain name does not exist on the server):
<packet version="1.4.2.0"> <domain_alias> <get> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> </result> </get> </domain_alias> </packet>

A positive response got from the server can look as follows (two domain aliases exist for this domain name):
<packet version="1.4.2.0"> <domain_alias> <get> <result> <status>ok</status> <id>124</id> <name>MyAlias.com</name> <info> <prefs> <web>false</web> <mail>false</mail> <tomcat>false</tomcat> </prefs> <domain_id>3</domain_id> <name>PrimaryDomain.com</name> <ascii-name>PrimaryDomain.com</ascii-name> </info> </result> <result> <status>ok</status> <id>127</id> <name>My2Alias.com</name> <info> <prefs> <web>true</web> <mail>false</mail> <tomcat>false</tomcat> </prefs> <domain_id>3</domain_id> <name>PrimaryDomain.com</name> <ascii-name>PrimaryDomain.com</ascii-name> </info> </result> </get> </domain_alias> </packet>

Supported Operations

401

Updating Domain Aliases Settings


The set operation is used to update settings of domain aliases stored in Plesk database. You can update all settings of a domain alias in bulk or specify some particular settings. To get information on which domain alias settings can be updated on a particular server, use the get-supported-services (see page 411) operation. For more information visit the Domain Alias Settings (see page 388) section.

Request Packet Structure


A request XML packet changing the domain alias settings in the Plesk database includes the set operation node:
<packet version="1.4.2.0"> <domain_alias> <set> ... </set> </domain_alias> </packet>

The set node graphical representation is as follows:

The filter node specifies which domain aliases will be affected. For more information, refer to the Filtering Issues (see page 390) section. Data type: DomainAliasFilterType (domainalias_input.xsd) The settings node defines settings to be applied to these domain aliases. For more information, please refer to the Domain Alias Settings (see page 388) section. Data type: Settings (plesk_domainalias.xsd)

Request Samples
Updating settings of a single domain alias This packet sets up Web, Mail and Tomcat references between MyAlias.com and the primary domain.
<packet version="1.4.2.0"> <domain_alias> <set> <filter> <name>MyAlias.com</name> </filter> <settings> <pref> <full/>

Supported Operations </pref> </settings> </set> </domain_alias> </packet>

402

Updating settings of multiple domain aliases This packet switches off mail redirection from domain aliases to the primary domain MyPrimary.com.
<packet version="1.4.2.0"> <domain_alias> <set> <filter> <domain_name>MyPrimary.com</domain_name> </filter> <settings> <pref> <web>1</web> <mail>0</mail> <tomcat>0</tomcat> </pref> </settings> </set> </domain_alias> </packet>

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. Specifies the execution status of the set operation. Data type: string. Allowed values: ok | error.

Supported Operations

403

The errcode node is optional. It returns the error code when the set operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the set operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues section. Data type:anySimple.

Note: In API RPC v.1.4.2.0 and earlier, response packets contain the name node instead of the filter-id node. The name node is optional. It is required if the operation succeeds. The node holds the primary domain name or alias name depending on the name specified in the request packet. Data type: string. The id node is optional. It returns the domain alias ID; it is required if the alias id was specified in the request packet. Data type: integer.

Response Samples
Updating settings of a single domain alias A positive response retrieved from the server after applying domain alias settings can look as follows:
<packet version="1.4.2.0"> <domain_alias> <set> <result> <status>ok</status> <name>MyAlias.com</name> </result> </set> </domain_alias> </packet>

If a request packet tries to apply settings to a non-existent domain alias (id = 13), a negative response will look as follows:
<packet version="1.4.2.0"> <domain_alias> <set> <result> <status>error</status> <errcode>1013</errcode> <errtext>Domain alias does not exist</errtext> <id>13</id> </result> </set> </domain_alias> </packet>

Updating settings of multiple domain aliases A possible request packet can look as follows:

Supported Operations <packet version="1.4.2.0"> <domain_alias> <set> <filter> <domain_name>MyPrimary.com</domain_name> </filter> <settings> <pref> <full/> </pref> </settings> </set> </domain_alias> </packet>

404

A possible negative response from the server looks as follows:


<packet version="1.4.2.0"> <domain_alias> <set> <result> <status>error</status> <errcode>1015</errcode> <errtext>Domain does not exist</errtext> </result> </set> </domain_alias> </packet>

A possible positive response from the server looks as follows (two domain aliases updated):
<packet version="1.4.2.0"> <domain_alias> <set> <result> <status>ok</status> <id>100</id> <name>MyPrimary.com</name> </result> <result> <status>ok</status> <id>101</id> <name>MyPrimary.com</name> </result> </set> </domain_alias> </packet>

Supported Operations

405

Deleting Domain Aliases


Use the delete operation to remove a specified domain alias from Plesk database.

Request Packet Structure


A request XML packet removing the domain aliases from Plesk database includes the delete operation node:
<packet version="1.4.2.0"> <domain_alias> <delete> ... </delete> </domain_alias> </packet>

The delete node graphical representation is as follows:

The filter node specifies the filtering rule. For information on filters, refer to the Filtering Issues (see page 390) section. Data type: DomainAliasFilterType (domainalias_input.xsd)

Request Samples
Deleting a single domain alias This packet deletes the MyAlias.com alias:
<packet version="1.4.2.0"> <domain_alias> <delete> <filter> <name>MyAlias.com</name> </filter> </delete> </domain_alias> </packet>

Deleting multiple domain aliases This packet deletes all domain aliases from the primary domains MyPrimary.com and My2Primary.com.
<packet version="1.4.2.0"> <domain_alias> <delete> <filter> <domain_name>MyPrimary.com</domain_name>

Supported Operations <domain_name>My2Primary.com</domain_name> </filter> </delete> </domain_alias> </packet>

406

This packet removes all domain aliases from all domains on the server.
<packet version="1.4.2.0"> <domain_alias> <delete> <filter/> </delete> </domain_alias> </packet>

Response Packet Structure


The delete node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the delete operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code when the delete operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the delete operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues section. Data type:anySimple.

Supported Operations

407

Note: In API RPC v.1.4.2.0 and earlier, response packets contain the name node instead of the filter-id node. The name node is optional. It is present if the operation succeeds. The node returns the domain alias name. Data type: string. The id node is optional. It returns the domain alias ID; it is required if the operation delete succeeds. Data type: integer.

Response Samples
Deleting a single domain alias The request packet looks as follows:
<packet version="1.4.2.0"> <domain_alias> <delete> <filter> <domain_id>128</domain_id> </filter> </delete> </domain_alias> </packet>

A positive response retrieved from the server can look as follows:


<packet version="1.4.2.0"> <domain_alias> <delete> <result> <status>ok</status> <id>13</id> <name>MyAlias.com</name> </result> <result> <status>ok</status> <id>14</id> <name>My2Alias.com</name> </result> </delete> </domain_alias> </packet>

A negative response from the server can look as follows:


<packet version="1.4.2.0"> <domain_alias> <delete> <result> <status>error</status> <errcode>1013</errcode> <errtext>Domain does not exist</errtext> <name>MyAlias.com</name>

Supported Operations </result> </delete> </domain_alias> </packet>

408

Renaming Domain Aliases


The rename operation is used to rename the specified domain alias. The domain alias can be specified either by ID, or by name.

Request Packet Structure


A request XML packet renaming the domain alias in Plesk database includes the rename operation node:
<packet version="1.4.2.0"> <domain_alias> <rename> ... </rename> </domain_alias> </packet>

The rename node graphical representation is as follows:

The id node is required. It specifies the domain alias by ID. Data type: integer. The name node is required. It specifies the domain alias by name. Data type: string (Unicode). The new_name node is required. It is used to assign a new domain alias name. Data type: string (Unicode).

Supported Operations

409

Request Samples
Renaming a domain alias The following XML packet renames the MyAlias.com domain alias to MyNewAlias.com:
<packet version="1.4.2.0"> <domain_alias> <rename> <name>MyAlias.com</name> <new_name>MyNewAlias.com</new_name> </rename> </domain_alias> </packet>

The following XML packet is not valid because it specifies both alias name and id.
<packet version="1.4.2.0"> <domain_alias> <rename> <id>15</id> <name>MyAlias.com</name> </rename> </domain_alias> </packet>

Response Packet Structure


The rename node of the output XML packet is structured as follows:

The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. Specifies the execution status of the rename operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the rename operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return the error message if the rename operation fails. Data type: string.

Supported Operations

410

Response Samples
Renaming a domain alias The following packet shows that the domain alias was successfully renamed:
<packet version="1.4.2.0"> <domain_alias> <rename> <result> <status>ok</status> </result> </rename> </domain_alias> </packet>

A negative response can look as follows:


<packet version="1.4.2.0"> <domain_alias> <rename> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </rename> </domain_alias> </packet>

Supported Operations

411

Retrieving Information On Manageable Services


The get-supported-services operation is used to retrieve a list of server services which can be turned on/ off for domain aliases on that server. The number of manageable services on domain aliases differ in Plesk for Unix and Plesk for Windows: You cannot switch Tomcat service for domain aliases in Plesk for Windows. Note: This operation appears in Plesk XML API v.1.4.2.0 and is not supported in previous versions. Request Sample The following XML packet requests which domain alias services can be managed on the server:
<packet version="1.4.2.0"> <domain_alias> <get-supported-services/> </domain_alias> </packet>

Response Samples Response from server that runs Plesk for Unix, showing that all 3 services - Web, Mail and Tomcat - can be enabled/ disabled for domain aliases on the server, looks like:
<packet version="1.4.2.0"> <domain_alias> <get-supported-services> <result> <status>ok</status> <service>web</service> <service>mail</service> <service>tomcat</service> </result> </get-supported-services> </domain_alias> </packet>

Response from server that runs Plesk for Windows, showing that only 2 services - Web and Mail - can be enabled/ disabled for domain aliases on the server, looks like:
<packet version="1.4.2.0"> <domain_alias> <get-supported-services> <result> <status>ok</status> <service>web</service> <service>mail</service> </result> </get-supported-services> </domain_alias> </packet>

Supported Operations

412

Managing Domain Templates


Operator: <domain-template> XML Schema: domain_template.xsd Plesk version: Plesk 8.0 for UNIX | Plesk 7.6 for Windows and higher API RPC version: 1.4.1.0 and higher Plesk user: Plesk Administrator Description Domain templates are a kind of hosting configuration presets which are useful when it is necessary to create multiple domain accounts with identical hosting/mail settings, limits, and other preferences. All operations on domain templates are allowed to Plesk Administrator only. This is a temporary limitation of API RPC (Plesk GUI allows domain template management for Plesk Administrator and Plesk Client). Settings Domain templates are used to fix a definite collection of domain settings and apply these settings to domains created using these domain templates. These settings are as follows: Hosting settings Mailing settings Limits on use of Plesk resources Preferences Log rotation settings Performance settings

Refer to the Domain Template Settings (see page 413) section for details. Supported operations

ADD (see page 417) creates a domain template and to add it to the list of domain templates for a certain user;

Supported Operations

413

GET (see page 424) gets the information on the specified domain template(s) from the server; DEL (see page 440) deletes the specified domain template (or several); SET (see page 430) sets new settings to the specified domain template.

Domain Template Settings


This section describes a collection of domain settings that can be predefined in a domain template. These settings can be set for a domain being created, or they can be set for this domain later, or read from the database. These settings are as follows: Mailing settings (see page 413) Limits, permissions and hosting settings (on page 305) Preferences Log rotation settings (see page 414) Domain performance settings (see page 415)

Mailing Settings
Mailing settings are defined in the domain template by the mail node. This node is presented by type MailPreferences (plesk_mailname.xsd). It has the following graphics model:

The nonexistent-user node is optional. If specified, it is used to collect and handle email messages sent to users not registered on the domain. By default, such messages are sent back to the sender with a message: this address no longer accepts mail. To specify the handling method, choose between the following three options: The bounce node is used to modify the default rejection message. Data type: string. The forward node specifies the email addresses to which undelivered mail should be forwarded. Data type: string. The reject node is used to reject such email messages (they will not be accepted by the mail server). Data type: no.

Supported Operations

414

The webmail node is optional. It specifies whether mail users will be able to read mail through the WebMail application. Data type: boolean.

Log Rotation Settings


The idea of log rotation is as follows. Active log files can be handled daily, weekly, monthly, or when some log file grows too large (the maximal size can be restricted). Before being handled, the active log file is removed from logging and a new one is created. Plesk starts logging to the new log file, while the dropped-out log file is handled, compressed, and emailed to some address (if this action is specified). The handled log files are stored on the server. The number of such stored files is limited. Once the limit is exceeded, the oldest file is removed from the server and a new handled log file is added. Log rotation settings are specified in the log-rotation node defined by complex type LogRotationType (domain_template.xsd). It is structured as follows:

The off node is required if the on node is not specified. This node disables log rotation on a domain created using this domain template. Data type: none. The on node is required if the off node is not specified. This node enables log rotation on a domain created using this domain template. Data type: none. The log-condition type is required if the on node is specified. Specifies the criterion for triggering log rotation on a domain. Data type: none. The log-bysize type is required if the on node is specified and the log-bytime node is not. Indicates that log files should be handled once the specified size (in Kb) is achieved. Data type: integer. The log-bytime type is required if the on node is specified and the log-bysize node is not. Indicates that log files should be handled periodically. Data type: string. Allowed values: Daily | Weekly | Monthly. The log-max-num-files node is optional. Specifies the maximal number of handled log files belonging to the domain that can be stored on the server. Data type: integer. The log-compress node is optional. Enables/disables log file compression. Data type: Boolean. The log-email node is optional. Specifies the email address to which the handled log file can be sent. Data type: emailType (common.xsd).

Supported Operations

415

Note: In API RPC 1.5.1.0 and later versions, the type of this node is string.

Performance Settings
Performance settings are defined by the performance node. This node is specified by complex type DomainPerformanceType (plesk_domain.xsd). This type is structured as follows:

The bandwidth node is optional. It restricts the network use by the specified value (Kb/sec) for the domain created using this domain template. Data type: integer. If set to -1, the bandwidth is unlimited. The max_connections node is optional. It restricts the number of connections by the specified value for the domain created using this domain template. Data type: integer. If set to -1, the number of connections is unlimited.

Note: Domain performance settings are supported in domain templates by API RPC 1.4.2.0 and later. The following sample packet creates a domain template and defines performance settings for domains that will be created using this domain template:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <gen_setup> <name>newdomain.com</name> <client_id>1234</client_id> <ip_address>123.123.123.123</ip_address> </gen_setup> <performance> <bandwidth>1000</bandwidth> <max_connections>-1</max_connections> </performance> </add> </domain-template> </packet>

Supported Operations

416

Filtering Issues
This topic describes some peculiarities of domain template filtering. Filtering is the way the request XML packet indicates the object (a domain template or several) to which the operation will be applied. The request XML packets filter domain templates using a special filter node and by specifying the owner of the template (if necessary). When created, a domain template is given a unique ID and a unique name. The filter node that filters a domain template is presented by the DomainFilterType complex type (domain_input.xsd). This node is structured as follows:

The name node is required. It specifies the template name. Data type: string. The id node is required. It specifies a unique identifier of the domain template. Data type: integer.

The filter node allows you to specify a domain template either by ID, or by template name. In addition, it allows you to specify multiple domain templates within one filter. All of them should be specified either by ID, or by template names.
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> <name>extra_template</name> </filter> </get> </domain-template> </packet>

Or:
<packet version=1.4.2.0> <domain-template> <get> <filter> <id>12</id> <id>14</id> </filter> </get> </domain-template> </packet>

Finally, the filter can be left empty, which means that all domain templates are selected:
<packet version=1.4.2.0> <domain-template>

Supported Operations <get> <filter/> </get> </domain-template> </packet>

417

Another important issue is the ownership of domain templates. When created by Plesk Administrator for own needs, a domain template gets to the administrators template repository. When created for a certain Plesk Client, a domain template is added to the template repository of this client. Domain templates are searched in the template repository of the current user. Since all operations on domain templates are allowed to Plesk Administrator only, domain templates are searched in the administrators repository by default. To filter some domain template that belongs to a certain client, you need to identify this client in the request packet. Use the client-id or client-login node for this purpose:
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> </filter> <client-login>tecnhnolux</client-login> </get> </domain-template> </packet>

Creating Domain Template


A domain template can be created by Plesk Administrator for own needs or for a Plesk Client. When creating a domain template, it is enough to specify the template name. If this domain template is created for Plesk Client, you also need to specify the client ID or client login. In addition, you can specify various domain settings when creating a domain template (all of them are optional): Hosting settings Mailing settings Limits on use of Plesk resources Preferences Log rotation settings Domain performance settings

You can see all these settings on Plesk Control Panel. A domain template can include them all or just some of them. You can specify domain settings when creating a domain template or later (they can be set using the set operation).

Supported Operations

418

Request Packet Structure


A request XML packet adding a new domain template to Plesk database includes the add operation node:
<packet version=1.4.1.0> <domain-template> <add> </add> </domain-template> </packet>

The add node is presented by type DomainTemplateAddInputType (domain_template.xsd). Its graphical representation is as follows:

The name node is required. It specifies the name of the domain template. Data type: string. The client_id node is optional. It is used if the domain template is created by Plesk Administrator for a certain client. Data type: integer. The client-login node is optional. It is used if the domain template is created by Plesk Administrator for a certain client. Data type: string. The mail node is optional. It specifies a collection of email preferences that will be assigned to a new domain created using this template. Data type: MailPreferences (plesk_mailname.xsd). See the structure of this node in the Mailing settings (see page 413) section. The limits node is optional. It specifies a collection of limits that will be set for new domains created using this template. Data type: domainLimits (plesk_domain.xsd). See the structure of this node in the Limits (on page 305) section.

Supported Operations

419

The log-rotation node is optional. It is used to turn on/off rotation of log files related to a domain created using this template. Data type: LogRotationType (domain_template.xsd). See the structure of this node in the Log Rotation Settings (see page 414) section. The preferences node is optional. It is used to specify a collection of preferences for new domains created using this template. Data type: DomainTemplatePreferecesType (domain_template.xsd). See the structure of this node in the Preferences section. The hosting node is optional. Specifies physical hosting settings for new domains created using this template. Data type: DomainTemplatePHostingPreferences (domain_template.xsd). See the structure of this node in the Hosting Settings (on page 305) section. The performance node is optional. It specifies performance settings for new domains created using this domain template. Data type: DomainPerformanceType (plesk_domain.xsd). This feature is supported by API RPC 1.4.2.0 and later. See the structure of this node in the Performance Settings (see page 415) section.

Request Samples
Creating domain templates for different Plesk users To create a domain template for a certain Plesk Client, specify this client either by ID, or by login (both are unique in Plesk).
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <client-id>12</client-id> <mail> <webmail>true</webmail> </mail> </add> </domain-template> </packet>

Or:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <client-login>technolux</client-login> <mail> <webmail>true</webmail> </mail> </add> </domain-template> </packet>

Supported Operations

420

When creating a domain template for Plesk Administrator, nodes client-id and clientlogin are not used:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <mail> <webmail>true</webmail> </mail> </add> </domain-template> </packet>

Creating multiple domain templates To create two domain templates with a single packet, include two different add blocks:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <mail> <webmail>true</webmail> </mail> </add> <add> <name>quick_template</name> <mail> <webmail>false</webmail> </mail> </add> </domain-template> </packet>

Mailing settings The following packet creates three domain templates. The mailing settings are as follows: bounce_template domain template allows mail users to access the mail service of Plesk (the WebMail application) and specifies the text sent back if a message is addressed to a non-existing user forward_template forwards mail addressed to a non-existing user to a certain mail box reject_template rejects mail addressed to a non-existing user (such messages are not accepted by the mail server)

<packet version=1.4.2.0> <domain-template> <add> <name>bounce_template</name> <mail> <webmail>true</webmail>

Supported Operations <nonexistent-user> <bounce>Email address does not exist.</bounce> </nonexistent-user> </mail> </add> <add> <name>forward_template</name> <mail> <nonexistent-user> <forward>spam@technolux.co.uk</forward> </nonexistent-user> </mail> </add> <add> <name>reject_template</name> <mail> <nonexistent-user> <reject/> </nonexistent-user> </mail> </add> </domain-template> </packet>

421

Log rotation To disable log rotation on a domain created using the specified template, use the following packet:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <log-rotation> <off/> </log-rotation> </add> </domain-template> </packet>

The following packet creates the domain template that enables log rotation on a domain, allows the storage of up to 30 handled log files related to this domain, and removes active log files related to this domain from logging once a week:
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <log-rotation> <on> <log-condition> <log-bytime>weekly</log-bytime> </log-condition> <log-max-num-files>30</log-max-num-files> <log-compress>true</log-compress> </on> </log-rotation> </add> </domain-template> </packet>

Supported Operations

422

Preferences The following packet creates a domain template and specifies preferences for domains created on its basis.
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <preferences> <stat>6</stat> <maillists>true</maillists> <dns_zone_type>master</dns_zone_type> </preferences> </add> </domain-template> </packet>

Hosting Here is the sample packet that creates a domain template and specifies physical hosting settings for domains that will be created using this domain template.
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <hosting> <ftp_quota>100000</ftp_quota> <ssl>true</ssl> <php>true</php> <php_safe_mode>true</php_safe_mode> <ssi>true</ssi> <cgi>true</cgi> <mod_perl>true</mod_perl> <mod_python>true</mod_python> <webstat>webalizer</webstat> <errdocs>true</errdocs> </hosting> </add> </domain-template> </packet>

Performance settings Here is the sample packet that creates a domain template and specifies performance settings for domains that will be created using this domain template.
<packet version=1.4.2.0> <domain-template> <add> <name>base_template</name> <performance> <bandwidth>1000</bandwidth> <max_connections>20</max_connections> </performance> </add> </domain-template> </packet>

Supported Operations

423

Response Packet Structure


The add node of the output XML packet is structured as follows:

The result node is required. It wraps the response got from the server. Data type: resultType (common.xsd). The status node is required. Specifies the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Returns the error code when the add operation fails. Data type: unsignedInt. The errtext node is optional. Returns the error message if the add operation fails. Data type: string. The id node is optional. It is required if the add operation has succeeded. Returns the unique identifier of the domain template just added to Plesk. Data type: integer.

Response Samples
A positive response got from the server after adding a new domain template can look as follows:
<packet version=1.4.2.0> <domain-template> <add> <result> <status>ok</status> <id>2435</id> </result> </add> </domain-template> </packet>

Supported Operations

424

A negative response can look as follows:


<packet version=1.4.2.0> <domain-template> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </add> </domain-template> </packet>

Getting Information On Domain Templates


The get operation is used to retrieve the information about the domain templates from Plesk database. This information is as follows: Domain template ID and name Hosting settings Mailing settings Limits on use of Plesk resources Preferences Log rotation settings Domain performance settings

The get operation returns all settings currently present in the database in bulk. You cannot request for a definite item of the above list. For instance, you cannot retrieve only hosting settings, only preferences, and so on. All settings are optional and can be missing in the database. A domain template can even be empty (specified by its ID and name and not containing any other information). The get operation will return only the settings currently stored in the database. Filtering domain templates is a very important issue. Refer to the Filtering Issues (see page 416)topic for details.

Request Packet Structure


A request XML packet getting information about the specified domain templates includes the get operation node:
<packet version=1.4.2.0> <domain-template> <get> </get> </domain-template> </packet>

Supported Operations

425

The get node is presented by type DomainTemplateGetInputType (domain_template.xsd). Its graphical representation is as follows:

The filter node is required. It serves to specify the criteria by which the necessary domain templates will be selected from the database. Data type: DomainTemplateFilterType (domain_template.xsd). The name node is optional. It specifies the names of the domain templates to be selected. Data type: string. The id node is optional. It specifies the unique identifier of domain template to be selected. Data type: integer. The client-id node is optional. It specifies the identifier of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: integer. The client-login node is optional. It specifies the login name of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: string.

Request Samples
Getting domain templates that belong to different Plesk user To get the information about a domain template that belongs to some Plesk Client, specify Plesk Client either by ID, or by login.
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> </filter> <client-login>tecnhnolux</client-login> </get> </domain-template> </packet>

Supported Operations

426

The following packet retrieves the same information using Plesk Client ID:
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> </filter> <client-id>1234</client-id> </get> </domain-template> </packet>

To retrieve information about a domain template that belongs to Plesk Administrator, do not specify client-id and client-login:
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> </filter> </get> </domain-template> </packet>

Operating multiple domain templates A single filter can specify multiple template instances, all specified either by ID or by the template name.
<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> <name>quick_template</name> </filter> </get> </domain-template> </packet>

The following packet sample is wrong:


<packet version=1.4.2.0> <domain-template> <get> <filter> <name>base_template</name> <id>12</id> </filter> </get> </domain-template> </packet>

Supported Operations

427

The following packet gets the information about all domain templates that belong to a definite Plesk Client:
<packet version=1.4.2.0> <domain-template> <get> <filter/> <client-login>tecnhnolux</client-login> </get> </domain-template> </packet>

The following packet gets the information about all domain templates that belong to Plesk Administrator:
<packet version=1.4.2.0> <domain-template> <get> <filter/> </get> </domain-template> </packet>

Response Packet Structure


The get node of the output XML packet is structured as follows:

Supported Operations

428

The result node is required. It wraps the information for one domain template. Data type: resultType (common.xsd). The status node is required. Specifies the execution status of the get operation. Data type: result_status (string). Allowed values: ok | error. The errcode node is optional. Is required if the get operation fails. Returns the error code. Data type: unsignedInt. The errtext node is optional. Returns the error message. Data type: string. The id node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the identifier of the domain template (if this id was specified in the request packet). Data type: integer. The name node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the name of the domain template (if this name was specified in the request packet). Data type: string. The mail node is optional. Is present if the get operation succeeds and mailing settings are defined for this domain template, otherwise is missing in the packet. Data type: MailPreferences (plesk_mailname.xsd). See the structure of this node in the Mailing settings (see page 413) topic. The limits node is optional. Is present if the get operation succeeds and limits are defined for this domain template, otherwise is missing in the packet. Data type: domainLimits (plesk_domains.xsd). See the structure of this node in the Limits (on page 305) topic. The log-rotation node is optional. Is present if the get operation succeeds and log rotation settings are defined for this domain template, otherwise is missing in the packet. Data type: LogRotationType (domain_template.xsd). See the structure of this node in the Log rotation settings (see page 414)topic. The preferences node is optional. Is present if the get operation succeeds and preferences are defined for this domain template, otherwise is missing in the packet. Data type: DomainTemplatePreferencesType (domain_templates.xsd). See the structure of this node in the Preferences topic. The hosting node is optional. Is present if the get operation succeeds and physical hosting settings are defined for this domain template, otherwise is missing in the packet. Data type: DomainTemplatePHosting (domain_templates.xsd). See the structure of this node in the Hosting settings (on page 305) topic. The performance node is optional. This node is supported by API RPC 1.4.2.0 and later. This node is present if the get operation succeeds and performance settings are defined for this domain template, otherwise it is missing in the packet. Data type: DomainPerformanceType (plesk_domain.xsd). See the structure of this node in the Performance settings (see page 415) topic.

Supported Operations

429

Response Samples
The request packet sent to Plesk is as follows:
<packet version=1.4.2.0> <domain-template> <get> <filter> <id>11</id> <id>12</id> </filter> <client-login>tecnhnolux</client-login> </get> </domain-template> </packet>

This packet requests for the information about two domain templates specified by ID. A positive response can look as follows:
<packet version=1.4.2.0> <domain-template> <get> <result> <status>ok</status> <id>11</id> <name>base_template</name> <mail> <webmail>true</webmail> </mail> </result> <result> <status>ok</status> <id>12</id> <name>quick_template</name> <limits> <disk_space>209715200</disk_space> <max_traffic>209715200</max_traffic> <max_db>50</max_db> <mysql_dbase_space>52428800</mysql_dbase_space> <expiration>63072000</expiration> </limits> <hosting> <vrt_hst> <ftp_quota>1000000</ftp_quota> <ssl>true</ssl> <php>true</php> <php_safe_mode>true</php_safe_mode> <ssi>true</ssi> <cgi>true</cgi> <mod_perl>true</mod_perl> <mod_python>true</mod_python> <webstat>webalizer</webstat> <errdocs>true</errdocs> </vrt_hst> </hosting> </result> </get> </domain-template> </packet>

Supported Operations

430

The base_template domain template holds the mailing settings only, while the quick_template domain template holds the limits and hosting settings. A negative response can look as follows:
<packet version=1.4.2.0> <domain-template> <get> <result> <status>ok</status> <id>11</id> <name>base_template</name> <mail> <webmail>true</webmail> </mail> </result> <result> <status>error</status> <id>12</id> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </get> </domain-template> </packet>

Configuring Domain Template Settings


The set operation is used to update domain settings set in the domain templates and stored in Plesk database. This information is as follows: Hosting settings E-mail settings Limits on use of Plesk resources by this domain Preferences Log rotation settings Domain performance settings

You can update all settings of a domain template in bulk or specify some particular settings. Filtering domain templates is made either by the domain template identifier, or by the domain template name. Also, the same packet can handle domain templates and templates belonging to different Plesk users. Proceed to the Filtering Issues (see page 416)topic for details.

Supported Operations

431

Request Packet Structure


A request XML packet Configuring Domain Template Settings to Plesk database includes the set operation node:
<packet version=1.4.2.0> <domain-template> <set> </set> </domain-template> </packet>

The set node is presented by type DomainTemplateSetInputType (domain_template.xsd). Its graphical representation is as follows:

The filter node is required. It serves to specify the criteria by which domain templates will be updated in the database. Data type: DomainTemplateFilterType (domain_template.xsd). The name node is optional. It specifies the names of domain templates to be updated. Data type: string. The id node is optional. It specifies the unique identifiers of domain templates to be updated. Data type: integer. The client-id node is optional. It specifies the identifier of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: integer.

Supported Operations

432

The client-login node is optional. It specifies the login name of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: string. The mail node is optional. It sets a collection of email preferences that will be updated for the specified domain templates. Data type: MailPreferences complex type (plesk_mailname.xsd). See the structure of this node in the Mailing settings (see page 413) topic. The limits node is optional. It sets a collection of limits that will be updated for the specified domain templates. Data type: domainLimits complex type (plesk_domain.xsd). See the structure of this node in the Limits (on page 305) topic. The log-rotation node is optional. It sets a collection of log file rotation settings for the specified domain templates. Data type: LogRotationType complex type (domain_template.xsd). See the structure of this node in the Log rotation settings (see page 414)topic. The preferences node is optional. It sets a collection of preferences for the specified domain templates. Data type: DomainTemplatePreferecesType complex type (domain_template.xsd). See the structure of this node in the Preferences topic. The hosting node is optional. Sets physical hosting settings for the specified domain templates. Data type: DomainTemplatePhosting (domain_template.xsd). See the structure of this node in the Hosting settings (on page 305) topic. The performance node is optional. Sets domain performance settings to the specified domains. Data type: DomainPerformanceType (plesk_domain.xsd). This node is supported by API RPC 1.4.2.0 and later. See the structure of this node in the Performance settings (see page 415) topic.

Request Samples
Update domain templates that belong to different Plesk user To update settings of a domain template that belongs to Plesk Client, specify this client either by id, or by login.
<packet version=1.4.2.0> <domain-template> <set> <filter> <name>base_template</name> </filter> <client-login>tecnhnolux</client-login> <mail> <webmail>true</webmail> </mail> </set> </domain-template> </packet>

Supported Operations

433

Or:
<packet version=1.4.2.0> <domain-template> <set> <filter> <name>base_template</name> </filter> <client-id>1234</client-id> <mail> <webmail>true</webmail> </mail> </set> </domain-template> </packet>

To update settings of a domain template that belongs to Plesk Administrator, do not specify nodes client-id and client-login:
<packet version=1.4.2.0> <domain-template> <set> <filter> <name>base_template</name> </filter> <mail> <webmail>true</webmail> </mail> </set> </domain-template> </packet>

Operating multiple domain templates

Here is the sample packet that sets similar domain template settings for two different domain templates, both specified by id.

<packet version=1.4.2.0> <domain-template> <set> <filter> <id>11</id> <id>12</id> </filter> <mail> <webmail>true</webmail> </mail> </set> </domain-template> </packet>

Supported Operations

434

To set different settings for two domain templates, use two different set operations:
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <client-login>tecnhnolux</client-login> <mail> <webmail>false</webmail> </mail> </set> <set> <filter> <name>base_template</name> </filter> <mail> <webmail>true</webmail> </mail> </set> </domain-template> </packet>

The following packet updates all domain templates belonging to the specified Plesk Client:
<packet version=1.4.2.0> <domain-template> <set> <filter/> <client-login>tecnhnolux</client-login> <mail> <webmail>false</webmail> </mail> </set> </domain-template> </packet>

The following packet updates all domain templates that belong to Plesk Administrator:
<packet version=1.4.2.0> <domain-template> <set> <filter/> <mail> <webmail>false</webmail> </mail> </set></domain-template> </packet>

Supported Operations

435

Mailing settings The following packet updates mailing settings of three domain templates that belong to Plesk Administrator. The new mailing settings are as follows: bounce_template allows email users to access the email service of Plesk (the WebMail application) and specifies the text sent back if a message is addressed to a non-existing user forward_template forwards mail addressed to a non-existing user to a certain email box reject_template rejects mail addressed to a non-existing user (such messages are not accepted by the mail server)

<packet version=1.4.2.0> <domain-template> <set> <filter> <name>bounce_template</name> </filter> <mail> <webmail>true</webmail> <nonexistent-user> <bounce>Email address you specified does not exist.</bounce> </nonexistent-user> </mail> </set> <set> <filter> <name>forward_template</name> </filter> <mail> <nonexistent-user> <forward>spam@technolux.co.uk</forward> </nonexistent-user> </mail> </set> <set> <filter> <name>reject_template</name> </filter> <mail> <nonexistent-user> <reject/> </nonexistent-user> </mail> </set> </domain-template> </packet>

Supported Operations

436

Setting limits
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <limits> <disk_space>2048</disk_space> <max_traffic>10240</max_traffic> <max_db>50</max_db> <mysql_dbase_space>1024</mysql_dbase_space> <expiration>63072000</expiration> </limits> </set> </domain-template> </packet>

Log rotation To disable log rotation in the specified template, use the following packet:
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <log-rotation> <off/> </log-rotation> </set> </domain-template> </packet>

The following packet enables log file rotation on a domain created using this domain template, allows the storage of up to 30 handled log files related to this domain, and removes active log files related to this domain from logging once a week:
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <log-rotation> <on> <log-condition> <log-bytime>weekly</log-bytime> </log-condition> <log-max-num-files>30</log-max-num-files> <log-compress>true</log-compress> </on> </log-rotation> </set> </domain-template> </packet>

Supported Operations

437

Preferences The following packet specifies preferences for a domain template:


<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <preferences> <stat>6</stat> <maillists>true</maillists> <dns_zone_type>master</dns_zone_type> </preferences> </set> </domain-template> </packet>

Hosting Here is the sample packet that sets physical hosting settings to a domain template under Plesk Client permissions.
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <hosting> <vrt_hst> <ftp_quota>100</ftp_quota> <ssl>true</ssl> <php>true</php> <php_safe_mode>true</php_safe_mode> <ssi>true</ssi> <cgi>true</cgi> <mod_perl>true</mod_perl> <mod_python>true</mod_python> <webstat>webalizer</webstat> <errdocs>true</errdocs> </vrt_hst> </hosting> </set> </domain-template> </packet>

Supported Operations

438

Hosting Here is the sample packet that sets domain performance settings to a domain template under Plesk Client permissions.
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>12</id> </filter> <performance> <bandwidth>1000</bandwidth> <max_connections>20</max_connections> </performance> </set> </domain-template> </packet>

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It wraps the result of the set operation for a single domain template. Data type: resultType (common.xsd). The status node is required. Specifies the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is required if the set operation fails. Returns the error code. Data type: unsignedInt. The errtext node is optional. Can be returned if the set operation fails. Returns the error message. Data type: string. The id node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the identifier of the domain template (if this id was specified in the request packet). Data type: integer.

Supported Operations

439

The name node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the name of the domain template (if this name was specified in the request packet). Data type: string.

Response Samples
A request packet sent to Plesk server can look as follows:
<packet version=1.4.2.0> <domain-template> <set> <filter> <id>11</id> <id>12</id> </filter> <mail> <webmail>false</webmail> </mail> </set> </domain-template> </packet>

This packet updates two domain templates specified by ID. A positive response is sent back if the requested operation succeeds:
<packet version=1.4.2.0> <domain-template> <set> <result> <status>ok</status> <id>11</id> </result> <result> <status>ok</status> <id>12</id> </result> </set> </domain-template> </packet>

A negative response is returned if any domain template failed to be updated:


<packet version=1.4.2.0> <domain-template> <set> <result> <status>ok</status> <id>11</id> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <id>12</id> </result> </set> </domain-template> </packet>

Supported Operations

440

Deleting a Domain Template


A domain template can be deleted Plesk Administrator only. A single packet can delet e multiple domain templates. Filtering domain templates is made either by the domain template identifier, or by the domain template name. Also, the same packet can delete domain templates and templates belonging to different Plesk users. Refer to the Filtering Issues (see page 416)topic for details.

Request Packet Structure


A request XML packet deleting the domain templates from Plesk database includes the del operation node:
<packet version=1.4.2.0> <domain-template> <del> </del> </domain-template> </packet>

The del node is presented by type DomainTemplateAddInputType (domain_template.xsd). Its graphical representation is as follows:

The filter node is required. It serves to specify the criteria by which the necessary domain templates will be deleted from the database. Data type: DomainTemplateFilterType (domain_template.xsd). The name node is optional. It specifies the name of domain template to be deleted. Data type: string. The id node is optional. It specifies the unique identifiers of domain templates to be deleted. Data type: integer. The client-id node is optional. It specifies the identifier of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: integer.

Supported Operations

441

The client-login node is optional. It specifies the login name of the Plesk client who owns the domain template. This parameter is not used if the domain template belongs to Plesk Administrator. Data type: string.

Request Samples
Deleting domain templates that belong to different Plesk user To delete a domain template that belongs to a certain Plesk Client, specify this Plesk Client either by ID, or by login.
<packet version=1.4.2.0> <domain-template> <del> <filter> <name>base_template</name> </filter> <client-login>tecnhnolux</client-login> </del> </domain-template> </packet>

The following packet specifies the same Plesk Client by ID:


<packet version=1.4.2.0> <domain-template> <del> <filter> <name>base_template</name> </filter> <client-id>1234</client-id> </del> </domain-template> </packet>

To delete a domain template that belongs to Plesk Administrator, do not specify nodes client-id and client-login:
<packet version=1.4.2.0> <domain-template> <del> <filter> <name>base_template</name> </filter> </del> </domain-template> </packet>

Supported Operations

442

Deleting multiple domain templates A single filter can specify multiple template instances for deletion, all specified either by ID or by the template name:

<packet version=1.4.2.0> <domain-template> <del> <filter> <name>base_template</name> <name>quick_template</name> </filter> </del> </domain-template> </packet>

To delete templates that belong to different Plesk users, use a separate del operation for each:

<packet version=1.4.2.0> <domain-template> <del> <filter> <name>base_template</name> <name>quick_template</name> </filter> </del> <del> <filter> <id>52</id> <id>53</id> </filter> <client-login>tecnhnolux</client-login> </del> <del> <filter> <id>66</id> <id>67</id> </filter> <client-id>12134</client-id> </del> </domain-template> </packet>

Supported Operations

443

The above sample packet deletes domain templates that belong to Plesk Administrator and by two Plesk Clients (one specified by client login and another by client ID) The following packet deletes all domain templates belonging to the specified Plesk Client:
<packet version=1.4.2.0> <domain-template> <del> <filter/> <client-login>tecnhnolux</client-login> </del> </domain-template> </packet>

The following packet deletes all domain templates that belong to Plesk Administrator:
<packet version=1.4.2.0> <domain-template> <del> <filter/> </del> </domain-template> </packet>

Response Packet Structure


The del node of the output XML packet is structured as follows:

The result node is required. It wraps the result of the del operation for a single domain template. Data type: resultType (common.xsd). The status node is required. Specifies the execution status of the del operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is required if the del operation fails. Returns the error code. Data type: unsignedInt. The errtext node is optional. Returns the error message. Data type: string.

Supported Operations

444

The id node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the identifier of the domain template (if this id was specified in the request packet). Data type: integer. The name node is optional. If the request packet fails before the execution, this node is missing in the response packet. In all other cases it holds the name of the domain template (if this name was specified in the request packet). Data type: string.

Response Samples
A request packet that orders a del operation is as follows:
<packet version=1.4.2.0> <domain-template> <del> <filter> <id>11</id> <id>12</id> </filter> <client-login>tecnhnolux</client-login> </del> </domain-template> </packet>

This packet deletes two domain templates specified by ID. A positive response got from Plesk server can look as follows:
<packet version=1.4.2.0> <domain-template> <del> <result> <status>ok</status> <id>11</id> </result> <result> <status>ok</status> <id>12</id> </result> </del> </domain-template> </packet>

A negative response can look as follows:


<packet version=1.4.2.0> <domain-template> <del> <result> <status>ok</status> <id>11</id> </result> <result> <status>error</status> <id>12/<id> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> </del> </domain-template></packet>

Supported Operations

445

Managing Domain-Level Mail


Operator: <mail> XML Schema: mail_input.xsd, mail_output.xsd, plesk_mailname.xsd Plesk version: Plesk 7.5.4 for UNIX and later | Plesk 8.1 for Windows and later API RPC version: 1.3.5.0 and higher Plesk user: Plesk Administrator, Plesk Client Description The mail operator allows performing operations on mail service and mail accounts on a particular domain. The mail service settings specify whether the Webmail application is turned on for a particular domain. These settings also specify the mail service behaviour when an incoming message is addressed to a non-existent user. Mail user is the less privileged Plesk user. Creating Plesk mail user is equivalent to creating a special mail account on the specified domain. This operation is allowed to Plesk Administrator and Plesk Client. Mail account presents a collection of settings and lists of various objects. A mail account is created on a certain domain and remains associated with this domain during its lifetime. All objects created within the mail account (autoresponders, redirects, files, etc.) share the disk space of the domain that owns this mail account. Mail accounts are uniquely identified by name/ID of the parent domain and by mail user name. Mail user settings specify the following: Mail name and password, mail aliases Mail user access to his mail account via Plesk Control Panel Mail box settings Mail user permissions Antivirus protection Mail group members (if a mail account is used as a mail group) Groups in which a mail account has membership Files to store in the repository Automatic response messages Mail addresses to which all incoming correspondence will be redirected automatically

For more details, refer to the Mail Service Settings (see page 447) and Mail User Account Settings (see page 448) sections.

Supported Operations

446

Supported operations

CREATE (see page 460) creates a mail account on a specified domain and sets a collection of settings for it UPDATE (see page 464) serves to update mail account settings. It is specially designed to operate lists of mail group members, repository files, and automatic reply messages set for the mail account GET_INFO (see page 470) serves to retrieve various information about the specified mail accounts from Plesk database REMOVE (see page 475) removes the specified mail account and all its settings from Plesk database ENABLE (see page 478) turns on the mail service on the specified domain DISABLE (see page 478) turns off the mail service on the specified domain SET_PREFS (see page 482) sets mail service preferences for the specified domains GET_PREFS (see page 486) gets mail service preferences set for the specified domains RENAME (see page 489) renames the specified mail box

Supported Operations

447

Mail Service Preferences


Mail service settings are defined in the MailPreferences complex type (plesk_mailname.xsd). This type is structured as follows:

The nonexistent-user node is optional. It specifies the way the server handles messages sent to unknown mail users (not registered on the domain). By default, such messages are sent back to the sender with a message: this address no longer accepts mail. The bounce node is used to modify the default rejection message. Data type: string. The forward node specifies the mail address to which undelivered mail should be forwarded. Data type: string. The reject node is used to reject such mail messages (they will not be accepted by the mail server). Data type: none. The webmail node is optional. It specifies whether mail users will have access to their mail via a WebMail application. Data type: Boolean.

The following packet sets mail service preferences for three domains:
<packet version=1.4.2.0> <mail> <set_prefs> <filter> <domain_id>12</domain_id> <domain_id>14</domain_id> <domain_id>15</domain_id> </filter> <prefs> <nonexistent-user> <reject/> </nonexistent-user> <webmail>true</webmail> </prefs> </set_prefs> </mail> </packet>

Supported Operations

448

Mail Account Settings


Mail account settings are specified by complex type mailnameType (plesk_mailname.xsd). It is structured as follows:

The id node is optional. It specifies the identifier of the mail user (if this user already exists in Plesk database). Data type: integer. The name node is required. It specifies the name of the mail user. Data type: string. The cp_access node is optional. It specifies a collection of Plesk GUI settings for the mail user. Data type: none. See the structure of this node in the Control Panel Settings (see page 450) section.

Supported Operations

449

The mailbox node is optional. It specifies a collection of mail box settings. Data type: none. See the structure of this node in the Mail Box Settings (see page 451) section. The redirect node is optional. It enables the redirect feature for the mail account and specifies the email address where the correspondence will be redirected. Data type: none. See the structure of this node in the Redirect Settings (see page 452) section. The mailgroup node is optional. It defines the list of mail addresses for which the mail account will serve as a mail group. This feature implements redirecting mail to multiple addresses. Data type: none. See the structure of this node in the Mail Group Settings (see page 453) section. The group node is optional. It specifies a mail group in which the given mail account has a membership. Data type: string. The alias node is optional. It specifies an alternative name for the given mail name (e.g., the bob alias set for bfisher@example.com means that all mail sent to bob@example.com and to the original address will get to the same mail box). Data type: string. The autoresponders node is optional. It defines a collection of automatic response messages and their settings that will be sent from the given mail account. Data type: none. See the structure of this node in the Automatic response settings (see page 453) section. The repository node is optional. It contains a list of files stored in the repository of the given mail account. These files can be attached to automatic response messages if necessary. Data type: none. See the structure of this node in the Repository Settings (see page 455) section. The password node is optional. It specifies the password used by mail user to access the mail box. Data type: string. The password_type node is optional. It specifies the type of the password. Data type: string. Allowed values: plain | crypt. The antivir node is optional. It specifies the antivirus protection settings for the incoming/outgoing correspondence. Data type: string. Allowed values: off | inout | in | out. This node is renamed to antivir in API RPC 1.4.2.0. In the earlier versions of API RPC, it is called drweb. The permissions node is optional. It specifies a collection of mail user permissions. Data type: MailUserPermission (plesk_mailname.xsd). This node is supported in API RPC 1.4.2.0 and later. See the structure of this node in the Mail User Permissions (see page 457) section.

Supported Operations

450

The following sample packet creates a mail account and sets a collection of settings for it:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>bfischer</name> <cp_access> <enabled>true</enabled> </cp_access> <mailbox> <enabled>true</enabled> <quota>10485760</quota> </mailbox> <alias>bob</alias> <antivir>true</antivir> <permissions> <cp_access>true</cp_access> <manage_drweb>true</manage_drweb> <manage_spamfilter>true</manage_spamfilter> </permissions> </mailname> </filter> </create> </mail> </packet>

Control Panel Settings


The cp_access node is used to enable/disable access to the personal mail user page in Plesk Control Panel (CP). If CP access is allowed, the cp_access node can specify a collection of GUI preferences for the mail user. The cp_access node does not have a special data type, it is nested within the mailname node (see the structure of this node in the Mail User Account Settings (see page 448) section). It is structured as follows:

The enabled node is optional. It is used to enable the CP access to the mail user page. Data type: boolean. The access node is required. It specifies a collection of CP access settings. Data type: none. The locale node is optional. It specifies what language is used when displaying the CP to the mail user. Data type: string.

Supported Operations

451

Note: In API RPC v.1.5.0.0 and later, use four-letter locale names (RFC 1766). The default value for the node is en-US. If you specify a two-letter locale name in a request packet, you will receive the error (error code 1019). The skin_id node is optional. It specifies what interface skin (by ID) is used when displaying the PCP to the mail user. Data type: integer. The multiply_login node is optional. It allows/prohibits creating multiple simultaneous CP sessions with the mail user credentials. Data type: boolean. The disable_lock_screen node is optional. If set to true, it prevents mail user from working with CP until the GUI is completely loaded. Data type: boolean.

The following sample packet creates mail account and sets up CP access to the mail user page:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>bfischer</name> <cp_access> <enabled>true</enabled> <access> <locale>EN-US</locale> <skin_id>11</skin_id> <multiply_login>true</multiply_login> </access> </cp_access> </mailname> </filter> </create> </mail> </packet>

Mail Box Settings


The mailbox node is used to enable/disable the use of a mail box created for a particular mail account, and to restrict the size of the mail box as well. The mailbox node does not have a special data type, it is nested within the mailname (see page 448) node. It is structured as follows:

The enabled node is optional. It shows whether the mail user can use the mail box created on Plesk server. Data type: Boolean. Default value: true. The quota node is optional. It specifies the maximum size of the mail box (in bytes). Data type: integer.

Supported Operations

452

The following sample packet creates a mail account, enables the use of mail box on it, and specifies the limit for the mail box size:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>bfischer</name> <mailbox> <enabled>true</enabled> <quota>1024000</quota> </mailbox> </mailname> </filter> </create> </mail> </packet>

Redirecting Settings
Mail account can redirect all incoming correspondence to a specified e-mail address. To enable the redirect feature for a particular mail account, request packet should contain the redirect node within the mailname parent node. The redirect node does not have a special data type, it is defined within the parent node as follows:

The enabled node is required. It enables the redirect feature for a particular mail account. Data type: boolean. Default value: false. The address node is optional. It holds an email address to which the correspondence will be redirected. Data type: string.

The following sample packet creates a mail account, and makes it redirect all incoming messages to techdept@example.com:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>bfischer</name> <redirect> <enabled>true</enabled> <address>techdept@example.com</address> </redirect> </mailname> </filter> </create> </mail></packet>

Supported Operations

453

Mail Group Settings


Mail account can serve as a mail group: It can be associated with a list of mail addresses to which it will send all incoming correspondence. To enable the mail group functionality for a particular mail account, request packet should contain the mailgroup node within the mailname parent node. The mailgroup node does not have a special data type, it is defined within the parent node as follows:

The enabled node is required. It enables the mail group functionality for the mail account. Data type: boolean. Default value: false. The address node is optional. It holds an email address of this mail group member. Data type: string.

The following sample packet creates a mail account and makes it act as a mail group for the list of email addresses:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>bfischer</name> <mailgroup> <enabled>true</enabled> <address>techdept@example.com</address> <address>automation@example.com</address> </mailgroup> </mailname> </filter> </create> </mail> </packet>

Automatic Response Settings


The automatic response settings are specified for each mail account by the list of autoresponder objects. An autoresponder object is a collection of conditions (events) on which the automatic response message is sent back. In addition, this object specifies the text of this response and the attachment (a file stored in the a mail box repository). Finally, it can specify how this automatic response will act.

Supported Operations

454

The list of autoresponders is specified in the autoresponders node nested within the mailname parent node and structured as follows:

The enabled node is optional. It enables/disables the feature on the mail account. Data type: boolean. Default value: false. The autoresponder node is optional. It specifies an autoresponder object. Data type: none. See the structure of this node below.

The autoresponder node does not have a special data type. It is structured within the autoresponders node as follows:

The name node is required. It specifies the name of the autoresponder. Data type: string. The enabled node is optional. It enables/disables the use of the autoresponder object. Data type: boolean. Default value: false. The keystr node is optional. It specifies the key string in the incoming message that will enable this autoresponder sending back its message. Data type: string. The key_where node is optional. It specifies the part of an incoming message (body, subject) where the key string should be searched. Data type: string. Allowed values: subj | no | body.

Supported Operations

455

The subject node is optional. It specifies the subject field in the incoming message header that will enable this autoresponder sending its message back. Data type: string. The reply_to node is optional. It specifies the Reply to field in an incoming message header that will enable the autoresponder sending back its message. Data type: string. The content_type node is optional. It specifies the Content type field in the incoming message header that will enable the autoresponder sending back its message. Data type: string. Allowed values: text/html | text/plain. The charset node is optional. It specifies the charset field in the incoming message header that will enable the autoresponder sending back its message. Data type: string. The text node is optional. It specifies the text of the automatic response message. Data type: string. The ans_freq node is optional. It specifies the maximum number of automatic replies that can be sent back to the mail address. Data type: integer. The mem_limit node is optional. It specifies the maximum number of unique email addresses that can be stored. Data type: integer. The attachment node is optional. It specifies the name of the file to be attached to the response message. Data type: string. The forward node is optional. It specifies the email address to which the original message will be forwarded. Data type: string.

The following sample packet creates a mail account and specifies autorespoder settings for it:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>123</domain_id> <mailname> <name>bfischer</name> <autoresponders> <enabled>true</enabled> <autoresponder> <name>motorola</name> <subject>Regarding controllers</subject> <text>Your answer will be processed in the nearest 10 days. Thank you.</text> <forward>techdept@technolux.co.uk</forward> </autoresponder> </autoresponders> </mailname> </filter> </create> </mail> </packet>

Supported Operations

456

Repository Settings
Every mail account is provided with a personal file repository. The stored files can be used as attachments to automatically sent messages, or for other needs. A repository presents a collection of file objects, each describing a single file as file name and file contents. The repository node does not have a special data type. It is defined within the parent type mailnameType.

The file node is required. It specifies a single file object. Data type: none. The name node is required. It specifies the file name. Data type: string. The content node is optional. It keeps the file contents. This node can be missing in the response packet if the request one asks for a list of file names only. Data type: base64.

The following get_info response packet returns the list of files stored in the repository of the specified mail account:

<packet version=1.4.2.0> <mail> <get_info> <result> <status>ok</status> <mailname> <name>techdept</name> <repository> <file> <name>attach1.txt</name> </file> <file> <name>attach2.txt</name> </file> </repository> </mailname> </result> </get_info> </mail> </packet>

Supported Operations

457

Mail User Permissions


Starting from API RPC 1.5.0.0. there are two possible ways of retrieving mail user permissions. The way used in the API RPC v.1.4.2.0 and earlier versions is parameterdependable. The other way is parameter-undependable. API RPC v.1.5.0.0 and Later Versions In the API RPC v.1.5.0.0 and later versions you should manage mail user permissions according to the following XML schema:

The permission node is required. It specifies mail user permissions. Data type: PleskPermissionType (plesk_common.xsd). The name node is required. It specifies a permission name. Data type: sting. The value node is required. It specifies a permission value. Data type: anySimple.

Sample

The following packet creates a mail account and sets permissions for it:
<packet version=1.5.0.0> <mail> <create> <filter> <domain_id>123</domain_id> <mailname> <name>bfischer</name> <permissions> <permission> <name>cp_access</name> <value>true</value> </permission> <permission> <name>manage_drweb</name> <value>true</value> </permission>

Supported Operations

458

<permission> <name>manage_spamfilter</name> <value>true</value> </permission> </permissions> </mailname> </filter> </create> </mail> </packet>

API RPC v.1.4.2.0 and Earlier Versions Mail user permissions are defined by complex data type MailUserPermission (plesk_mailname.xsd). This type is structured as follows:

The cp_access node is optional. It allows/prohibits the mail user access to their mail box via Plesk Control Panel. Data type: Boolean. The manage_drweb node is optional. It allows/prohibits the mail user changing settings of the the antivirus software integrated with Plesk (DrWeb). Data type: boolean. The manage_spamfilter node is optional. It allows/prohibits the mail user changing settings of the spam filtering software integrated with Plesk (SpamAssassin). Data type: boolean.

The following packet creates a mail account and sets permissions for it:

<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>123</domain_id> <mailname> <name>bfischer</name> <permissions> <cp_access>true</cp_access> <manage_drweb>true</manage_drweb> <manage_spamfilter>true</manage_spamfilter> </permissions> </mailname> </filter> </create> </mail> </packet>

Supported Operations

459

Filtering Issues
,Filtering is the way request packets pick out mail accounts to which the requested operation will be applied. The mail operator uses filtering in most of its operations. The filter node used in operations create and update is presented by the mailnameFilterType complex type (mail_input.xsd). This data type is structured as follows:

The domain_id node is required. It specifies the domain ID. Data type: integer. The mailname node is required. It holds a collection of mail account settings that will be affected. Data type: mailnameType (plesk_mailname.xsd).

This filter can pick out one to many mail account existing on the same domain. When filtering mail accounts, we never specify the entire mail name. The domain part of it is specified by the domain_id node, and the mail user name is specified by the name node within the mailname section.
<packet version=1.4.2.0> <mail> <update> <add> <filter> <domain_id>12</domain_id> <mailname> <name>ann</name> <mailgroup> <enabled>true</enabled> <address>techdept@example.com</address> <address>findept@example.com</address> <address>techgroup@example.com</address> </mailgroup> </mailname> </filter> </add> </update> </mail> </packet>

The packet above modifies settings of the ann@example.com mail account (a mail group) with several new mail addresses.

Supported Operations

460

The mail operator uses two more types of filtering (type GetInfoAdvancedFilter, type mailFilterType). These types are designed for particular cases and considered in the relevant sections (Getting Mail Account Settings (see page 470) and Deleting Mail Accounts (see page 475), respectively).

Creating Mail Accounts


Mail user account can be created on the specified domain either by Plesk Administrator or by Plesk Client. To register new mail account in Plesk database, it is enough to specify some general setup information, namely: the domain ID where the mail account will be registered, and the mail account name. In addition, you can specify various mail account settings (all of them are optional): Mail user access to the account via Plesk Control Panel Mail box size Mail box alias Mail user permissions Antivirus protection Mail group members (if the account acts as a mail group) Mail groups in which the mail account has membership Files to store in the repository Automatic response messages Mail addresses to which all incoming correspondence will be redirected automatically

A mail account can have all these settings specified, or it can hold just some of them. You can specify these settings when creating a mail account or later (they can be set using the set_prefs operation).

Request Packet Structure


A request XML packet creating a mail account in Plesk database includes the create operation node:
<packet version=1.4.2.0> <mail> <create> </create> </mail> </packet>

Supported Operations

461

The create node does not have a separate type, it is nested within the MailTypeRequest type (mail_input.xsd). The create node has the following graphics representation:

The filter node is required. It holds a collection of data describing mail accounts to be created. Data type: mailnameFilterType (plesk_mailname.xsd) The domain_id node is required. It uniquely identifies the domain on which the mail account will be created. Data type: integer. The mailname node is required. It defines the name of a mail account, and a collection of mail account settings (if any specified). Data type: mailnameType (plesk_mailname.xsd). See the structure of this node in the Mail User Account Settings (see page 448) section.

Request Samples
The following packet creates on a single domain two mail accounts with a minimum of settings:
<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailbox> <enabled>true</enabled> </mailbox> <password>12345</password> <password_type>crypt</password_type> <permissions> <cp_access>true</cp_access> </permissions> </mailname> <mailname> <name>techdept</name> <mailbox> <enabled>true</enabled> </mailbox> </mailname> </filter> </create> </mail> </packet>

Supported Operations

462

To create multiple mail accounts on different domains within one packet, use multiple create nodes:

<packet version=1.4.2.0> <mail> <create> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailbox> <enabled>true</enabled> </mailbox> <password>12345</password> <password_type>crypt<password_type> <permissions> <cp_access>true</cp_access> </permissions> </mailname> </filter> </create> <create> <filter> <domain_id>13</domain_id> <mailname> <name>admin</name> <mailbox> <enabled>true</enabled> </mailbox> <password>qwerty123456</password> <password_type>plain<password_type> </mailname> </filter> </create> </mail> </packet>

Mail accounts can be created by Plesk Administrator or by Plesk Clients. The packets are similar in both cases, except for Plesk Clients can create mail accounts on their own domains only.

Supported Operations

463

Response Packet Structure


The create node of the response packet is structured as follows:

The result node is required. It wraps the result of the requested create operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the create operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Returns an error code when the create operation fails. Data type: unsignedInt. The errtext node is optional. Returns an error message if the create operation fails. Data type: string. The mailname node is optional. It is required if the create operation succeeds. Returns a collection of settings set for the mail account that has just been created. Data type: mailnameType (plesk_mailname.xsd). To see the structure of this node, refer to the Mail User Account Settings (see page 448) section.

Response Samples
A positive response received from server after creating two mail accounts on the same domain looks as follows:
<packet version=1.4.2.0> <mail> <create> <result> <status>ok</status> <mailname> <name>techdept</name> </mailname> </result> <result> <status>ok</status> <mailname> <name>findept</name> </mailname> </result> </create> </mail> <output>c</output></packet>

Supported Operations

464

A negative response can look as follows:


<packet version=1.4.2.0> <mail> <create> <result> <status>error</status> <errcode>1015</errcode> <errtext>Object owner not found.</errtext> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </create> </mail> </packet>

The result blocks do not indicate creation of which mail accounts has failed. To distinguish between multiple requests, you can rely on the order they followed one another in the request packet.

Modifying Mail Account Settings


Mail account settings can be modified either by Plesk Administrator or by Plesk Client. These settings are as follows: Mail user access to his account via Plesk Control Panel Mail box size Mail box alias Mail user permissions Antivirus protection Mail group members (if an account acts as a mail group) Mail groups in which the mail account has membership Files stored in the account repository Automatic response messages Mail addresses to which all incoming correspondence will be redirected automatically

The update operation is presented by three sub-operations: add, remove, and set. All these sub-operations were designed for working with the lists of objects kept in mail accounts. The add sub-operation is a typical update operation. It means that all the setting specified in the packet will be added to a mail account, and the settings already existing will be kept unchanged. This sub-operation can be applied to any setting. The remove sub-operation is a typical delete operation. It means that all the setting specified in the packet will be removed from a mail account. The settings not mentioned in the packet will be kept unchanged.

Supported Operations

465

The set sub-operation is a hybrid (delete + update) operation. It means that all settings specified in the packet will replace all the settings already existing for the mail account.

Request Packet Structure


A request XML packet updating mail account settings includes the update operation node:
<packet version=1.4.2.0> <mail> <update> </update> </mail> </packet>

The update node does not have a separate data type, it is nested within the MailTypeRequest complex type (mail_input.xsd). The update node has the following graphics representation:

The update operation breaks into three types of update: The add node is required. If specified, it adds the passed in settings to the mail account (all previously set settings are kept unchanged). Data type: none. The remove node is required. If specified, it removes the passed in settings from the specified mail account. Data type: none. The set node is required. If specified, it removes all previously set settings from the mail user account and sets the passed in settings anew. Data type: none. The filter node is required. It specifies the domain which mail accounts will be modified, and the settings of each account as well. Data type: mailnameFilterType (mail_input.xsd). See the structure of this node in the Filtering Issues (see page 459) section.

Supported Operations

466

Request Samples
Adding new mail account settings The following packet updates a mail account as follows: New email addresses are added to the mail group created on basis of this account.
<packet version=1.4.2.0> <mail> <update> <add> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailgroup> <enabled>true</enabled> <address>techdept@advent.co.uk</address> <address>findept@advent.co.uk</address> <address>techgroup@advent.co.uk</address> </mailgroup> </mailname> <mailname> <name>webmaster</name> <mailgroup> <enabled>true</enabled> <address>bob@advent.co.uk</address> <address>ann@advent.co.uk</address> <address>nick@advent.co.uk</address> </mailgroup> </mailname> </filter> </add> </update> </mail> </packet>

To add new settings to email accounts that belong to different domains, use multiple create elements:
<packet version=1.4.2.0> <mail> <update> <add> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailgroup> <enabled>true</enabled> <address>techdept@advent.co.uk</address> <address>findept@advent.co.uk</address> <address>techgroup@advent.co.uk</address> </mailgroup> </mailname> </filter> </add> </update>

Supported Operations <update> <add> <filter> <domain_id>13</domain_id> <mailname> <name>bfischer</name> <mailgroup> <enabled>true</enabled> <address>bob@techservice.co.uk</address> <address>ann@techservice.co.uk</address> <address>nick@techservice.co.uk</address> </mailgroup> </mailname> </filter> </add> </update> </mail> </packet>

467

Removing mail account settings The following packet removes several email addresses from mail groups created by the previous sample packet:
<packet version=1.4.2.0> <mail> <update> <remove> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailgroup> <enabled>true</enabled> <address>techgroup@advent.co.uk</address> </mailgroup> </mailname> <mailname> <name>webmaster</name> <mailgroup> <enabled>true</enabled> <address>ann@techservice.co.uk</address> <address>nick@techservice.co.uk</address> </mailgroup> </mailname> </filter> </remove> </update> </mail> </packet>

The first mail group stores two addresses now (techdept@advent.co.uk and findept@advent.co.uk). The second mail group stores one address (bob@techservice.co.uk). Setting new mail account settings

Supported Operations

468

The following packet removes all email addresses from mail groups of the specified two email user accounts. After that the new addresses are added to the lists:
<packet version=1.4.2.0> <mail> <update> <set> <filter> <domain_id>12</domain_id> <mailname> <name>admin</name> <mailgroup> <enabled>true</enabled> <address>techgroup@advent.co.uk</address> <address>fingroup@advent.co.uk</address> </mailgroup> </mailname> <mailname> <name>webmaster</name> <mailgroup> <enabled>true</enabled> <address>ann@techservice.co.uk</address> <address>nick@techservice.co.uk</address> </mailgroup> </mailname> </filter> </set> </update> </mail> </packet>

Response Packet Structure


The update node of the response packet is structured as follows:

The add node is required. It returns the result of the add sub-operation (the passedin settings are added to the mail account, all previously set settings are kept unchanged). Data type: none. The remove node is required. It returns the result of the remove sub-operation (the passed-in settings are removed from the mail account, other settings are kept unchanged). Data type: none.

Supported Operations

469

The set node is required. It returns the result of the set sub-operation (all previously set settings are removed, after which the passed-in settings are applied to the mail account). Data type: none. The result node is required. It wraps the result of the update operation. Data type: operationresultType (mail_output.xsd). The status node is required. It returns the execution status of the update operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns an error code when the update operation fails. Data type: unsignedInt. The errtext node is optional. It returns an error message if the update operation fails. Data type: string. The mailname node is optional. It is required if the update operation succeeds. Returns a collection of updated settings of the specified mail account(s). Data type: mailnameType (plesk_mailname.xsd). To see the structure of this node, refer to the Mail User Account Settings (see page 448) section.

Response Samples
Here is a sample response received from server after the specified mail accounts are updated with new settings successfully:
<packet version=1.4.2.0> <mail> <update> <add> <result> <status>ok</status> <mailname> <name>admin</name> </mailname> </result> <result> <status>ok</status> <mailname> <name>webmaster</name> </mailname> </result> </add> </update> </mail> </packet>

The packets received after removing/resetting mail account settings have the similar structure.

Supported Operations

470

If the update operation on any mail account fails, a negative response packet looks as follows:
<packet version=1.4.2.0> <mail> <update> <add> <result> <status>error</status> <errcode>1015</errcode> <errtext>Object owner not found.</errtext> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <mailname> <name>techdept</name> </mailname> </result> </add> </update> </mail> </packet>

If the result blocks do not indicate what particular email account failed, you can rely on the order they followed one another in the request packet.

Getting Mail Account Settings


Plesk Administrator can get settings of any mail account registered on any domain. Plesk Clients are allowed to get settings of mail accounts registered on their own domains only. The settings are as follows: Mail account identifier, name, and alias Plesk Control Panel access settings Mail box settings Automatic responses, redirects, stored files Mail group settings Mail user permissions

Use the get_info operation to retrieve domain settings.

Supported Operations

471

Request Packet Structure


A request XML packet getting a collection of mail account settings should include the get_info operation node:
<packet version=1.4.2.0> <mail> <get_info> </get_info> </mail> </packet>

The get_info node does not have a separate type, it is nested within the MailTypeRequest complex type (mail_input.xsd). The get_info node has the following graphics representation:

The filter node is required. It holds a collection of data describing which mail account settings to retrieve. Data type: GetInfoAdvancedFilter (mail_input.xsd). The domain_id node is required. It specifies the identifier of the domain which mail accounts are requested. Data type: integer. The name node is optional. It specifies the name of the mail account. Data type: string. The cp_access node is optional. It indicates that Plesk Control Panel settings of the specified mail account are requested. Data type: none.

Supported Operations

472

The mailbox node is optional. It indicates that mail box settings of the specified mail account are requested. Data type: none. The redirect node is optional. It indicates that the list of redirects of the specified mail account is requested. Data type: none. The group node is optional. It indicates that the mail group settings of the specified mail account are requested. Data type: none. The groups node is optional. It indicates that the list of mail groups in which the given account has a membership is requested. Data type: none. The aliases node is optional. It indicates that the list of aliases of the given mail account is requested. Data type: none. The autoresponders node is optional. It indicates that the list of automatic-response objects of the given mail account is requested. Data type: none. The repository node is optional. It indicates that the list of files stored in the repository of the given mail account is requested. Data type: none. The repository_content node is optional. It indicates that the list of files and their contents stored in the repository of the given mail account is requested. Data type: none. The permissions node is optional. It indicates that a collection of permissions set for the given mail user is requested. Data type: none. This node is supported by API RPC 1.4.2.0 and later.

Request Samples
The following sample packet requests for information on two mail accounts belonging to the same domain:
<packet version=1.4.2.0> <mail> <get_info> <filter> <domain_id>12</domain_id> <name>techservice</name> <name>techknowledge</name> </filter> <cp_access/> <mailbox/> <aliases/> <permissions/> </get_info> </mail> </packet>

To request information on mail accounts belonging to different domains, use multiple get_info sections:
<packet version=1.4.2.0> <mail> <get_info> <filter> <domain_id>12</domain_id> <name>techservice</name> <name>techknowledge</name> </filter>

Supported Operations <cp_access/> <mailbox/> </get_info> <get_info> <filter> <domain_id>13</domain_id> <name>admin</name> </filter> <permissions/> </get_info> </mail> </packet>

473

Response Packet Structure


The get_info node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested get_info operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the get_info operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code if the get_info operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the get_info operation fails. Data type: string. The mailname node is required if the get_info operation succeeds. It contains a collection of mail account settings ordered in the request packet. Data type: mailnameType (plesk_mailname.xsd). See the structure of this node in the Mail Account Settings (see page 448) section.

Supported Operations

474

Response Samples
A positive response that returns the requested information for the specified mail accounts can look as follows:
<packet version=1.4.2.0> <mail> <get_info> <result> <status>ok</status> <mailname> <name>techdept</name> <cp_access> <enabled>true</enabled> <access> <locale>EN-US</locale> <skin_id>11</skin_id> <multiply_login>true</multiply_login> <disable_lock_screen>false</disable_lock_screen> </access> </cp_access> </mailname> </result> <result> <status>ok</status> <mailname> <name>techknowledge</name> <cp_access> <enabled>false</enabled> <access> </access> </cp_access> </mailname> </result> </get_info> </mail> </packet>

A negative response can look as follows:


<packet version=1.4.2.0> <mail> <get_info> <result> <status>error</status> <errcode>1013</errcode> <errtext>Object not found.</errtext> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <mailname> <name>techknowledge</name> </mailname> </result> </get_info> </mail></packet>

Supported Operations

475

Deleting Mail Accounts


The remove operation is used to remove one to many mail accounts at one stroke, provided all these accounts refer to the same domain. Plesk Administrator can remove any mail account registered in Plesk, while a Plesk Client can delete mail accounts referring to domains that belong to this Plesk Client only.

Request Packet Structure


A request XML packet that deletes mail accounts should include the remove operation node:
<packet version=1.4.2.0> <mail> <remove> </remove> </mail> </packet>

The remove node does not have a separate type, it is nested within the MailTypeRequest type (mail_input.xsd). The remove node has the following graphics representation:

The filter node is required. It specifies what mail accounts should be removed. Data type: mailFilterType (mail_input.xsd). The domain_id node is required. It specifies the identifier of the domain which mail account (or several) will be deleted. Data type: integer. The name node is optional. It specifies the name of the mail account to be deleted. Data type: string.

Remarks To remove all mail accounts existing on a domain, include to your request packet filter rule containing only domain_id node.

Supported Operations

476

Request Samples
The following packet deletes several mail accounts belonging to one domain:
<packet version=1.4.2.0> <mail> <remove> <filter> <domain_id>12</domain_id> <name>techdept</name> <name>techknowledge</name> <name>findept</name> <name>proddept</name> </filter> </remove> </mail> </packet>

To delete several mail accounts belonging to different domains, use multiple remove sections:
<packet version=1.4.2.0> <mail> <remove> <filter> <domain_id>12</domain_id> <name>techdept</name> <name>techknowledge</name> </filter> </remove> <remove> <filter> <domain_id>13</domain_id> <name>findept</name> <name>proddept</name> </filter> </remove> </mail> </packet>

To delete all mail accounts from the specified domain, the following packet can be used:
<packet version=1.4.2.0> <mail> <remove> <filter> <domain_id>12</domain_id> </filter> </remove> </mail> </packet>

Supported Operations

477

Response Packet Structure


The remove node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested remove operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the del operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Returns an error code when the remove operation fails. Data type: unsignedInt. The errtext node is optional. Returns an error message if the remove operation fails. Data type: string. The mailname node is required if the remove operation succeeds. It contains a settings of the mail account that has been deleted. Data type: mailnameType. See the structure of this node in the Mail User Account Settings (see page 448) section.

Response Samples
A positive response received from server after deleting particular mail accounts looks as follows:
<packet version=1.4.2.0> <mail> <remove> <result> <status>ok</status> <mailname> <name>techdept</name> </mailname> </result> <result> <status>ok</status> <mailname> <name>techknowledge</name> </mailname> </result> </set_prefs> </mail> </packet>

Supported Operations

478

A negative response can look as follows:


<packet version=1.4.2.0> <mail> <remove> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <mailname> <name>techdept</name> </mailname> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <mailname> <name>techknowledge</name> </mailname> </result> </set_prefs> </mail> </packet>

Enabling/Disabling Mail Service on Domain


Use the enable (disable) operation to enable (disable) mail service on a particular domain.

Request Packet Structure


A request XML packet that enables mail service on the specified domain contains the enable operation node:
<packet version=1.4.2.0> <mail> <enable> </enable> </mail> </packet>

The enable node does not have a separate data type, it is nested within the MailTypeRequest type (mail_input.xsd). The enable node has the following graphics representation:

The domain_id node is required. It indicates the domain on which mail service should be turned on. Data type: integer.

Supported Operations

479

A request XML packet that disables mail service on the specified domain contains the disable operation node:
<packet version=1.4.2.0> <mail> <disable> </disable> </mail> </packet>

The disable node does not have a separate data type, it is nested within the MailTypeRequest complex type (mail_input.xsd). The disable node has the following graphics representation:

The domain_id node is required. It indicates the domain on which mail service should be turned off. Data type: it_type (integer).

Request Samples
The following request packet demonstrates how mail service can be enabled on multiple domains:
<packet version=1.4.2.0> <mail> <enable> <domain_id>11</domain_id> </enable> <enable> <domain_id>12</domain_id> </enable> <enable> <domain_id>15</domain_id> </enable> </mail> </packet>

To disable mail service on multiple domains, send the following request:


<packet version=1.4.2.0> <mail> <disable> <domain_id>11</domain_id> </disable> <disable> <domain_id>12</domain_id> </disable> <disable> <domain_id>15</domain_id> </disable> </mail> </packet>

Supported Operations

480

API RPC allows the use of both these operations within a single packet and within the same mail operator:
<packet version=1.4.2.0> <mail> <enable> <domain_id>11</domain_id> </enable> <disable> <domain_id>12</domain_id> </disable> </mail> </packet>

Response Packet Structure


The enable node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested enable operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the enable operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return an error code if the enable operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the enable operation fails. Data type: string.

Supported Operations

481

The disable node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested disable operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the disable operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return an error code if the disable operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the disable operation fails. Data type: string.

Response Samples
If the mail service has been turned on the domain successfully, a positive response arrives from Plesk server:
<packet version=1.4.2.0> <mail> <enable> <result> <status>ok</status> </result> </enable> </mail> </packet>

A positive response for the disable operation looks similarly. If the mail service has been turned on the multiple domains, a positive response from Plesk server looks as follows:
<packet version=1.4.2.0> <mail> <enable> <result> <status>ok</status> </result> <result> <status>ok</status> </result> <result> <status>ok</status> </result> </enable> </mail></packet>

Supported Operations

482

The results will be returned in the order the enable node have been sent in the request packet. If the enable operation fails, a negative response packet looks as follows:
<packet version=1.4.2.0> <mail> <enable> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> <result> <status>ok</status> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </enable> </mail> </packet>

The results (both positive and negative) will be returned in the order the enable node have been sent in the request packet.

Setting Mail Service Preferences


Use the set_prefs operation to set mail service preferences on the specified domains.

Request Packet Structure


A request XML packet setting mail service preferences for the specified domains includes the set_prefs operation node:
<packet version=1.4.2.0> <mail> <set_prefs> </set_prefs> </mail> </packet>

Supported Operations

483

The set_prefs node does not have a separate data type, it is nested within the MailTypeRequest type (mail_input.xsd). The set_prefs node has the following graphics representation:

The filter node is required. It specifies a list of domains on which mail service settings are modified. Data type: none. The domain_id node is optional. It specifies the identifier of the domain on which mail service settings are modified. Data type: integer. The prefs node is required. It specifies a collection of mail service preferences that will be set for the specified domains. Data type: MailPreferences. The structure of this node is described in the Mail Service Settings (see page 447) section.

Request Samples
Setting Mail Service Preferences under Plesk Administrator Plesk Administrator can set mail service preferences for all domains registered in Plesk. The following packet demonstrates how Plesk Administrator changes mail service settings the same way on three domains.
<packet version=1.4.2.0> <mail> <set_prefs> <filter> <domain_id>12</domain_id> <domain_id>14</domain_id> <domain_id>15</domain_id> </filter> <prefs> <nonexistent-user> <reject/> </nonexistent-user> <webmail>true</webmail> </prefs> </set_prefs> </mail> </packet>

To set different settings for different domains within a single packet, use multiple set_prefs elements:
<packet version=1.4.2.0> <mail> <set_prefs> <filter> <domain_id>12</domain_id> </filter> <prefs> <nonexistent-user> <reject/>

Supported Operations </nonexistent-user> <webmail>true</webmail> </prefs> </set_prefs> <set_prefs> <filter> <domain_id>13</domain_id> <domain_id>14</domain_id> </filter> <prefs> <nonexistent-user> <forward>techdept@advent.co.uk</forward> </nonexistent-user> <webmail>false</webmail> </prefs> </set_prefs> </mail> </packet>

484

If the filter is empty, the specified settings will be applied to all domains registered in Plesk:
<packet version=1.4.2.0> <mail> <set_prefs> <filter/> <prefs> <webmail>true</webmail> </prefs> </set_prefs> </mail> </packet>

Setting Email Service Settings under Plesk Client All the use cases of the set_prefs operation node for Plesk Clients are similar to those for Plesk Administrator. The only difference is that an empty filter means that the specified settings will be applied to all domains belonging to the Plesk Client sending the packet:
<packet version=1.4.2.0> <mail> <set_prefs> <filter/> <prefs> <webmail>true</webmail> </prefs> </set_prefs> </mail> </packet>

Supported Operations

485

Response Packet Structure


The set_prefs node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested set_prefs operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the set_prefs operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return an error code if the set_prefs operation fails. Data type: unsignedInt. The errtext node is optional. Can be used to return an error message if the set_prefs operation fails. Data type: string. The domain_id node is optional. Returns the identifier of the domain on which mail service settings have been modified. Data type: integer.

Response Samples
A positive response received from Plesk server after mail service settings are modified looks as shown below. This packet returns the result of modifications applied to two domains.
<packet version=1.4.2.0> <mail> <set_prefs> <result> <status>ok</status> <domain_id>12</domain_id> </result> <result> <status>ok</status> <domain_id>13</domain_id> </result> </set_prefs> </mail> </packet>

Supported Operations

486

If the operation fails, a negative response can look as follows:


<packet version=1.4.2.0> <mail> <set_prefs> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <domain_id>12</domain_id> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <domain_id>13</domain_id> </result> </set_prefs> </mail> </packet>

Getting Mail Service Preferences


Use the set_prefs operation to retrieve mail service settings set for the specified domains.

Request Packet Structure


A request XML packet that asks for mail service settings for a certain domain should include the get_prefs operation node:
<packet version=1.4.2.0> <mail> <get_prefs> </get_prefs> </mail> </packet>

The get_prefs node does not have a separate type, it is nested within the MailTypeRequest type (mail_input.xsd). The get_prefs node has the following graphics representation:

The filter node is required. It holds a list of domains which mail service settings are requested. Data type: none. The domain_id node is optional. It specifies an identifier of the domain which mail service settings are requested. Data type: integer.

Supported Operations

487

Request Samples
Getting Mail Service Settings under Plesk Administrator Plesk Administrator can get mail service preferences for all domains registered in Plesk. The following packet demonstrates how Plesk Administrator requests for mail service settings of three domains: To get the mail service settings set for particular domains, use the following packet:
<packet version=1.4.2.0> <mail> <get_prefs> <filter> <domain_id>12</domain_id> <domain_id>14</domain_id> <domain_id>15</domain_id> </filter> </get_prefs> </mail> </packet>

To request these settings for all domains registered in Plesk, the following packet must be used:
<packet version=1.4.2.0> <mail> <get_prefs> <filter/> </get_prefs> </mail> </packet>

Getting Mail Service Settings under Plesk Client All the use cases of the get_prefs operation for Plesk Clients are similar to those for Plesk Administrator, described above. The only difference is that an empty filter means that the specified settings will be retrieved from all domains belonging to Plesk Client sending the packet:
<packet version=1.4.2.0> <mail> <get_prefs> <filter/> </get_prefs> </mail> </packet>

Supported Operations

488

Response Packet Structure


The get_prefs node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested get_prefs operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd). The status node is required. Returns the execution status of the get_prefs operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Returns an error code when the get_prefs operation fails. Data type: unsignedInt. The errtext node is optional. Returns an error message if the get_prefs operation fails. Data type: string. The domain_id node is optional. Returns the identifier of the domain which mail service settings are retrieved. Data type: integer. The prefs node is optional. Returns a collection of mail service preferences set for the specified domain. Data type: MailPreferences (plesk_mail.xsd). The structure of the node is described in the Mail Service Settings (see page 447) section.

Response Samples
A positive response that returns mail service settings for two specified domains looks as follows:
<packet version=1.4.2.0> <mail> <get_prefs> <result> <status>error</status> <domain_id>12</domain_id> <prefs> <nonexistent-user> <reject/> </nonexistent-user> <webmail>true</webmail> </prefs> </result>

Supported Operations <result> <status>error</status> <domain_id>13</domain_id> <prefs> <nonexistent-user> <forward>techdept@advent.co.uk</forward> </nonexistent-user> <webmail>true</webmail> </prefs> </result> </get_prefs> </mail> </packet>

489

If the operation fails, a negative response can look as follows:


<packet version=1.4.2.0> <mail> <get_prefs> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <domain_id>12</domain_id> </result> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> <domain_id>13</domain_id> </result> </get_prefs> </mail> </packet>

Renaming Mail Accounts


Use the rename operation to rename a mail account.

Request Packet Structure


A request XML packet setting a new name for an existing mail account should include the rename operation node:
<packet version=1.4.2.0> <mail> <rename> </rename> </mail> </packet>

Supported Operations

490

The rename node does not have a separate type, it is nested within the MailTypeRequest type (mail_input.xsd). The rename node has the following graphics representation:

The domain_id node is required. It identifies the domain that owns the mail account. Data type: integer. The name node is required. It specifies the current name of the mail account. Data type: string. The new-name node is required. It specifies the new name for the mail account. Data type: string.

Request Samples
The following request packet renames mail account existing on the domain with ID 11:
<packet version=1.4.2.0> <mail> <rename> <domain_id>11</domain_id> <name>admin</name> <new-name>administrator</new-name> </rename> </mail> </packet>

To rename multiple mail accounts with a single packet, use a separate rename section for each:
<packet version=1.4.2.0> <mail> <rename> <domain_id>11</domain_id> <name>admin</name> <new-name>administrator</new-name> </rename> <rename> <domain_id>11</domain_id> <name>common</name> <new-name>main</new-name> </rename> </mail> </packet>

Supported Operations

491

Response Packet Structure


The rename node of the response packet is structured as follows:

The result node is optional. It wraps the result of the requested rename operation. Data type: resultType (common.xsd). The status node is required. It returns the execution status of the rename operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Returns an error code when the rename operation fails. Data type: unsignedInt. The errtext node is optional. Returns an error message if the rename operation fails. Data type: string.

Response Samples
After the specified mail account is renamed successfully, a positive response arrives from Plesk server:
<packet version=1.4.2.0> <mail> <rename> <result> <status>ok</status> </result> </rename> </mail> </packet>

If the request packet renames multiple accounts, the response packet will look as follows:
<packet version=1.4.2.0> <mail> <rename> <result> <status>ok</status> </result> </rename> <rename> <result> <status>ok</status> </result> </rename> </mail> </packet>

Supported Operations

492

The packet will return the result for every filtered domain within a separate rename node. The results will follow one another in the order they have been sent in the request packet. If the operation fails, a negative response can look as follows:
<packet version=1.4.2.0> <mail> <rename> <result> <status>error</status> <errcode>1023</errcode> <errtext>Operation failed.</errtext> </result> </rename> </mail> </packet>

Managing FTP Accounts


Operator: <ftp-user> XML Schema: ftpuser.xsd Plesk version: Plesk 8.1 for Windows API RPC version: 1.4.2.0 Plesk user: Plesk Administrator, Plesk Client Description Generally speaking, Plesk supports two types of FTP accounts: default and additional. The ftp-user operator affects only additional FTP accounts, accounts of the 'default' type are managed with the domain (see page 290) and webuser (see page 891) operators. Default FTP accounts are the following: Domain user's account (see page 317), which gives access to the whole domain directory. It is always created in Plesk during creating new domain account. Subdomain user's account, which gives access to subdomain's directory located in parent domain directory. It is created if the 'Create a separate FTP user account for this subdomain' option was defined while creating a subdomain. Web user's account (see page 892), which gives access to web user's directory located in domain directory. It is always created in Plesk during creating new web user.

Additional FTP accounts are FTP accounts that can be created and used in addition to default ones. They bring flexibility to managing FTP access to domains, allowing users - other than domain, subdomain and web user - to access particular domain directory with particular rights.

Supported Operations

493

Plesk Administrators can manage FTP accounts on all domains. Plesk Clients can manage FTP accounts on all domains created for their account on conditions that they are granted the FTP subaccount management permission (see page 38). Supported operations

ADD (see page 497) creates FTP account on a domain specified by its name or ID SET (see page 510) changes properties of a specified FTP account DEL (see page 517) deletes FTP account from a specified domain GET (see page 504) retrieves information on properties of specified FTP accounts on particular domains

FTP Account Permissions


FTP account permissions are presented by type FtpUserPermissions (ftpuser.xsd). It is structured as follows:

The read node is optional. It specifies if the FTP user has read permissions for his home directory (i.e., list folders and files and download files located in it). Data type: boolean. The write node is optional. It specifies if the FTP user has write permissions for his home directory (i.e., create and delete folders, upload, delete and append files). Data type: boolean.

Supported Operations

494

Filtering Issues
Filtering is the way the request packets pick out FTP accounts to which the requested operation will be applied.

Filtering in Requests
The filter node is presented by the FtpUserFilterType complex type (ftpuser.xsd). This data type is structured as follows:

The id node is required. It specifies the FTP account ID in Plesk database. Data type: integer. The name node is required. It specifies the name of FTP account. Data type: string. The domain-id node is required. It specifies the unique identifier of the domain on which the FTP account exists. Data type: integer. The domain-name node is required. It specifies the name of the domain (in Unicode) on which the FTP account exists. Data type: string.

The filter allows two kinds of filtering:

Nodes id and name serve to filter one to many FTP accounts individually. Individual filtering is allowed to Plesk Administrator, Plesk Client (on their own domains) and Plesk Domain Administrators (on their own domain). Nodes domain-id and domain-name serve to filter all FTP accounts on a certain domain (or several) at one stroke. This kind of filtering is allowed to Plesk Administrator, and Plesk Client (on their own domains).

Supported Operations

495

Individual filtering The following packet requests information on properties of three FTP accounts specified by their ID:
<packet version=1.4.2.0> <ftp-user> <get> <filter> <id>65</id> <id>66</id> <id>67</id> </filter> </get> </ftp-user> </packet>

The following packet is identical except it specifies accounts by their names:


<packet version=1.4.2.0> <ftp-user> <get> <filter> <name>willy</name> <name>billy</name> <name>dilly</name> </filter> </get> </ftp-user> </packet>

The following packet is invalid as both the id and the name nodes are used in the same filter:

<packet version=1.4.2.0> <ftp-user> <get> <filter> <name>willy</name> <id>66</id> <name>dilly</name> </filter> </get> </ftp-user> </packet>

Supported Operations

496

Bulk filtering The following packet deletes all FTP accounts existing on domains specified by ID:
<packet version=1.4.2.0> <ftp-user> <del> <filter> <domain-id>638</domain-id> <domain-id>1498</domain-id> </filter> </del> </ftp-user> </packet>

The same packet specifies domains by name:


<packet version=1.4.2.0> <ftp-user> <del> <filter> <domain-name>doe1.com</domain-name> <domain-name>doe2.com</domain-name> </filter> </del> </ftp-user> </packet>

The following packet is invalid as it uses both the domain-id and the domain-name nodes within one filter:
<packet version=1.4.2.0> <ftp-user> <del> <filter> <domain-id>638</domain-id> <domain-name>doe2.com</domain-name> </filter> </del> </ftp-user> </packet>

The following packet sent by Plesk Administrator deletes all FTP accounts existing in Plesk. If sent by Plesk Client, it deletes all FTP accounts on all domains of this Client, if by Plesk Domain Administrator, on his domain.
<packet version=1.4.2.0> <ftp-user> <del> <filter/> </del> </ftp-user> </packet>

Supported Operations

497

Filtering in Responses

If an operation in a request packet (del, get, set) uses filters, the filter-id node is nested in a response packet. It returns the filtering rule. If one of the following values was set as a filter rule, it is returned as the filter-id value in the response packet: FTP account ID FTP account name Domain ID Domain name

It is done so to trace the request parameters in case of an error. Data type: anySimple. The node value can be integer (domain or FTP account ID) or a string (domain or FTP account name). If the filter node is left blank (<filter/>), the filter-id parameter will hold the ID of the object. The blank filter means that all objects are matched by this rule. Note: The filter-id node appears in API RPC 1.4.2.0. Earlier versions of the protocol do not support this node (it is optional for them).

Creating FTP Accounts


To create an FTP account on a domain, use the add operation. The number of accounts that can be created on a particular domain is restricted with the 'Maximum number of additional FTP accounts domain limit (see page 305), or/and by client limit (see page 35) of the same name. Note: Plesk Clients can specify quota on disk space used by home directory only if they are granted the Hard disk quota assignment permission (see page 38).

Request Packet Structure


A request XML packet creating FTP account on a domain includes the add operation node:
<packet version=1.4.2.0> <ftp-user> <add> </add> </ftp-user> </packet>

Supported Operations

498

The add node is presented by the FtpUserAddInputType complex type (ftpuser.xsd). The node has the following graphical representation:

The name node is required. It specifies the name under which the FTP account will be known in Plesk, and the account login. Data type: string. The password node is required. It specifies the FTP account password. Data type: string. The home node is required. It specifies the home directory of the account, i.e., the directory access to which is granted for the account user. Data type: string. The create-non-existent node is optional. It specifies if the home directory should be created or not. This node with value true is required if the home directory defined by the home node does not exist on the domain. Data type: boolean. The quota node is optional. It specifies the maximum total size of files and folders (in bytes) that the FTP account user can create in or upload to the home directory. Data type: integer. The permissions node is optional. It specifies the FTP account permissions for home directory. For more information, refer to section FTP Account Permissions (see page 493). Data type: FtpUserPermissions. The domain-id node is required. It specifies the ID of the domain on which the FTP account is created. Data type: integer. The domain-name node is required. It specifies the name of the domain (in unicode) on which the FTP account is created. Data type: string.

Supported Operations

499

Remarks 1. FTP account name must be unique in Plesk, meaning that two FTP accounts with the same name cannot be crated, even if you want to crate them on different domains. 2. The default home directory for any new additional FTP account is the domain root directory (namely, "/"). If you want FTP account created with request packet to have a default home directory, include an empty home node to your request:
<home/>

If you want to specify account home directory other than default, in the home node specify a full path to desired directory, starting with root domain directory. For example:
<home>/httpdocs/billy/pub</home>

3. Creating new folders in domain root directory is prohibited by Plesk. Therefore, it is impossible to make some /Global_Upload folder a home directory for an account. Do not include to your packets lines like
<home>/Global_Upload</home> <create-non-existent>true</create-non-existent>

4. To create FTP account with unlimited quota, specify value "-1" in the quota node:
<quota>-1</quota>

5. With one add operation, you can create only one FTP account on a domain specified either by name or by ID. 6. With one packet, you can create as many different FTP accounts on different domains as you want. To create multiple FTP accounts, use the required number of add nodes in the packet.

Request Samples
Creating single FTP accounts This packet creates FTP account, with only required settings specified, on domain with ID "48". The FTP account created with this packet will have name and login ftpuser1 and password jdnHHbe6Gc. User of this account will have access to the domain directory httpdocs, with unspecified permissions. Total size of files that this FTP user is allowed to upload will be limited to default values defined by domain or domain owner limits.
<packet version="1.4.2.0"> <ftp-user> <add> <name>ftpuser1</name> <password>jdnHHbe6Gc</password> <home/> <domain-id>48</domain-id> </add> </ftp-user> </packet>

Supported Operations

500

This packet creates FTP account, with only required settings specified, on domain doe.org. The FTP account created with this packet will have name and login ftpuser2 and password GeNehvs570. User of this account will have access to the directory /httpdocs/Pub which does not exist on the domain and which will be created with this request packet. Total size of files that this FTP user is allowed to upload will be limited to default values defined by domain or domain owner limits.
<packet version="1.4.2.0"> <ftp-user> <add> <name>ftpuser2</name> <password>GeNehvs570</password> <home>/httpdocs/Pub</home> <create-non-existent>true</create-non-existent> <domain-name>doe.org</domain-name> </add> </ftp-user> </packet>

This request packet is incorrect because while creating FTP account it is trying to create the account home directory in domain root folder, and changing the structure of domain root is not allowed by Plesk.
<packet version="1.4.2.0"> <ftp-user> <add> <name>dwarf</name> <password>Kjrnc7HHsn</password> <home>/dwarfyplace</home> <create-non-existent>true</create-non-existent> <domain-name>reddwarf.net</domain-name> </add> </ftp-user> </packet>

This packet creates FTP account, with the full set of settings specified, on domain with ID 50. The account created with this packet will have name and login ftpuser3 and password lkAshr66v. User of this account will have read and write permissions on accessing directory Incoming located in domain folder/httpdocs. Total size of files that this FTP user is allowed to upload will not be limited.
<packet version="1.4.2.0"> <ftp-user> <add> <name>ftpuser3</name> <password>lkAshr66v</password> <home>/httpdocs/Incoming</home> <quota>-1</quota> <permissions> <read>true</read> <write>true</write> </permissions> <domain-id>50</domain-id> </add> </ftp-user> </packet>

Supported Operations

501

Creating multiple FTP accounts This packet creates three FTP accounts on domain example.com. Two of these accounts will have read and write permissions on accessing directory Incoming located in folder /private/photoshare which does not exist on the domain and which will be created with this request packet. The third user created with the packet will have only read permission on accessing the same directory. Total size of files that the FTP users are allowed to upload will be limited to 100 Mbytes.
<packet version="1.4.2.0"> <ftp-user> <add> <name>photo1</name> <password>dkfje44Fwen</password> <home>/private/photoshare/Incoming</home> <create-non-existent>true</create-non-existent> <quota>104857600</quota> <permissions> <read>true</read> <write>true</write> </permissions> <domain-name>example.com</domain-name> </add> <add> <name>photo2</name> <password>jrtd30fH33</password> <home>/private/photoshare/Incoming</home> <quota>104857600</quota> <permissions> <read>true</read> <write>true</write> </permissions> <domain-name>example.com</domain-name> </add> <add> <name>photo3</name> <password>J7chhend</password> <home>/private/photoshare/Incoming</home> <permissions> <read>true</read> <write>false</write> </permissions> <domain-name>example.com</domain-name> </add> </ftp-user> </packet>

Supported Operations

502

Response Packet Structure


The add node of the output XML packet is structured as follows:

The result node is required. It wraps the response received from the server. Data type: FtpUserSimpleResultType (ftpuser.xsd). The status node is required. Specifies the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the add operation fails. Data type: unsignedInt. The errtext node is optional. Is used to return the error message if the add operation fails. Data type: string. The id node is required if the operation succeeds. It returns the unique identifier of the FTP account created with the add operation. Data type: integer.

Response Samples
Positive responses This packet is received after successful creation of FTP account to which ID 5 was assigned.
<packet version="1.4.2.0"> <ftp-user> <add> <result> <status>ok</status> <id>5</id> </result> </add> </ftp-user> </packet>

Supported Operations

503

This packet is received after successful creation of three FTP accounts, to which IDs 7, 8 and 9 were assigned.
<packet version="1.4.2.0"> <ftp-user> <add> <result> <status>ok</status> <id>7</id> </result> </add> <add> <result> <status>ok</status> <id>8</id> </result> </add> <add> <result> <status>ok</status> <id>9</id> </result> </add> </ftp-user> </packet>

Negative responses Response packet with such error is received from server if the request packet creating an account tried to create an account home directory in the root domain folder, which is prohibited by Plesk.
<packet version="1.4.2.0"> <ftp-user> <add> <result> <status>error</status> <errcode>1006</errcode> <errtext>Unable to create directory /Upload: Access denied</errtext> </result> </add> </ftp-user> </packet>

You will receive such response if the home node in request packet contains path to folder which does not exist on a domain, and no create-non-existent node is included to the request.
<packet version="1.4.2.0"> <ftp-user> <add> <result> <status>error</status> <errcode>1019</errcode> <errtext>Invalid path specified</errtext> </result> </add> </ftp-user> </packet>

Supported Operations

504

Such response is received if the request packet tries to create FTP account on a domain where the maximum allowed number of FTP accounts already exists.
<packet version="1.4.2.0"> <ftp-user> <add> <result> <status>error</status> <errcode>1024</errcode> <errtext>FTP subaccounts limit is reached for this domain</errtext> </result> </add> </ftp-user> </packet>

Retrieving Information On FTP Accounts


The get operation is used to retrieve the following FTP account settings: Name/ login Home directory Quota on using disk space Permissions for home directory ID of the domain on which FTP account exists

You can retrieve information on several FTP accounts in a single get operation by defining the filtering rule. Use the blank filter (<filter/>) parameter to get information about all FTP accounts on all domains for the user identified by credentials from HTTP header.

Request Packet Structure


A request XML packet retrieving information on FTP account settings includes the get operation node:
<packet version=1.4.2.0> <ftp-user> <get> </get> </ftp-user> </packet>

Supported Operations

505

The get node is presented by the FtpUserGetInputType complex type (ftpuser.xsd). The node has the following graphical representation:

The filter node is required. It indicates FTP accounts which settings are to be retrieved with the request packet. Data type: FtpUserFilterType (ftpuser.xsd). For information on this node structure, refer to Filtering Issues (see page 494).

Remarks Within one get operation you can retrieve information on FTP accounts using only one filtering rule: account IDs, account names, domain IDs, or domain names. However, you can always use several different filtering rules within one packet by including to it several get nodes.

Request Samples
Retrieving information on a single FTP account This packet retrieves information on FTP account with ID 16.
<packet version="1.4.2.0"> <ftp-user> <get> <filter> <id>16</id> </filter> </get> </ftp-user> </packet>

This packet retrieves information on FTP account with name ftpuser1.


<packet version="1.4.2.0"> <ftp-user> <get> <filter> <name>ftpuser1</name> </filter> </get> </ftp-user> </packet>

Supported Operations

506

Retrieving information on multiple FTP accounts This request packet is incorrect as both id and name nodes are nested in one filter node within one get operation.
<packet version=1.4.2.0> <ftp-user> <get> <filter> <name>some-ftp</name> <id>34</id> </filter> </get> </ftp-user> </packet>

This packet retrieves information on FTP accounts with names photo1 and photo3, and on all FTP accounts existing on domain with ID 34.
<packet version=1.4.2.0> <ftp-user> <get> <filter> <name>photo1</name> <name>photo3</name> </filter> </get> <get> <filter> <domain-id>34</domain-id> </filter> </get> </ftp-user> </packet>

This packet retrieves information on all FTP accounts existing on domains called one.example.com and two.example.com.
<packet version=1.4.2.0> <ftp-user> <get> <filter> <domain-name>one.example.com</domain-name> <domain-name>two.example.com</domain-name> </filter> </get> </ftp-user> </packet>

Supported Operations

507

This packet retrieves information on all FTP accounts existing on all domains created in Plesk if it is sent with Plesk Administrator credentials in the packet HTTP headers, or on all domains belonging to a Plesk Client whose credentials are specified in the HTTP headers.
<packet version="1.4.2.0"> <ftp-user> <get> <filter/> </get> </ftp-user> </packet>

Response Packet Structure


The get node of the output XML packet is structured as follows:

Supported Operations

508

The result node is required. It wraps the response received from the server. Data type: FtpUserGetResultType (ftpuser.xsd). The status node is required. It specifies the execution status of the get operation. Data type: result_status. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the get operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the get operation fails. Data type: string. The filter-id node is optional. It is required if the get operation succeeds. It returns the filtering rule. For more information, refer to the Filtering Issues (see page 497) section. Data type: anySimple. The id node is optional. It is required if the get operation succeeds. It returns the unique identifier of the FTP account which settings are retrieved in the response packet. Data type: integer. The name node is optional. It is required if the get operation succeeds. It specifies the name under which the FTP account is known in Plesk, and the account login. Data type: string. The home node is optional. It is required if the get operation succeeds. It specifies the home directory of the FTP account, i.e., the directory access to which is granted for the account user. Data type: string. The quota node is is optional. It is required if the get operation succeeds. It specifies the maximum total size of files and folders (in bytes) that the FTP account user can create in or upload to the home directory. Data type: integer. The permissions node is optional. It is required if the get operation succeeds. It specifies the FTP account permissions for home directory. For more information, refer to section FTP Account Permissions (see page 493). Data type: FtpUserPermissions. The domain-id node is optional. It is required if the get operation succeeds. It specifies the ID of the domain on which the FTP account exists. Data type: integer.

Remarks In case when a domain was specified as filtering rule in a request packet, and there are no FTP accounts existing on that domain, response packet does not contain the name, home, quota, permissions and domain-id nodes.

Supported Operations

509

Response Samples
Positive responses This packet retrieved information on FTP account created with default home directory and only required settings specified within the node. For details on adding accounts, refer to the Creating FTP Accounts (see page 497) section.
<packet version="1.4.2.0"> <ftp-user> <get> <result> <status>ok</status> <filter-id>16</filter-id> <id>16</id> <name>jenny</name> <home></home> <quota>-1</quota> <permissions> <read>false</read> <write>false</write> </permissions> <domain-id>1</domain-id> </result> </get> </ftp-user> </packet>

This packet retrieved information on two FTP accounts filtered by names, and information on FTP accounts existing on a domain with ID 34. The last get node in this response contains only status and filter-id nodes, which means that no FTP accounts exist on the specified domain.
<packet version="1.4.2.0"> <ftp-user> <get> <result> <status>ok</status> <filter-id>photo1</filter-id> <id>7</id> <name>photo1</name> <home>/private/photoshare/Incoming</home> <quota>104857600</quota> <permissions> <read>true</read> <write>true</write> </permissions> <domain-id>2</domain-id> </result> <result> <status>ok</status> <filter-id>photo3</filter-id> <id>9</id> <name>photo3</name> <home>/private/photoshare/Incoming</home> <quota>0</quota> <permissions>

Supported Operations <read>true</read> <write>false</write> </permissions> <domain-id>2</domain-id> </result> </get> <get> <result> <status>ok</status> <filter-id>34</filter-id> </result> </get> </ftp-user> </packet>

510

Negative Responses This packet returned error because the request packet sent to the server intended to retrieve information on FTP account with ID 88 which does not exist.
<packet version="1.4.2.0"> <ftp-user> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>ftp-user does not exist</errtext> <filter-id>88</filter-id> <id>88</id> </result> </get> </ftp-user> </packet>

This packet returned error because the request packet sent to server by Plesk Client intended to retrieve information on FTP account which exists on a domain belonging to another Plesk Client.
<packet version="1.4.2.0"> <ftp-user> <get> <result> <status>error</status> <errcode>1006</errcode> <errtext>Permission denied.</errtext> <filter-id>ivanov.ru</filter-id> </result> </get> </ftp-user> </packet>

Supported Operations

511

Changing FTP Account Settings


The set operation is used to change settings of additional FTP accounts existing in Plesk database. You can change settings of particular FTP accounts, or of all FTP accounts existing on particular domains or in the whole Plesk database, depending on what Plesk user credentials are specified in HTML headers of request packet. Note: Plesk Clients can change quota on disk space used by home directory only if they are granted the Hard disk quota assignment permission (see page 38).

Request Packet Structure


A request XML packet changing FTP account settings in the Plesk's database includes the set operation node:
<packet version="1.4.2.0"> <ftp-user> <set> ... </set> </ftp-user> </packet>

The set node is presented with the FtpUserSetInputType complex type (ftpuser.xsd), its graphical representation is as follows:

The filter node is required. It indicates FTP accounts which settings are to be updated with the information specified in values node. Data type: FtpUserFilterType (ftpuser.xsd). For information on this node structure, refer to Filtering Issues (see page 494).

Supported Operations

512

The values node is required. It wraps a collection of settings that will be applied to the accounts specified with filter node. Data type: FtpUserSetType (ftpuser.xsd). The name node is optional. It specifies the new name under which the FTP account will be known in Plesk, and the new account login. Data type: string. The password node is optional. It specifies the new FTP account password. Data type: string. The home node is optional. It specifies the new home directory of the account, i.e., the directory access to which is granted for the account user. Data type: string. The create-non-existent node is optional. It specifies if the new home directory should be created or not. This node with value true is required if new home directory defined with the home node does not exist. Data type: boolean. The quota node is optional. It specifies the maximum total size of files and folders (in bytes) that the FTP account user can create in or upload to the home directory. Data type: integer. The permissions node is optional. It specifies the FTP account permissions for home directory. For more information, refer to section FTP Account Permissions (see page 493). Data type: FtpUserPermissions.

Remarks 1. The home node should contain a full path to FTP account home directory starting with root domain directory. For example: /httpdocs/billy/pub. If the home node is left blank (<home/>), then home directory for FTP account will be set to default one, which is the domain root directory. 2. Creating new folders in domain root directory is prohibited by Plesk. Therefore, it is impossible to make some /Global_Upload folder a home directory for an account. Do not include to your packets lines like
<home>/Global_Upload</home> <create-non-existent>true</create-non-existent>

3. To change FTP account quota to unlimited, specify value "-1" in the quota node:
<quota>-1</quota>

4. With one packet, you can change settings of as many different FTP accounts with different filtering rules as you want. To do so, use the required number of add nodes in the packet.

Supported Operations

513

Request Samples
Changing settings of a single FTP account This packet sets up new password for FTP account with name "ftpuser2".
<packet version="1.4.2.0"> <ftp-user> <set> <filter> <name>ftpuser2</name> </filter> <values> <password>jkRR67hVBB</password> </values> </set> </ftp-user> </packet>

This packet updates settings of FTP account with ID 46: It creates new account home directory /httpdocs/Pub and allows read and write permissions.
<packet version="1.4.2.0"> <ftp-user> <set> <filter> <id>46</id> </filter> <values> <home>/httpdocs/Pub</home> <create-non-existent>true</create-non-existent> <permissions> <read>true</read> <write>true</write> </permissions> </values> </set> </ftp-user> </packet>

Changing settings of multiple FTP accounts This packet is incorrect as it intends to give the same new name to all FTP accounts existing on domain with ID 85.
<packet version="1.4.2.0"> <ftp-user> <set> <filter> <domain-id>85</domain-id> </filter> <values> <name>ftp-doe1</name> </values> </set> </ftp-user></packet>

Supported Operations

514

This packet sets 10-Mbytes quota for all FTP accounts existing on domain example.com.

<packet version="1.4.2.0"> <ftp-user> <set> <filter> <domain-name>example.com</domain-name> </filter> <values> <quota>10485760</quota> </values> </set> </ftp-user> </packet>

This packet allows read access and denies write access to all FTP accounts that can be managed by Plesk user defined in HTTP headers of the packet.

<packet version="1.4.2.0"> <ftp-user> <set> <filter/> <values> <permissions> <read>true</read> <write>false</write> </permissions> </values> </set> </ftp-user> </packet>

Supported Operations

515

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It wraps the response received from the server. Data type: resultFilterType (ftpuser.xsd). The status node is required. Specifies the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is used to return the error code when the set operation fails. Data type: unsignedInt. The errtext node is optional. Is used to return the error message if the set operation fails. Data type: string. The filter-id node is optional. It returns the filtering rule. For more information, refer to the Filtering Issues (see page 497) section. The id node is required if the operation succeeds. It returns the unique identifier of the FTP account which settings were modified with add operation in request packet. Data type: integer.

Supported Operations

516

Response Samples
Positive responses This packet has been received after successful changing settings of FTP account called ftpuser2.
<packet version="1.4.2.0"> <ftp-user> <set> <result> <status>ok</status> <filter-id>ftpuser2</filter-id> <id>6</id> </result> </set> </ftp-user> </packet>

This packet has been received after successful changing settings of FTP accounts existing on domain example.com.
<packet version="1.4.2.0"> <ftp-user> <set> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>16</id> </result> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>25</id> </result> </set> </ftp-user> </packet>

Negative responses Packet with such error is received if the request packet intended to change settings of FTP account which does not exist in Plesk.
<packet version="1.4.2.0"> <ftp-user> <set> <result> <status>error</status> <errcode>1013</errcode> <errtext>ftp-user does not exist</errtext> <filter-id>666</filter-id> <id>666</id> </result> </set> </ftp-user></packet>

Supported Operations

517

Such packet is received if the request packet intended to set the same new name for all FTP accounts existing on one domain. The first result node contains info on successful renaming of FTP account with ID 316, the following result nodes contain the same error 1007.
<packet version="1.4.2.0"> <ftp-user> <set> <result> <status>ok</status> <filter-id>87</filter-id> <id>316</id> </result> <result> <status>error</status> <errcode>1007</errcode> <errtext>User ftp-doe7 already exists.</errtext> <filter-id>87</filter-id> <id>317</id> </result> <result> <status>error</status> <errcode>1007</errcode> <errtext>User ftp-doe7 already exists.</errtext> <filter-id>87</filter-id> <id>318</id> </result> </set> </ftp-user> </packet>

Deleting FTP Accounts


Use the del operation to remove FTP accounts from Plesk database. You can use this operation for deleting particular FTP accounts defined by name or ID, for deleting all FTP accounts existing on particular domains, also defined by name or ID, or for deleting all FTP accounts existing on all domains you can manage. In the last case, Plesk Administrator deletes all additional FTP accounts created on the whole Plesk server, Plesk Client, in turn, deletes all additional FTP accounts created on his domains.

Request Packet Structure


A request XML packet deleting FTP account includes the del operation node:
<packet version=1.4.2.0> <ftp-user> <del> </del> </ftp-user> </packet>

Supported Operations

518

The del node is presented by the FtpUserDelInputType complex type (ftpuser.xsd). The node has the following graphical representation:

The filter node is required. It indicates which FTP accounts are to be deleted with the request packet. Data type: FtpUserFilterType (ftpuser.xsd). For information on this node structure, refer to Filtering Issues (see page 494).

Remarks With one packet, you can delete as many different FTP accounts with different filtering rules as you want. To do so, use the required number of del nodes in the packet.

Request Samples
Deleting single FTP account This packet deletes FTP account with name photo4.
<packet version="1.4.2.0"> <ftp-user> <del> <filter> <name>photo4</name> </filter> </del> </ftp-user> </packet>

This packet deletes FTP account with ID 44.


<packet version="1.4.2.0"> <ftp-user> <del> <filter> <id>44</id> </filter> </del> </ftp-user> </packet>

Supported Operations

519

Deleting multiple FTP accounts

This packet deletes FTP accounts with names ftpuser2, photo6.

<packet version="1.4.2.0"> <ftp-user> <del> <filter> <name>ftpuser2</name> <name>photo6</name> </filter> </del> </ftp-user> </packet>

This packet deletes all FTP accounts existing on domain example.com.

<packet version="1.4.2.0"> <ftp-user> <del> <filter> <domain-name>example.com</domain-name> </filter> </del> </ftp-user> </packet>

This packet removes all FTP accounts that can be managed by Plesk user defined in HTTP headers of the packet.

<packet version="1.4.2.0"> <ftp-user> <del> <filter/> </del> </ftp-user> </packet>

Supported Operations

520

Response Packet Structure


The del node of the output XML packet is structured as follows:

The result node is required. It wraps the response received from the server. Data type: FtpUserGetResultType (ftpuser.xsd). The status node is required. It specifies the execution status of the del operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It is used to return the error code when the del operation fails. Data type: unsignedInt. The errtext node is optional. It is used to return the error message if the del operation fails. Data type: string. The filter-id node is optional. It returns the filtering rule. For more information, refer to the Filtering Issues (see page 497) section. Data type: anySimple. The id node is optional. It returns the unique identifier of the FTP account that has been deleted with the request packet. Data type: integer.

Supported Operations

521

Response Samples
Positive responses This packet has been received after successful deletion of FTP account called photo4, which had ID 15.
<packet version="1.4.2.0"> <ftp-user> <del> <result> <status>ok</status> <filter-id>photo4</filter-id> <id>15</id> </result> </del> </ftp-user> </packet>

This packet has been received after successful deletion of all FTP accounts that existed on domain doe3.com: These were FTP accounts with IDs 28 and 29.
<packet version="1.4.2.0"> <ftp-user> <del> <result> <status>ok</status> <filter-id>doe3.com</filter-id> <id>28</id> </result> <result> <status>ok</status> <filter-id>doe3.com</filter-id> <id>29</id> </result> </del> </ftp-user> </packet>

Such packet is received if the request packet intends to delete all FTP accounts from a domain where no FTP accounts exist. In this case it is domain example.com.
<packet version="1.4.2.0"> <ftp-user> <del> <result> <status>ok</status> <filter-id>example.com</filter-id> </result> </del> </ftp-user> </packet>

Supported Operations

522

Negative responses Negative response received from server can look as follows:
<packet version="1.4.2.0"> <ftp-user> <del> <result> <status>error</status> <errcode>1013</errcode> <errtext>ftp-user does not exist</errtext> <filter-id>photo4</filter-id> </result> </del> </ftp-user> </packet>

Managing IP Addresses
Operator: <ip> XML Schema: ip_input.xsd, ip_output.xsd Plesk version: all versions API RPC version: all versions Plesk user: Plesk Administrator Description The ip operator is used to manage IP addresses available on Plesk server. In Plesk, IP addresses can be shared or exclusive. Exclusive IP address can be assigned to a single customer, while shared IP address can be shared among several customer accounts. SSL protection with authentic digital certificates and Anonymous FTP services are available only to domains hosted on exclusive IP addresses. Supported operations

Supported Operations

523

ADD (see page 523) adds an IP address to Plesk server as shared or exclusive, specifying a netmask and server network interface) GET (see page 527) retrieves the list of IP addresses available on the server SET (see page 530) updates properties for IP addresses available on the server DEL (see page 533) removes an IP address from Plesk server

Adding IP Address
Use the add operation to add IP address to Plesk server. Note: In Plesk powered by Virtuozzo, if the specified IP is not in VPS (Virtual Private Server) pool, the attempt to add it to Plesk database will result in error.

Request Packet Structure


A request XML packet adding IP address to Plesk server includes the add operation node:
<packet version="1.4.2.0"> <ip> <add> </add> </ip> </packet>

Graphical representation of the add node is as follows:

The ip_address node is required. It specifies the IP address you want to add to Plesk database. Data type: ip_address (common.xsd). The netmask node is required. It specifies the netmask of the network. Data type: ip_address (common.xsd). The type node is required. It specifies the type of IP address. Data type: string. Allowed values: shared | exclusive. The interface node is required. It specifies the network interface name. Data type: string.

Supported Operations

524

Remarks You can add multiple IP addresses in a single packet. Add as many add operations as the number of IPs you want to add.
<ip> <add> </add> ... <add> </add> </ip>

Request Samples
Adding a single IP address This packet adds a single shared IP address to Plesk server.
<packet version ="1.4.2.0"> <ip> <add> <ip_address>192.0.2.18</ip_address> <netmask>255.255.255.0</netmask> <type>shared</type> <interface>Network Connection</interface> </add> </ip> </packet>

Adding multiple IP addresses This packet adds two exclusive IP addresses to Plesk server.
<packet version ="1.4.2.0"> <ip> <add> <ip_address>192.0.2.17</ip_address> <netmask>255.255.255.0</netmask> <type>exclusive</type> <interface>Network Connection</interface> </add> <add> <ip_address>192.0.2.18</ip_address> <netmask>255.255.255.0</netmask> <type>exclusive</type> <interface>Network Connection</interface> </add> </ip> </packet>

Supported Operations

525

Response Packet Structure


The add node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the add operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add operation fails. Data type: string. The id_address node is optional. If the add operation succeeds, it returns the IP address added to Plesk database. Data type: ip_address (common.xsd).

Response Samples
Adding a single IP address This request packet adds a single shared IP address to Plesk server.
<packet version ="1.4.2.0"> <ip> <add> <ip_address>192.0.2.18</ip_address> <netmask>255.255.255.0</netmask> <type>shared</type> <interface>Network Connection</interface> </add> </ip> </packet>

Supported Operations

526

The positive response from the server looks as follows:


<packet version ="1.4.2.0"> <ip> <add> <result> <status>ok</status> <ip_address>192.0.2.18</ip_address> </result> </add> </ip> </packet>

If the IP address is already in Plesk database, the response is as follows:


<packet version ="1.4.2.0"> <ip> <add> <result> <status>error</status> <errcode>1013</errcode> <errtext>IP address was already added on the server</errtext> </result> </add> </ip> </packet>

Adding multiple IP addresses This request packet adds two exclusive IP addresses to Plesk server.
<packet version ="1.4.2.0"> <ip> <add> <ip_address>192.0.2.17</ip_address> <netmask>255.255.255.0</netmask> <type>exclusive</type> <interface>Network Connection</interface> </add> <add> <ip_address>192.0.2.16</ip_address> <netmask>255.255.255.0</netmask> <type>exclusive</type> <interface>Network Connection</interface> </add> </ip> </packet>

Supported Operations

527

A possible response from the server can look as follows:


<packet version ="1.4.2.0"> <ip> <add> <result> <status>ok</status> <ip_address>192.0.2.17</ip_address> </result> </add> <add> <result> <status>ok</status> <ip_address>192.0.2.16</ip_address> </result> </add> </ip> </packet>

Retrieving IP addresses
Use the get operation to retrieve all IP addresses from Plesk server database.

Request Packet
A request XML packet retrieving IP addresses from Plesk database includes the get operation node:
<packet version="1.4.2.0"> <ip> <get/> </ip> </packet>

The get node graphical representation is as follows:

Request packet sample The packet retrieving IP addresses from Plesk database looks as follows:
<packet version="1.4.2.0"> <ip> <get/> </ip> </packet>

Supported Operations

528

Response Packet Structure


The get node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get operation fails. Data type: string. The addresses node is optional. If the get operation succeeds, it returns the following data:

The ip_info node is required. It wraps the IP address info. The ip_address node is required. Specifies the IP address in Plesk database. Data type: ip_address (common.xsd). The netmask node is required. It specifies the netmask of the network. Data type: ip_address (common.xsd). The type node is required. It specifies the type of IP address. Data type: string. Allowed values: shared | exclusive. The interface node is required. It specifies the server network interface name. Data type: string.

Supported Operations

529

The default node is optional. It specifies if the IP address is default for a domain. It specifies if any domain is shown when you type the IP address in browser. Data type: none.

Note: the default node is supported starting with API RPC protocol v.1.4.2.0. The ip_info node is supported starting with 1.3.5.1 version of the protocol. Use the ip node instead of ip_info node in previous versions of the protocol.

Response Samples

The request packet looks as follows:

<packet version="1.4.2.0"> <ip> <get/> </ip> </packet>

A response packet can look as follows:

<packet version="1.4.2.0"> <ip> <get> <result> <status>ok</status> <addresses> <ip_info> <ip_address>10.58.49.221</ip_address> <netmask>255.255.0.0</netmask> <type>exclusive</type> <interface>eth0</interface> </ip_info> </addresses> </result> </get> </ip> </packet>

Supported Operations

530

Changing Type
Use the set operation to change IP address type. Note: You cannot change type of IP address from shared to exclusive if it is assigned to two or more clients.

Request Packet Structure


A request XML packet changing the IP address type includes the set operation node:
<packet version="1.4.2.0"> <ip> <set> </set> </ip> </packet>

The set node graphical representation is as follows:

The filter node is required. Specifies the filtering rule. Data type: ipFilterType (ip_input.xsd) The ip_address node is required. Specifies the IP address in Plesk database. Data type: ip_address (common.xsd). The type node is required. It specifies the type of IP address. Data type: string. Allowed values: shared | exclusive.

Remarks You can change type of multiple IP addresses in a single packet. Add as many ip_address operations as the number of IP addresses, the type of which is to be changed.
<filter> <ip_address>...</ip_address> ... <ip_address>...</ip_address> </filter>

Supported Operations

531

Request Samples
Changing type of a single IP address This packet changes the type of 192.0.2.1 IP address to exclusive.
<packet version="1.4.2.0"> <ip> <set> <filter> <ip_address>192.0.2.1</ip_address> </filter> <type>exclusive</type> </set> </ip> </packet>

Changing type of multiple IP addresses This packet changes the type of 192.0.2.10 and 192.0.2.12 IP addresses to exclusive.
<packet version="1.4.2.0"> <ip> <set> <filter> <ip_address>192.0.2.10</ip_address> <ip_address>192.0.2.12</ip_address> </filter> <type>exclusive</type> </set> </ip> </packet>

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd).

Supported Operations

532

The status node is required. It specifies the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the set operation fails. Data type: integer. The errtext node is optional. It returns the error message if the set operation fails. Data type: string. The id_address node is optional. It returns the IP address which status is changed. Data type: ip_address (common.xsd).

Response Samples
Changing type of a single IP address This request packet changes the type of 192.0.2.1 IP address to exclusive.
<packet version="1.4.2.0"> <ip> <set> <filter> <ip_address>192.0.2.1</ip_address> </filter> <type>exclusive</type> </set> </ip> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <ip> <set> <result> <status>ok</status> <ip_address>192.0.2.1</ip_address> </result> </set> </ip> </packet>

If the IP was assigned to multiple customers, the response looks as follows:


<packet version="1.4.2.0"> <ip> <set> <result> <status>error</status> <errcode>1019</errcode> <errcode>General set IP error.</errcode> <ip_address>192.0.2.1</ip_address> </result> </set> </ip></packet>

Supported Operations

533

Changing type of multiple IP addresses

This packet changes the type of 192.0.2.10 and 192.0.2.12 IP addresses to exclusive.

<packet version="1.4.2.0"> <ip> <set> <filter> <ip_address>192.0.2.10</ip_address> <ip_address>192.0.2.12</ip_address> </filter> <type>exclusive</type> </set> </ip> </packet>

If the second IP address was not found, the response from the server looks as follows:

<packet version="1.4.2.0"> <ip> <set> <result> <status>ok</status> <ip_address>192.0.2.10</ip_address> </result> <result> <status>error</status> <errcode>1013</errcode> <errcode>ip does not exist.</errcode> <ip_address>192.0.2.12</ip_address> </result> </set> </ip> </packet>

Supported Operations

534

Removing IP
Use the del operation to remove the IP address from Plesk database. You cannot remove the IP of the computer (defined by network configuration), where Plesk server is located. You also cannot remove the IP address if one or more domains are hosted on this IP or forwarded from this IP.

Request Packet Structure


A request XML packet removing the IP address from Plesk database includes the del operation node:
<packet version="1.4.2.0"> <ip> <del> </del> </ip> </packet>

The del node graphical representation is as follows:

The filter node is required. Specifies the filtering rule. Data type: ipFilterType (ip_input.xsd). The ip_address node is required. Specifies the IP address in Plesk database. Data type: ip_address (common.xsd).

Remarks

You can remove multiple IP addresses in a single packet. Add as many ip_address operations as the number of IP addresses you want to remove.

<filter> <ip_address>...</ip_address> ... <ip_address>...</ip_address> </filter>

Supported Operations

535

Request Samples
Removing a single IP address This packet removers 192.0.2.1 IP address from Plesk database.
<packet version="1.4.2.0"> <ip> <del> <filter> <ip_address>192.0.2.1</ip_address> </filter> </del> </ip> </packet>

Removing multiple IP addresses This packet removes 192.0.2.10 and 192.0.2.12 IP addresses.
<packet version="1.4.2.0"> <ip> <del> <filter> <ip_address>192.0.2.10</ip_address> <ip_address>192.0.2.12</ip_address> </filter> </del> </ip> </packet>

Response Packet Structure


The set node of the output XML packet is structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultType (common.xsd). The status node is required. It specifies the execution status of the del operation. Data type: string. Allowed values: ok | error.

Supported Operations

536

The errcode node is optional. Is returns the error code if the del operation fails. Data type: integer. The errtext node is optional. It returns the error message if the del operation fails. Data type: string. The id_address node is optional. It returns the removed IP address. Data type: ip_address (common.xsd).

Response Samples
Removing a single IP address This request packet removers 192.0.2.1 IP address from Plesk database.
<packet version="1.4.2.0"> <ip> <del> <filter> <ip_address>192.0.2.1</ip_address> </filter> </del> </ip> </packet>

If it was Plesk server IP address, or this IP is used by hosting or forwarding services, the response from the server looks as follows:
<packet version="1.4.2.0"> <ip> <del> <result> <status>error</status> <errcode>1002</errcode> <errtext>Error: IP address 192.0.2.1 is used for hosting or forwarding. </errtext> </result> </del> </ip> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <ip> <del> <result> <status>ok</status> <ip_address>192.0.2.1</ip_address> </result> </del> </ip> </packet>

Supported Operations

537

Removing multiple IP addresses This request packet removes 192.0.2.1 and 192.0.2.2 IP addresses.
<packet version="1.4.2.0"> <ip> <del> <filter> <ip_address>192.0.2.1</ip_address> <ip_address>192.0.2.2</ip_address> </filter> </del> </ip> </packet>

A possible response from the server can look as follows:


<packet version="1.4.2.0"> <ip> <del> <result> <status>error</status> <errcode>1002</errcode> <errtext>Error: IP address 192.0.2.1 is used for hosting or forwarding. </errtext> </result> <result> <status>error</status> <errcode>1002</errcode> <errtext>Error: IP address 192.0.2.2 is used for hosting or forwarding. </errtext> </result> </del> </ip> </packet>

Supported Operations

538

Managing Locales
Operator: <locale> XML Schema: locale.xsd Plesk version: 8.1.1 API RPC version: 1.5.0.0 Plesk user: Plesk Administrator Description A subset of Plesk user's environment adjusted to a particular language is called locale. On the implementation level, a particular locale is represented by the corresponding language pack (LP). Language pack is an installable file containing resource files. The files are associative arrays structured like "key => value". The locale operator is used to manage LP's and to localize messages wrapped in object descriptors. For information on descriptors, refer to the Descriptors Overview section of the Programming Guide. Supported operations

GET (on page 540) retrieves info on LP's installed on Plesk server INSTALL (on page 545) installs a specified LP to Plesk server GET-MESSAGE (on page 547) retrieves the message specified by a key from resource files of LP REMOVE (on page 552) removes LP from the server ENABLE (on page 555) enables LP on the server DISABLE (on page 559) disables LP on the server

Supported Operations

539

LP Names
Plesk locale and language pack names follow the RFC 1766 standard in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lower-case two-letter code derived from ISO 639-1 and <country/regioncode2> is an upper-case two-letter code derived from ISO 3166. For example, U.S. English locale is named "enUS". To see list of locale names supported by Plesk, refer to the Appendix. Local Code. (on page 563) section.

Filtering Issues
Filtering is the way the request XML packet indicates the object (a web user or several) to which the operation will be applied. The request XML packet filters web user accounts using a special filter node. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.

Filter for Language Packs


The filter for this operator is presented by type LocaleFilterType (locale.xsd) and structured as follows:

The id node is optional. It specifies name of a LP. For details on LP names, refer to the LP Names (on page 539) section. Data type: string.

Remarks The filter node can be left blank (<filter/>). In this case all LP's on the server will be matched. A single filter can specify multiple LP names. The filter that matches the US English and Taiwan Chinese LP's looks as follows:
<filter> <id>en-US</id> <id>zh-TW</id> </filter>

Supported Operations

540

filter-id

If an operation in a request packet uses filters, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If LP name was set as a filter rule parameter, it is returned in the filter-id node of the response packet. It is done to trace the request parameters in case of error. Data type: anySimple.

Retrieving List of LP's


Use the get operation in the following cases: To retrieve list of language packs installed on the server To retrieve detailed info on each LP

Request Packet Structure


A request XML packet retrieving info on LP's includes the get operation node:
<packet version="1.5.0.0"> <locale> <get> </get> </locale> </packet>

The get node is presented by type LocaleGetInput (locale.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 539) section. Data type: LocaleFilter (locale.xsd).

Supported Operations

541

Request Samples
Retrieving info on a single LP

The following request packet retrieves info on US English LP:


<packet version="1.5.0.0"> <locale> <get> <filter> <id>en-US</id> </filter> </get> </locale> </packet>

Retrieving info on multiple LP's

The following request packet retrieves info on US English and Russian LP's:
<packet version="1.5.0.0"> <locale> <get> <filter> <id>en-US</id> <id>ru-RU</id> </filter> </get> </locale> </packet>

The following request packet retrieves info on all LP's installed on the server:
<packet version="1.5.0.0"> <locale> <get> <filter/> </get> </locale> </packet>

Supported Operations

542

Response Packet Structure


The get node of the output XML packet is presented by type LocaleGetOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the get operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the get operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter if the operation fails. For more information, refer to the Filtering Issues (on page 568) section. Data type:anySimpleType. The id node is optional.It holds name of the language pack matched by the filtering rule if the operation fails. Data type: string. The message node is optional.It does not return any value for this operation. Data type: string. The info node is optional. It specifies LP settings. Data type: LocaleInfo (locale.xsd). If the info node is present in the response packet, the following nodes are required:

Supported Operations

543

The id node specifies the LP name. for details on language pack names, refer to the LP Names (on page 539) section. Data type: string. The lang node specifies the LP language. Data type: string. The country node specifies countries where this language is native. Data type: string. The used node specifies the number of users at all levels that use this language in their interface. Data type: integer. The enabled node specifies if this LP is available for users. Data type: boolean.

Response Samples
Retrieving info on a single LP The following request packet retrieves info on US English LP:
<packet version="1.5.0.0"> <locale> <get> <filter> <id>en-US</id> </filter> </get> </locale> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <locale> <get> <result> <status>ok</status> <info> <id>en-US</id> <lang>ENGLISH</lang> <country>United States</country> <used>17</used> <enabled>true</enabled> </info> </result> </get></locale></packet>

Supported Operations

544

If the LP was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <locale> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>en-US</filter-id> <id>en-US</id> </result> </get> </locale> </packet>

Retrieving info on multiple LP's The following request packet retrieves info on US English and Russian LP's:
<packet version="1.5.0.0"> <locale> <get> <filter> <id>en-US</id> <id>ru-RU</id> </filter> </get> </locale> </packet>

If US English LP was found, and Russian LP was not found on the server, the response is as follows:
<packet version="1.5.0.0"> <locale> <get> <result> <status>ok</status> <info> <id>en-US</id> <lang>ENGLISH</lang> <country>United States</country> <used>17</used> <enabled>true</enabled> </info> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>ru-RU</filter-id> <id>ru-RU</id> </result> </get> </locale> </packet>

Supported Operations

545

Installing LP
The install operation is used to install a specified language pack to Plesk server. Note:This operation is unavailable in Plesk for Windows.

Request Packet Structure


A request XML packet installing LP includes the install operation node:
<packet version="1.5.0.0"> <locale> <install> </install> </locale> </packet>

The install node is presented by type LocaleInstallInput (locale.xsd), and its graphical representation is as follows:

The filename node is required. Specifies the LP package full name. This file should reside on the server. You can use the upload operator to upload files to the server. Data type: string.

Request Samples
The following request packet installs US English LP to the server:
<packet version="1.5.0.0"> <locale> <install> <filename>./tmp/en-RU.rpm</filename> </install> </locale> </packet>

Supported Operations

546

Response Packet Structure


The install node of the output XML packet is presented by type LocaleInstallOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the install operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the install operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the install operation fails. Data type: string.

Response Samples
The following request packet installs US English LP to the server:
<packet version="1.5.0.0"> <locale> <install> <filename>./tmp/en-RU.rpm</filename> </install> </locale> </packet>

The positive response from the server looks as follows:


<packet version="1.5.0.0"> <locale> <install> <result> <status>ok</status> </result> </install> </locale> </packet>

Supported Operations

547

If the file was not found on the server, the response from the server looks as follows:
<packet version="1.5.0.0"> <locale> <install> <result> <status>error</status> <errcode>1013</errcode> <errtext>File not found</errtext> </result> </install> </locale> </packet>

If the request packet was sent to Plesk for Windows server, the response is as follows:
<packet version="1.5.0.0"> <locale> <install> <result> <status>error</status> <errcode>1017</errcode> <errtext>Feature not supported by Plesk API-RPC</errtext> </result> </install> </locale> </packet>

Retrieving Localized Messages


Resource files of LP are associative arrays, structured like key => value. One key can be equal to different values depending on a locale name. For instance, hst_def__fp_admin_login key can be equal to "FrontPage Administrator's Login" in US English locale and to "Login administrateur FrontPage" in French locale. To retrieve a key value for a specified locale, use the get-message operation.

Request Packet Structure


A request XML packet retrieving localized messages includes the get-message operation node:
<packet version="1.5.0.0"> <get-message> <install> </install> </get-message> </packet>

Supported Operations

548

The get-message node is presented by type LocaleGetMessageInput (locale.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 539) section. Data type: LocaleGetMessageFilter (locale.xsd). The key node is required. It specifies the key name. Data type: string. The id node is required. It specifies the language pack name. For details, refer to the LP Names (on page 539) section. Data type: string.

Request Samples
Retrieving value for a single key The following request packet retrieves value for the hst_def__fp_admin_login key in US English locale:
<packet version="1.5.0.0"> <locale> <get-message> <filter> <key>hst_def__fp_admin_login</key> </filter> <id>en-US</id> </get-message> </locale> </packet>

Retrieving value for multiple keys The following request packet retrieves values for the hst_def__fp_admin_login and hst_def__fp_admin_passwd keys in French locale:
<packet version="1.5.0.0"> <locale> <get-message> <filter> <key>hst_def__fp_admin_login</key> <key>hst_def__fp_admin_passwd</key> </filter> <id>fr-FR</id> </get-message> </locale> </packet>

Supported Operations

549

The following request packet retrieves values for the hst_def__fp_admin_login and hst_def__fp_admin_passwd keys in French and US English locales:
<packet version="1.5.0.0"> <locale> <get-message> <filter> <key>hst_def__fp_admin_login</key> <key>hst_def__fp_admin_passwd</key> </filter> <id>fr-FR</id> </get-message> <get-message> <filter> <key>hst_def__fp_admin_login</key> <key>hst_def__fp_admin_passwd</key> </filter> <id>en-US</id> </get-message> </locale> </packet>

Response Packet Structure


The get-message node of the output XML packet is presented by type LocaleGetMessageOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd).

Supported Operations

550

The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type: anySimple. The id node is optional.It holds name of the language pack matched by the filtering rule. Data type: string. The message node is optional.It holds value of the key received from the request packet. Data type: string.

Response Samples
Retrieving value for a single key The following request packet retrieves value for the hst_def__fp_admin_login key in US English locale:
<packet version="1.5.0.0"> <locale> <get-message> <filter> <key>hst_def__fp_admin_login</key> </filter> <id>en-US</id> </get-message> </locale> </packet>

The positive response from the server looks as follows:


<packet version="1.5.0.0"> <locale> <get-message> <result> <status>ok</status> <filter-id>hst_def__fp_admin_login</filter-id> <id>en-US</id> <message>FrontPage Administrator's Login</message> </result> </get-message> </locale> </packet>

Supported Operations

551

If the key was not found, the response is as follows:


<packet version="1.5.0.0"> <locale> <get-message> <result> <status>error</status> <errcode>1013</errcode> <errtext>Key does not exist</errtext> <filter-id>hst_def__fp_admin_login</filter-id> <id>fr-FR</id> </result> </get-message> </locale> </packet>

Retrieving value for multiple keys The following request packet retrieves values for the hst_def__fp_admin_login and hst_def__fp_admin_passwd keys in French locale:
<packet version="1.5.0.0"> <locale> <get-message> <filter> <key>hst_def__fp_admin_login</key> <key>hst_def__fp_admin_passwd</key> </filter> <id>fr-FR</id> </get-message> </locale> </packet>

A possible response from the server can look as follows:


<packet version="1.5.0.0"> <locale> <get-message> <result> <status>ok</status> <filter-id>hst_def__fp_admin_login</filter-id> <id>en-US</id> <message>FrontPage Administrator's Login</message> </result> <result> <status>ok</status> <filter-id>hst_def__fp_admin_passwd</filter-id> <id>fr-FR</id> <message>Mot de passe administrateur de FrontPage</message> </result> </get-message> </locale> </packet>

Supported Operations

552

Removing LP
The remove operation is used to remove a specified language pack from the server. Note: You cannot remove the default language pack.

Request Packet Structure


A request XML packet removing LP's includes the remove operation node:
<packet version="1.5.0.0"> <locale> <remove> </remove> </locale> </packet>

The remove node is presented by type LocaleRemoveInput (locale.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 539) section. Data type: LocaleFilter (locale.xsd).

Request Samples
Removing a single LP The following request packet removes French LP:
<packet version="1.5.0.0"> <locale> <remove> <filter> <id>fr-FR</id> </filter> </remove> </locale> </packet>

Supported Operations

553

Removing multiple LP's The following request packet removes German and French LP's:
<packet version="1.5.0.0"> <locale> <remove> <filter> <id>de-DE</id> <id>fr-FR</id> </filter> </remove> </locale> </packet>

The following request packet removers all LP's installed on the server (except for enUS):
<packet version="1.5.0.0"> <locale> <remove> <filter/> </remove> </locale> </packet>

Response Packet Structure


The remove node of the output XML packet is presented by type LocaleRemoveOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.

Supported Operations

554

The errcode node is optional. It returns the error code if the operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type: anySimple. The id node is optional.It holds name of the language pack matched by the filtering rule. Data type: string.

Response Samples
Removing a single LP The following request packet removes French LP:
<packet version="1.5.0.0"> <locale> <remove> <filter> <id>fr-FR</id> </filter> </remove> </locale> </packet>

The positive response from the server looks as follows:


<packet version="1.5.0.0"> <locale> <remove> <result> <status>ok</status> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </remove> </locale> </packet>

If the LP was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <locale> <remove> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </remove> </locale></packet>

Supported Operations

555

Removing multiple LP's The following request packet removes US English and Russian LP's:
<packet version="1.5.0.0"> <locale> <get> <filter> <id>en-US</id> <id>ru-RU</id> </filter> </get> </locale> </packet>

A possible response from the server can look as follows:


<packet version="1.5.0.0"> <locale> <remove> <result> <status>error</status> <errcode>1023</errcode> <errtext>Unable to remove Plesk base locale</errtext> <filter-id>en-US</filter-id> <id>en-US</id> </result> <result> <status>ok</status> <filter-id>ru-RU</filter-id> <id>ru-RU</id> </result> </remove> </locale> </packet>

Enabling LP
The enable operation is used to enable LP on the server.

Request Packet Structure


A request XML packet enabling LP's includes the enable operation node:
<packet version="1.5.0.0"> <locale> <enable> </enable> </locale> </packet>

Supported Operations

556

The enable node is presented by type LocaleEnableInput (locale.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 539) section. Data type: LocaleFilter (locale.xsd).

Request Samples
Enabling a single LP The following request packet enables French LP:
<packet version="1.5.0.0"> <locale> <enable> <filter> <id>fr-FR</id> </filter> </enable> </locale> </packet>

Enabling multiple LP's The following request packet enables German and French LP's:
<packet version="1.5.0.0"> <locale> <enable> <filter> <id>de-DE</id> <id>fr-FR</id> </filter> </enable> </locale> </packet>

The following request packet enables all LP's installed on the server:
<packet version="1.5.0.0"> <locale> <enable> <filter/> </enable> </locale> </packet>

Supported Operations

557

Response Packet Structure


The enable node of the output XML packet is presented by type LocaleEnableOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type: anySimple. The id node is optional.It holds name of the language pack matched by the filtering rule. Data type: string.

Supported Operations

558

Response Samples
Enabling a single LP The following request packet enables French LP:
<packet version="1.5.0.0"> <locale> <enable> <filter> <id>fr-FR</id> </filter> </enable> </locale> </packet>

The positive response from the server looks as follows:


<packet version="1.5.0.0"> <locale> <enable> <result> <status>ok</status> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </enable> </locale> </packet>

If the LP was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <locale> <enable> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </enable> </locale> </packet>

Enabling multiple LP's The following request packet enables French and Russian LP's:
<packet version="1.5.0.0"> <locale> <enable> <filter> <id>fr-FR</id> <id>ru-RU</id> </filter> </enable> </locale> </packet>

Supported Operations

559

A possible response from the server can look as follows:


<packet version="1.5.0.0"> <locale> <enable> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>fr-FR</filter-id> <id>en-US</id> </result> <result> <status>ok</status> <filter-id>ru-RU</filter-id> <id>ru-RU</id> </result> </enable> </locale> </packet>

Disabling LP
The disable operation is used to enable LP on the server. Note: You cannot disable the default language pack.

Request Packet Structure


A request XML packet disabling LP's includes the disable operation node:
<packet version="1.5.0.0"> <locale> <disable> </disable> </locale> </packet>

The disable node is presented by type LocaleDisableInput (locale.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 539) section. Data type: LocaleFilter (locale.xsd).

Supported Operations

560

Request Samples
Disabling a single LP

The following request packet disables French LP:


<packet version="1.5.0.0"> <locale> <disable> <filter> <id>fr-FR</id> </filter> </disable> </locale> </packet>

Disabling multiple LP's

The following request packet disables German and French LP's:


<packet version="1.5.0.0"> <locale> <disable> <filter> <id>de-DE</id> <id>fr-FR</id> </filter> </disable> </locale> </packet>

The following request packet disables all LP's installed on the server:
<packet version="1.5.0.0"> <locale> <disable> <filter/> </disable> </locale> </packet>

Supported Operations

561

Response Packet Structure


The disable node of the output XML packet is presented by type LocaleDisableOutput (locale.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the operation fails. Data type: string. The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type: anySimple. The id node is optional.It holds name of the language pack matched by the filtering rule. Data type: string.

Supported Operations

562

Response Samples
Disabling a single LP The following request packet disables French LP:
<packet version="1.5.0.0"> <locale> <disable> <filter> <id>fr-FR</id> </filter> </disable> </locale> </packet>

The positive response from the server looks as follows:


<packet version="1.5.0.0"> <locale> <disable> <result> <status>ok</status> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </disable> </locale> </packet>

If the LP was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <locale> <disable> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>fr-FR</filter-id> <id>fr-FR</id> </result> </disable> </locale> </packet>

Disabling multiple LP's The following request packet disables French and Russian LP's:
<packet version="1.5.0.0"> <locale> <disable> <filter> <id>fr-FR</id> <id>ru-RU</id> </filter> </disable> </locale></packet>

Supported Operations

563

A possible response from the server can look as follows:


<packet version="1.5.0.0"> <locale> <disable> <result> <status>error</status> <errcode>1013</errcode> <errtext>Locale does not exist</errtext> <filter-id>fr-FR</filter-id> <id>en-US</id> </result> <result> <status>ok</status> <filter-id>ru-RU</filter-id> <id>ru-RU</id> </result> </disable> </locale> </packet>

Appendix. Locale Codes


Language Country/Region
Afrikaans Albanian Albanian - Albania Arabic Arabic - Algeria Arabic Bahrain Arabic Egypt Arabic Iraq Arabic Jordan Arabic Kuwait Arabic Lebanon Arabic Libya Arabic - Morocco Arabic - Oman Arabic - Qatar Arabic - Saudi Arabia Arabic - Syria Arabic - Tunisia Arabic - United Arab Emirates

Code
af sq sq-AL ar ar-DZ ar-BH ar-EG ar-IQ ar-JO ar-KW ar-LB ar-LY ar-MA ar-OM ar-QA ar-SA ar-SY ar-TN ar-AE

Language Country/Region
Icelandic Icelandic - Iceland Indonesian Indonesian - Indonesia Italian Italian - Italy Italian - Switzerland Japanese Japanese - Japan Kannada Kannada - India Kazakh Kazakh - Kazakhstan Korean Korean - Korea Kyrgyz Kyrgyz - Kyrgyzstan Latvian Latvian - Latvia Lithuanian

Code
is is-IS id id-ID it it-IT it-CH ja ja-JP kn kn-IN kk kk-KZ ko ko-KR ky ky-KG lv lv-LV lt

Afrikaans - South Africa af-ZA

Supported Operations

564

Language Country/Region
Arabic - Yemen Armenian Armenian - Armenia Azeri Azeri - Azerbaijan Basque Basque - Basque Belarusian Belarusian - Belarus Bulgarian Bulgarian - Bulgaria Catalan Catalan - Spain Chinese Chinese - Hong Kong SAR Chinese - Macao SAR Chinese - China (Simplified Chinese) Chinese - Singapore Chinese - Taiwan (Traditional Chinese) Croatian Croatian - Croatia Czech Czech - Czech Republic Danish Danish - Denmark

Code
ar-YE hy hy-AM az az-AZ eu eu-ES be be-BY bg bg-BG ca ca-ES zh zh-HK zh-MO zh-CN zh-SG zh-TW hr hr-HR cs cs-CZ da da-DK

Language Country/Region
Lithuanian - Lithuania Macedonian

Code
lt-LT mk

Macedonian - Former Yugoslav mk-MK Republic of Macedonia Malay Malay - Brunei Malay - Malaysia Marathi Marathi - India Mongolian Mongolian - Mongolia Norwegian Norwegian (Bokml) - Norway Norwegian (Nynorsk) - Norway Polish Polish - Poland Portuguese Portuguese - Brazil Portuguese - Portugal Punjabi Punjabi - India Romanian Romanian - Romania Russian Russian - Russia Sanskrit ms ms-BN ms-MY mr mr-IN mn mn-MN no nb-NO nn-NO pl pl-PL pt pt-BR pt-PT pa pa-IN ro ro-RO ru ru-RU sa

Supported Operations

565

Language Country/Region Dutch Dutch - Belgium Dutch - The Netherlands English English - Australia English - Belize English - Canada English - Caribbean English - Ireland English - Jamaica English - New Zealand English - Philippines English - South Africa English - Trinidad and Tobago English - United Kingdom English - Zimbabwe Estonian Estonian - Estonia Faroese Faroese - Faroe Islands Farsi Farsi - Iran Finnish Finnish - Finland French French - Belgium

Code nl nl-BE nl-NL en en-AU en-BZ en-CA en-CB en-IE en-JM en-NZ en-PH en-ZA en-TT en-GB

Language - Country/Region Sanskrit - India Serbian Serbian - Serbia Slovak Slovak - Slovakia Slovenian Slovenian - Slovenia Spanish Spanish - Argentina Spanish - Bolivia Spanish - Chile Spanish - Colombia Spanish - Costa Rica Spanish - Dominican Republic Spanish - Ecuador Spanish - El Salvador Spanish - Guatemala Spanish - Honduras Spanish - Mexico Spanish - Nicaragua Spanish - Panama Spanish - Paraguay Spanish - Peru Spanish - Puerto Rico Spanish - Spain Spanish - Uruguay Spanish - Venezuela

Code sa-IN sr sr-SP sk sk-SK sl sl-SI es es-AR es-BO es-CL es-CO es-CR es-DO es-EC es-SV es-GT es-HN es-MX es-NI es-PA es-PY es-PE es-PR es-ES es-UY es-VE

English - United States en-US en-ZW et et-EE fo fo-FO fa fa-IR fi fi-FI fr fr-BE

Supported Operations

566

French - Canada French - France French - Luxembourg French - Monaco French - Switzerland Galician Galician - Galician Georgian Georgian - Georgia German German - Austria German - Germany German - Luxembourg German - Switzerland Greek Greek - Greece Gujarati Gujarati - India Hebrew Hebrew - Israel Hindi Hindi - India Hungarian Hungarian - Hungary

fr-CA fr-FR fr-LU fr-MC fr-CH gl gl-ES ka ka-GE de de-AT de-DE de-LU de-CH el el-GR gu gu-IN he he-IL hi hi-IN hu hu-HU

Swahili Swahili - Kenya Swedish Swedish - Finland Swedish - Sweden Tamil Tamil - India Tatar Tatar - Russia Telugu Telugu - India Thai Thai - Thailand Turkish Turkish - Turkey Ukrainian Ukrainian - Ukraine Urdu Urdu - Pakistan Uzbek Uzbek - Uzbekistan Vietnamese Vietnamese - Vietnam

sw sw-KE sv sv-FI sv-SE ta ta-IN tt tt-RU te te-IN th th-TH tr tr-TR uk uk-UA ur ur-PK uz uz-UZ vi vi-VN

German - Liechtenstein de-LI

Supported Operations

567

Managing Log Rotation on Domain


Operator: <log-rotation> XML Schema: logrotation.xsd Plesk version: 8.1.1 API RPC version: 1.5.0.0 Plesk user: Plesk Administrator, Plesk client Description All connections to a domain and errors on the domain are registered in domain log files. These log files are analyzed by the statistical utilities running on the server. The log-rotation operator is used to manage raw and processed log files. In other words, logrotation represents Log Rotation service (Plesk control panel) functionality. Supported operations

SET (on page 570) changes Log Rotation settings. GET (on page 576) retrieves Log Rotation settings. ENABLE (on page 582) enables Log Rotation service on a domain DISABLE (on page 587) disables Log Rotation service on a domain GET-STATUS (on page 591) retrieves status of Log Rotation service

Supported Operations

568

Log Rotation Settings


The settings are defined by type LogRotationSettingsType (logrotation.xsd). The graphical representation of the type is as follows:

The log-rotation node is required. specifies log limits. On achieving a limit the log file is removed and new log file is started. Data type: LogRotationConditionType (logrotation.xsd) The log-bysize node is required. It specifies maximum size of a log file in bytes. Data type: integer. The log-bytime node is required. It specifies interval of logging. Data type: string. Allowed values: Daily | Weekly | Monthly

The log-max-num-files node is optional. It specifies how many processed by statistical utilities log files are stored on the server. Data type: integer. The log-compress node is optional. It specifies if log files are compressed. Data type: boolean. The log-email node is optional. It specifies e-mail address on which processed log files will be sent.

Filtering Issues
Filtering is the way the request XML packet indicates the object (a web user or several) to which the operation will be applied. The request XML packet filters web user accounts using a special <filter> node. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.

Supported Operations

569

Log Rotation Filter


The filter for this operator is presented by type logRotationFilterType (logrotation.xsd) and structured as follows:

The domain-id node is required. It specifies ID of a domain. Data type: integer. The client-id node is required. It specifies ID of a client. Data type: integer. The domain-name node is required. It specifies the domain name. Data type: string (UTF-8). The client-login node is required. It specifies the client login name. Data type: string.

Remarks The filter node can be left blank (<filter/>). In this case all domains available for user specified by login credentials will be matched. A single filter can specify multiple domains defined either by ID, name, client ID or client name in the second. For example, the filter that matches all domains of the clients with IDs 8,9, and 10 looks as follows:
<filter> <client-id>8</client-id> <client-id>9</client-id> <client-id>10</client-id> </filter>

Supported Operations

570

filter-id

If an operation in a request packet uses filters, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If one of the following values was set as a filter rule parameter, it is returned in the filter-id node of the response packet. Domain ID Domain name Client ID Client login name

It is done to trace request parameters in case of error. Data type: anySimple.

Changing Log Rotation Settings


The set operation is used to change settings of Log Rotation.

Request Packet Structure


A request XML packet changing Log Rotation settings includes the set operation node:
<packet version="1.5.0.0"> <log-rotation> <set> </set> </log-rotation> </packet>

The set node is presented by type LogRotationSetInput (logrotation.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 568) section. Data type: logRotationFilterType (logrotation.xsd). The settings node is required. It specifies Log Rotation settings. For details, refer to the Log Rotation Settings (on page 568) section. Data type: LogRotationSettingsType (logrotation.xsd).

Supported Operations

571

Remarks You can use different filtering rules in a single packet. Add as many set operations as the number of different filtering rules.
<packet version="1.5.0.0"> <log-rotation> <set> </set> ... <set> </set> </log-rotation> </packet>

Request Samples
Changing settings of a single domain The following request packet changes Log Rotation settings of domain example.com:
<packet version="1.5.0.0"> <log-rotation> <set> <filter> <domain-name>example.com</domain-name> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </set> </log-rotation> </packet>

Changing settings of multiple domains The following request packet changes Log Rotation settings of domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <set> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> </settings> </set> </log-rotation> </packet>

Supported Operations

572

The following request packet changes Log Rotation settings of domain example.com and the domain with ID 6:
<packet version="1.5.0.0"> <log-rotation> <set> <filter> <domain-id>6</domain-id> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </set> <set> <filter> <domain-name>example.com</domain-name> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </set> </log-rotation> </packet>

The following request packet changes Log Rotation settings of all domains available for a packet sender:
<packet version="1.5.0.0"> <log-rotation> <set> <filter/> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> </settings> </set> </log-rotation> </packet>

Supported Operations

573

Response Packet Structure


The set node of the output XML packet is presented by type LogRotationSetOutput (logrotation.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the set operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the set operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the set operation fails. Data type: string. The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type:anySimple. The id node is optional. If the set operation succeeds, it holds the ID of the domain matched by the filtering rule. Data type: integer.

Supported Operations

574

Response Samples
Changing settings of a single domain The following request packet changes Log Rotation settings of domain example.com:
<packet version="1.5.0.0"> <log-rotation> <set> <filter> <domain-name>example.com</domain-name> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </set> </log-rotation> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <log-rotation> <set> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>33</id> </result> </set> </log-rotation> </packet>

If the domain was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <set> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>example.com</filter-id> </result> </set> </log-rotation> </packet>

Supported Operations

575

If a packet sender has no rights ot manage physical hosting, the response looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1006</errcode> <errtext>Access denied</errtext> <filter-id>example.com</filter-id> </result> </get> </log-rotation> </packet>

If the domain is not hosted physically, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1034</errcode> <errtext>The domain is not hosted physically</errtext> <filter-id>example.com</filter-id> </result> </get> </log-rotation> </packet>

Changing settings of multiple domains The following request packet changes Log Rotation settings of domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <set> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> </settings> </set> </log-rotation> </packet>

Supported Operations

576

If the client with ID 5 was not found on the server and the client with ID 8 runs two domains (ID 17 and 29) the response from the server looks as follows:
<packet version="1.5.0.0"> <set> <log-rotation> <result> <status>error</status> <errcode>1015</errcode> <errtext>client does not exist</errtext> <filter-id>5</filter-id> </result> </set> <set> <result> <status>ok</status> <filter-id>8</filter-id> <id>17</id> </result> </set> <set> <result> <status>ok</status> <filter-id>8</filter-id> <id>29</id> </result> </set> </log-rotation> </packet>

Retrieving Log Rotation Settings


The get operation is used to change settings of Log Rotation.

Request Packet Structure


A request XML packet retrieving Log Rotation settings includes the get operation node:
<packet version="1.5.0.0"> <log-rotation> <get> </get> </log-rotation> </packet>

Supported Operations

577

The get node is presented by type LogRotationGetInput (logrotation.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 568) section. Data type: logRotationFilterType (logrotation.xsd).

Remarks You can use different filtering rules in a single packet. Add as many get operations as the number of different filtering rules.
<packet version="1.5.0.0"> <log-rotation> <get> </get> ... <get> </get> </log-rotation> </packet>

Request Samples
Retrieving settings of a single domain The following request packet retrieves Log Rotation settings of domain example.com:
<packet version="1.5.0.0"> <log-rotation> <get> <filter> <domain-name>example.com</domain-name> </filter> </get> </log-rotation> </packet>

Supported Operations

578

Retrieving settings of multiple domains

The following request packet retrieves Log Rotation settings of domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <get> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </get> </log-rotation> </packet>

The following request packet retrieves Log Rotation settings of domain example.com and the domain with ID 6:
<packet version="1.5.0.0"> <log-rotation> <get> <filter> <domain-id>6</domain-id> </filter> </get> <get> <filter> <domain-name>example.com</domain-name> </filter> </get> </log-rotation> </packet>

The following request packet retrieves Log Rotation settings of all domains available for packet sender:
<packet version="1.5.0.0"> <log-rotation> <get> <filter/> </get> </log-rotation> </packet>

Supported Operations

579

Response Packet Structure


The get node of the output XML packet is presented by type LogRotationGetOutput (logrotation.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the get operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the get operation fails. Data type: string. The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type:anySimple. The id node is optional. If the get operation succeeds, it holds the ID of the domain matched by the filtering rule. Data type: integer. The settings node is optional. It specifies Log Rotation settings. For details, refer to the Log Rotation Settings (on page 568) section. Data type: LogRotationSettingsType (logrotation.xsd).

Supported Operations

580

Response Samples
Retrieving settings of a single domain The following request packet retrieves Log Rotation settings of domain example.com:
<packet version="1.5.0.0"> <log-rotation> <get> <filter> <domain-name>example.com</domain-name> </filter> </get> </log-rotation> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <log-rotation> <get> <result> <filter-id>example.com</filter-id> <id>33</id> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </result> </get> </log-rotation> </packet>

If the domain was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>example.com</filter-id> </result> </get> </log-rotation> </packet>

Supported Operations

581

If a packet sender has no rights ot manage physical hosting, the response looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1006</errcode> <errtext>Access denied</errtext> <filter-id>example.com</filter-id> </result> </get> </log-rotation> </packet>

If the domain is not hosted physically, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1034</errcode> <errtext>The domain is not hosted physically</errtext> <filter-id>example.com</filter-id> </result> </get> </log-rotation> </packet>

Retrieving settings of multiple domains The following request packet retrieves Log Rotation settings of domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <get> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </get> </log-rotation> </packet>

If the client with ID 5 was not found on the server and the client with ID 8 runs two domains (ID 17 and 29) the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get> <result> <status>error</status> <errcode>1015</errcode> <errtext>client does not exist</errtext> <filter-id>5</filter-id> </result> </get> <get> <result>

Supported Operations <status>ok</status> <filter-id>8</filter-id> <id>17</id> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </result> </get> <get> <result> <status>ok</status> <filter-id>8</filter-id> <id>29</id> <settings> <log-condition> <log-bysize>2073741824</log-bysize> </log-condition> <log-max-num-files>1</log-max-num-files> <log-compress>true</log-compress> </settings> </result> </get> </log-rotation> </packet>

582

Enabling Log Rotation Service


Use the enable operation to enable Log Rotation service on domains.

Request Packet Structure


A request XML packet enabling Log Rotation service includes the enable operation node:
<packet version="1.5.0.0"> <log-rotation> <enable> </enable> </log-rotation> </packet>

Supported Operations

583

The enable node is presented by type LogRotationEnableInput (logrotation.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 568) section. Data type: logRotationFilterType (logrotation.xsd).

Remarks You can use different filtering rules in a single packet. Add as many enable operations as the number of different filtering rules.
<packet version="1.5.0.0"> <log-rotation> <enable> </enable> ... <enable> </enable> </log-rotation> </packet>

Request Samples
Enabling Log Rotation service on a single domain The following request packet enables Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter> <domain-name>example.com</domain-name> </filter> </enable> </log-rotation> </packet>

Enabling Log Rotation service on multiple domain The following request packet enabes Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter>

Supported Operations </enable> </log-rotation> </packet>

584

The following request packet enables Log Rotation service on domain example.com and the domain with ID 6:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter> <domain-id>6</domain-id> </filter> </enable> <enable> <filter> <domain-name>example.com</domain-name> </filter> </enable> </log-rotation> </packet>

The following request packet enables Log Rotation service on all domains available for packet sender:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter/> </enable> </log-rotation> </packet>

Response Packet Structure


The enable node of the output XML packet is presented by type LogRotationEnableOutput (logrotation.xsd) and structured as follows:

Supported Operations

585

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the enable operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the enable operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the enable operation fails. Data type: string. The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type:anySimple. The id node is optional. If the enable operation succeeds, it holds the ID of the domain matched by the filtering rule. Data type: integer.

Response Samples
Enabling Log Rotation service on a single domain The following request packet enables Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter> <domain-name>example.com</domain-name> </filter> </enable> </log-rotation> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <log-rotation> <enable> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>33</id> </result> </enable> </log-rotation> </packet>

If the domain was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <enable> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>example.com</filter-id> </result> </enable> </log-rotation> </packet>

Supported Operations

586

Enabling Log Rotation service on multiple domains The following request packet enables Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <enable> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </enable> </log-rotation> </packet>

If the client with ID 5 was not found on the server and the client with ID 8 runs two domains (ID 17 and 29) the response from the server looks as follows:
<packet version="1.5.0.0"> <enable> <log-rotation> <result> <status>error</status> <errcode>1015</errcode> <errtext>client does not exist</errtext> <filter-id>5</filter-id> </result> </enable> <enable> <result> <status>ok</status> <filter-id>8</filter-id> <id>17</id> </result> </enable> <enable> <result> <status>ok</status> <filter-id>8</filter-id> <id>29</id> </result> </enable> </log-rotation> </packet>

Supported Operations

587

Disabling Log Rotation Service


Use the disable operation to disable Log Rotation service on domains.

Request Packet Structure


A request XML packet disabling Log Rotation service includes the disable operation node:
<packet version="1.5.0.0"> <log-rotation> <disable> </disable> </log-rotation> </packet>

The disable node is presented by type LogRotationDisableInput (logrotation.xsd), and its graphical representation is as follows:

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 568) section. Data type: logRotationFilterType (logrotation.xsd).

Remarks You can use different filtering rules in a single packet. Add as many disable operations as the number of different filtering rules.
<packet version="1.5.0.0"> <log-rotation> <disable> </disable> ... <disable> </disable> </log-rotation> </packet>

Supported Operations

588

Request Samples
Disabling Log Rotation service on a single domain The following request packet disables Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter> <domain-name>example.com</domain-name> </filter> </disable> </log-rotation> </packet>

Disabling Log Rotation service on multiple domain The following request packet disables Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </disable> </log-rotation> </packet>

The following request packet disables Log Rotation service on domain example.com and the domain with ID 6:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter> <domain-id>6</domain-id> </filter> </disable> <disable> <filter> <domain-name>example.com</domain-name> </filter> </disable> </log-rotation> </packet>

The following request packet disables Log Rotation service on all domains available for packet sender:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter/> </disable> </log-rotation> </packet>

Supported Operations

589

Response Packet Structure


The disable node of the output XML packet is presented by type LogRotationDisableOutput (logrotation.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the disable operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the disable operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the disable operation fails. Data type: string. The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type: anySimple. The id node is optional. If the disable operation succeeds, it holds the ID of the domain matched by the filtering rule. Data type: integer.

Supported Operations

590

Response Samples
Disabling Log Rotation service on a single domain The following request packet disables Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter> <domain-name>example.com</domain-name> </filter> </disable> </log-rotation> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <log-rotation> <disable> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>33</id> </result> </disable> </log-rotation> </packet>

If the domain was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <disable> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>example.com</filter-id> </result> </disable> </log-rotation> </packet>

Disabling Log Rotation service on multiple domains The following request packet disables Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <disable> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </disable> </log-rotation> </packet>

Supported Operations

591

If the client with ID 5 was not found on the server and the client with ID 8 runs two domains (ID 17 and 29) the response from the server looks as follows:
<packet version="1.5.0.0"> <disable> <log-rotation> <result> <status>error</status> <errcode>1015</errcode> <errtext>client does not exist</errtext> <filter-id>5</filter-id> </result> </disable> <disable> <result> <status>ok</status> <filter-id>8</filter-id> <id>17</id> </result> </disable> <disable> <result> <status>ok</status> <filter-id>8</filter-id> <id>29</id> </result> </disable> </log-rotation> </packet>

Checking Status of Log Rotation Service


Use the get-status operation to retrieve status of Log Rotation service on domains.

Request Packet Structure


A request XML packet retrieving status of Log Rotation service includes the get-status operation node:
<packet version="1.5.0.0"> <log-rotation> <get-status> </get-status> </log-rotation> </packet>

The get-status node is presented by type LogRotationDisableInput (logrotation.xsd), and its graphical representation is as follows:

Supported Operations

592

The filter node is required. Specifies the filtering rule. For more information, refer to the Filtering Issues (on page 568) section. Data type: logRotationFilterType (logrotation.xsd).

Remarks You can use different filtering rules in a single packet. Add as many get-status operations as the number of different filtering rules.
<packet version="1.5.0.0"> <log-rotation> <get-status> </get-status ... <get-status> </get-status> </log-rotation> </packet>

Request Samples
Retrieving status of Log Rotation service on a single domain The following request packet retrieves status of Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter> <domain-name>example.com</domain-name> </filter> </get-status> </log-rotation> </packet>

Retrieving status of Log Rotation service on multiple domain The following request packet retrieves status of Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </get-status> </log-rotation> </packet>

Supported Operations

593

The following request packet retrieves status of Log Rotation service on domain example.com and the domain with ID 6:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter> <domain-id>6</domain-id> </filter> </get-status> <get-status> <filter> <domain-name>example.com</domain-name> </filter> </get-status> </log-rotation> </packet>

The following request packet retrieves status of Log Rotation service on all domains available for packet sender:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter/> </get-status> </log-rotation> </packet>

Response Packet Structure


The get-status node of the output XML packet is presented by type LogRotationGetStatusOutput (logrotation.xsd) and structured as follows:

Supported Operations

594

The result node is required. It warps the response retrieved from the server. Data type: resultFilterType (common.xsd). The status node is required. It specifies the execution status of the get-status operation. Data type: string. Allowed values: ok | error. The errcode node is optional. It returns the error code if the get-status operation fails. Data type: unsignedInt. The errtext node is optional. It returns the error message if the get-status operation fails. Data type: string. The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Filtering Issues (on page 568) section. Data type:anySimple. The id node is optional. If the get-status operation succeeds it holds the ID of the domain matched by the filtering rule. Data type: integer. The enabled node is optional. If the get-status operation succeeds, it holds status of the service on the domain. Data type: integer.

Response Samples
Retrieving status of Log Rotation service on a single domain The following request packet retrieves status of Log Rotation service on domain example.com:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter> <domain-name>example.com</domain-name> </filter> </get-status> </log-rotation> </packet>

A positive response from the server can look as follows:


<packet version="1.5.0.0"> <log-rotation> <get-status> <result> <status>ok</status> <filter-id>example.com</filter-id> <id>33</id> </result> </get-status> </log-rotation> </packet>

Supported Operations

595

If the domain was not found, the response from the server looks as follows:
<packet version="1.5.0.0"> <log-rotation> <get-status> <result> <status>error</status> <errcode>1013</errcode> <errtext>domain does not exist</errtext> <filter-id>example.com</filter-id> </result> </get-status> </log-rotation> </packet>

Retrieving status of Log Rotation service on multiple domains The following request packet retrieves status of Log Rotation service on domains used by the clients with ID 5 and ID 8:
<packet version="1.5.0.0"> <log-rotation> <get-status> <filter> <client-id>5</client-id> <client-id>8</client-id> </filter> </get-status> </log-rotation> </packet>

If the client with ID 5 was not found on the server and the client with ID 8 runs two domains (ID 17 and 29) the response from the server looks as follows:
<packet version="1.5.0.0"> <get-status> <log-rotation> <result> <status>error</status> <errcode>1015</errcode> <errtext>client does not exist</errtext> <filter-id>5</filter-id> </result> </get-status> <get-status> <result> <status>ok</status> <filter-id>8</filter-id> <id>17</id> </result> </get-status> <get-status> <result> <status>ok</status> <filter-id>8</filter-id> <id>29</id> </result> </get-status> </log-rotation></packet>

Supported Operations

596

Managing Mailing Lists


Operator: <maillist> XML Schema: maillist.xsd Plesk version: all versions API RPC version: 1.4.2.0 and higher Plesk user: Plesk Administrator, Plesk Client

Description

The maillist operator is designed for managing mailing lists on domains. Each mailing list can be enabled or disabled. If it is disabled, the messages from mailing list owner will not be sent to subscribers. The mailing service (managing all mailing lists on a domain) can be activated or deactivated. If it is deactivated, all messages from all mailing list owners of a specified domain will not be sent to subscribers.

Mailing lists are provided by the GNU Mailman software. Before using the operator, make sure that the specified software is installed on your Plesk server.

Each mailing list should have unique name parameter. The e-mail address that is used for messages delivery to subscribers looks as follows: name@domain. The name of the mailing list cannot be changed.

Supported Operations

597

Supported operations

ADD-LIST (see page 600) adds a new mailing list to the specified domain DEL-LIST (see page 605) deletes mailing lists using filtering rules GET-LIST (see page 610) retrieves mailing lists name and status using filtering rules ADD-MEMBER (see page 614) adds a new subscriber to the specified mailing list GET-MEMBERS (see page 625) retrieves the subscribers of the specified mailing lists DEL-MEMBERS (see page 624) removes a subscriber from the specified mailing lists ENABLE (see page 629) activates the mailing list service on the specified domains DISABLE (see page 634) deactivates the mailing list service on the specified domains ENABLE-LIST (see page 640) activates the specified mailing lists DISABLE-LIST (see page 645) deactivates the specified mailing lists GET-STATUS (see page 649) retrieves the status of the mailing service on the specified domain

Supported Operations

598

Filtering Issues
Filtering is the way the request XML packet indicates the object (one or several mailing lists or domains) to which an operation will be applied. The request XML filters objects using a special <filter> section. Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.

MaillistFilterType
The MaillistFilterType filter is used in del-list, get-list, enable-list, disable-list operations to retrieve, remove, enable or disable mailing lists. For more information on the operations, refer to the Removing Mailing List (see page 605), Retrieving Mailing Lists (see page 614), Enabling Mailing List (see page 640), Disabling Mailing List (see page 645) sections. Data type:MaillistFilterType (maillist.xsd). The graphical representation of the filter node is as follows:

The id node is required. It specifies the mailing list ID in Plesk database. Data type: integer. The name node is required. It specifies the mailing list name. Data type: string. The domain-id node is required. It specifies the domain ID in Plesk database. Use this parameter to specify all mailing lists on the domain (specified by ID). Data type: integer. The domain-name node is required. It specifies the domain name. Use this parameter to specify all mailing lists on the domain (specified by name). Data type: string.

Supported Operations

599

You can match multiple mailing lists using this filter as in the following example:
<filter> <domain-id>192</domain-id> <domain-id>19</domain-id> </filter>

Note: Use either id, name, domain-id, or domain-name parameters when creating a filtering rule. A packet containing a combination of id, domain-id, name, and domain-name parameters in a single filter node will be considered invalid by Plesk server.

MaillistSimpleFilterType
The MaillistSimpleFilterType filter is used in add-member, get-members, and del-member operations to add, retrieve, or remove mailing list subscribers. For more information on the operations, refer to the Adding Subscriber to Mailing List (see page 610), Retrieving Subscribers' Info (see page 625), Removing Subscriber (see page 624) sections. Data type:MaillistSimpleFilterType (maillist.xsd). The graphical representation of the filter node is as follows:

The list-id node is required. It specifies the mailing list ID in Plesk database. Data type: integer. The list-name node is required. It specifies the mailing list name. Data type: string. You can match multiple mailing lists using this filter as in the following example:

<filter> <list-id>1</list-id> <list-id>4</list-id> </filter>

Note: Use either list-id, or list-name parameters when creating a filtering rule. A packet containing a combination of list-id and list-name parameters in a single filter node will be considered invalid by Plesk server.

Supported Operations

600

MaillistToggleFilterType
The MaillistToggleFilterType filter is used in enable, disable, and get-status operations to activate, deactivate, or retrieve status of a mailing list service on a specified domain. For more information on the operations, refer to the Activating Mailing Lists Service (see page 629), Deactivating Mailing Lists Service (see page 634), Retrieving Status of Mailing List Service (see page 649) sections. Data type:MaillistToggleFilterType (maillist.xsd). The graphical representation of the filter node is as follows:

The domain-id node is required. It specifies the domain ID in Plesk database. Data type: integer. The domain-name node is required. It specifies the domain name. Data type: string.

You can match multiple domains using this filter as in the following example:
<filter> <domain-name>example.com</domain-name> <domain-name>mydomain.com</domain-name> </filter>

Note: Use either domain-id, or domain-name parameters when creating a filtering rule. A packet containing a combination of domain-id and domain-name parameters in a single filter node will be considered invalid by Plesk server.

filter-id Node

If an operation uses filters in a request packet, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If one of the following values was set as a filter rule parameter, it is returned in the filter-id node of the response packet. mailing list ID mailing list name domain ID domain name

It is done to trace the request parameters in case of error. Data type: anySimpleType. All operations except for the add-list possess the filter-id node in the response packet.

Supported Operations

601

Adding Mailing List


Use the add-list operation to add a new mailing list.

Request Packet Structure


A request XML packet adding a mailing list to Plesk database includes the add-list operation node:
<packet version="1.4.2.0"> <maillist> <add-list> ... </add-list> </maillist> </packet>

The add-list node is presented by the MaillistAddListInputType type (maillist.xsd), and its graphical representation is as follows:

The domain-id node is required. It specifies the domain ID in Plesk database. Data type: integer. The name node is required. It specifies the name of the mailing list. Data type: string. The password node is required. It specifies the mailing list administrator's password. Data type: string. The admin-email node is required. It specifies the mailing list administrator's e-mail address. All information on the mailing list management is sent to this e-mail address. Data type: string. The notify node is optional. Specifies if a notification of the mailing list creation will be sent to the administrator. Data type: boolean.

Supported Operations

602

Remarks You can add multiple mailing lists in a single packet. Add as many add-list operations as the number of mailing lists to be added.
<add-list> </add-list> <add-list> </add-list>

Request Samples
Adding a single mailing list This packet adds mailing list MyMailer to the domain specified by ID 45.
<packet version="1.4.2.0"> <maillist> <add-list> <domain-id>45</domain-id> <name>MyMailer</name> <password>hello</password> <admin-email>admin@mydomain.com</admin-email> </add-list> </maillist> </packet>

Adding multiple mailing lists This packet adds mailing lists MyMailer and SubscribeMe to the domain specified by ID 45.
<packet version="1.4.2.0"> <maillist> <add-list> <domain-id>45</domain-id> <name>MyMailer</name> <password>hello</password> <admin-email>admin@mydomain.com</admin-email> </add-list> <add-list> <domain-id>45</domain-id> <name>SubscribeMe</name> <password>123456</password> <admin-email>admin@mydomain.com</admin-email> </add-list> </maillist> </packet>

Supported Operations

603

Response Packet Structure


The add-list node of the output XML packet is presented by type MaillistAddOutputType (maillist.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: ResultType (common.xsd). The status node is required. It specifies the execution status of the add-list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add-list operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add-list operation fails. Data type: string. The id node is optional. It returns the mailing list ID in Plesk database if the operation succeeds. Data type: integer.

Response Samples
Adding a single mailing list This request packet adds mailing list MyMailer to the domain specified by ID 45.
<packet version="1.4.2.0"> <maillist> <add-list> <domain-id>45</domain-id> <name>MyMailer</name> <password>hello</password> <admin-email>admin@mydomain.com</admin-email> </add-list> </maillist> </packet>

Supported Operations

604

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <maillist> <add-list> <result> <status>ok</status> <id>133</id> </result> </add-list> </maillist> </packet>

If the Mailman software is not installed on the server, the response looks as follows:
<packet version="1.4.2.0"> <maillist> <add-list> <result> <status>error</status> <errcode>1031</errcode> <errtext>Component is not configured on server</errtext> </result> </add-list> </maillist> </packet>

Adding multiple mailing lists This request packet adds mailing lists MyMailer and SubscribeMe to the domain specified by ID 45.
<packet version="1.4.2.0"> <maillist> <add-list> <domain-id>45</domain-id> <name>MyMailer</name> <password>hello</password> <admin-email>admin@mydomain.com</admin-email> </add-list> <add-list> <domain-id>45</domain-id> <name>SubscribeMe</name> <password>123456</password> <admin-email>admin@mydomain.com</admin-email> </add-list> </maillist> </packet>

Supported Operations

605

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <maillist> <add-list> <result> <status>ok</status> <id>133</id> </result> </add-list> <add-list> <result> <status>ok</status> <id>134</id> </result> </add-list> </maillist> </packet>

Removing Mailing List


Use the del-list operation to remove mailing lists. Use filters to specify mailing lists by name, ID, domain ID, or domain name. For information on filters, refer to Filtering Issues (see page 601) section.

Request Packet Structure


A request XML packet removing a mailing list from Plesk database includes the del-list operation node:
<packet version="1.4.2.0"> <maillist> <del-list> ... </del-list> </maillist> </packet>

The del-list node is presented by the MaillistDelListInputType type (maillist.xsd), and its graphical representation is as follows:

The filter node is required. It specifies the filtering rule. For information on this filter, refer to the Filtering Issues (see page 598) section. Data type: MaillistFilterType (maillist.xsd).

Supported Operations

606

Remarks You can remove mailing lists using different filtering rules in a single packet. Add as many del-list operations as the number of different filtering rules to be applied.
<del-list> </del-list> <del-list> </del-list>

Request Samples
Removing a single mailing list This packet removes mailing list MyMailer.
<packet version="1.4.2.0"> <maillist> <del-list> <filter> <name>MyMailer</name> </filter> </del-list> </maillist> </packet>

Removing multiple mailing lists This packet removes mailing lists MyMailer and SubscribeMe.
<packet version="1.4.2.0"> <maillist> <del-list> <filter> <name>MyMailer</name> <name>SubscribeMe</name> </filter> </del-list> </maillist> </packet>

This packet removes all mailing lists from domains Mydomain.com and My2domain.com.
<packet version="1.4.2.0"> <maillist> <del-list> <filter> <domain-name>Mydomain.com</domain-name> <domain-name>My2domain.com</domain-name> </filter> </del-list> </maillist> </packet>

Supported Operations

607

This packet removes all mailing lists from domain Mydomain.com and the domain specified by ID 7.
<packet version="1.4.2.0"> <maillist> <del-list> <filter> <domain-name>Mydomain.com</domain-name> </filter> </del-list> <del-list> <filter> <domain-id>7</domain-id> </filter> </del-list> </maillist> </packet>

Response Packet Structure


The del-list node of the output XML packet is presented by type MaillistDelOutputType (maillist.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: ResultFilterType (common.xsd). The status node is required. It specifies the execution status of the del-list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the del-list operation fails. Data type: integer. The errtext node is optional. It returns the error message if the del-list operation fails. Data type: string. The filter-id node is optional. It holds the filtering rule parameter. For information, refer to the Filtering Issues (see page 600) section. Data type: anySimpleType.

Supported Operations

608

The id node is optional. It returns the mailing list ID in Plesk database if the operation succeeds. Data type: integer.

Response Samples
Removing a single mailing list This request packet removes mailing list MyMailer.
<packet version="1.4.2.0"> <maillist> <del-list> <filter> <name>MyMailer</name> </filter> </del-list> </maillist> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <maillist> <del-list> <result> <status>ok</status> <filter-id>MyMailer</filter-id> <id>13</id> </result> </del-list> </maillist> </packet>

If mailing list MyMailer was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <maillist> <del-list> <result> <status>error</status> <errcode>1013</errcode> <errtext>Maillist does not exist</errtext> <filter-id>MyMailer</filter-id> </result> </del-list> </maillist> </packet>

Supported Operations

609

Removing multiple mailing lists

This request packet removes all mailing lists from domain Mydomain.com.

<packet version="1.4.2.0"> <maillist> <del-list> <filter> <domain-name>Mydomain.com</domain-name> </filter> </del-list> </maillist> </packet>

If three mailing lists were removed from the server, a server response can look as follows:

<packet version="1.4.2.0"> <maillist> <del-list> <result> <status>ok</status> <filter-id>Mydomain.com</filter-id> <id>13</id> </result> <result> <status>ok</status> <filter-id>Mydomain.com</filter-id> <id>18</id> </result> <result> <status>ok</status> <filter-id>Mydomain.com</filter-id> <id>23</id> </result> </del-list> </maillist> </packet>

Supported Operations

610

Adding Subscriber to Mailing List


Use the add-member operation to add a new subscriber to a mailing list specified by name or ID.

Request Packet Structure


A request XML packet adding a subscriber includes the add-member operation node:
<packet version="1.4.2.0"> <maillist> <add-member> ... </add-member> </maillist> </packet>

The add-member node is presented by the MaillistAddMemberInputType type (maillist.xsd), and its graphical representation is as follows:

The filter node is required. It specifies the filtering rule. You can subscribe a person specified by id to multiple mailing lists in a single packet. For information on this filter, refer to the Filtering Issues (see page 599) section. Data type: MaillistSimpleFilterType (maillist.xsd). The id node is required. It specifies the subscriber's e-mail address. Data type: emailType (common.xsd).

Remarks You can add multiple subscribers to a mailing list using different filtering rules in a single packet. Add as many add-member operations as the number of different filtering rules to be applied.
<add-member> </add-member> <add-member> </add-member>

Supported Operations

611

Request Samples
Adding a subscriber

This packet adds the subscriber with e-mail address mymail@mydomain.com to mailing list MyMailer.

<packet version="1.4.2.0"> <maillist> <add-member> <filter> <list-name>MyMailer</list-name> </filter> <id>mymail@mydomain.com</id> </add-member> </maillist> </packet>

Adding multiple mailing lists This packet adds the subscriber with e-mail address mymail@mydomain.com to mailing lists MyMailer and SubscribeMe.

<packet version="1.4.2.0"> <maillist> <add-member> <filter> <list-name>MyMailer</list-name> <list-name>SubscribeMe</list-name> </filter> <id>mymail@mydomain.com</id> </add-member> </maillist> </packet>

Supported Operations

612

Response Packet Structure


The add-member node of the output XML packet is presented by type MaillistAddMemberOutputType (maillist.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: MaillistMemberResultType (maillist.xsd). The status node is required. It specifies the execution status of the add-member operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the add-member operation fails. Data type: integer. The errtext node is optional. It returns the error message if the add-member operation fails. Data type: string. The filter-id node is optional. It holds the filtering rule parameter. For information, refer to the Filtering Issues (see page 600) section. Data type: anySimpleType. The id node is optional. It returns the subscriber's e-mail address if the operation succeeds. Data type: emailType (common.xsd).

Supported Operations

613

Response Samples
Adding a subscriber This request packet adds the subscriber with e-mail address mymail@mydomain.com to mailing list MyMailer.
<packet version="1.4.2.0"> <maillist> <add-member> <filter> <list-name>MyMailer</list-name> </filter> <id>mymail@mydomain.com</id> </add-member> </maillist> </packet>

The positive response from the server looks as follows:


<packet version="1.4.2.0"> <maillist> <add-member> <result> <status>ok</status> <filter-id>MyMailer</filter-id> <id>mymail@mydomain.com</id> </result> </add-member> </maillist> </packet>

If the mailing list was not found on the server, the response looks as follows:
<packet version="1.4.2.0"> <maillist> <add-member> <result> <status>error</status> <errcode>1015</errcode> <errtext>Mailing list does not exist</errtext> <filter-id>MyMailer</filter-id> </result> </add-member> </maillist> </packet>

Supported Operations

614

Adding subscribers to multiple mailing lists This request packet adds the subscriber with e-mail address mymail@mydomain.com to mailing lists MyMailer and SubscribeMe.
<packet version="1.4.2.0"> <maillist> <add-member> <filter> <list-name>MyMailer</list-name> <list-name>SubscribeMe</list-name> </filter> <id>mymail@mydomain.com</id> </add-member> </maillist> </packet>

The positive response looks as follows:


<packet version="1.4.2.0"> <maillist> <add-member> <result> <status>ok</status> <filter-id>MyMailer</filter-id> <id>mymail@mydomain.com</id> </result> <result> <status>ok</status> <filter-id>SubscribeMe</filter-id> <id>mymail@mydomain.com</id> </result> </add-member> </maillist> </packet>

Retrieving Mailing Lists


Use the get-list operation to retrieve preferences of specified mailing lists. Use filters to specify mailing lists by name, ID, domain ID, or domain name. For information on filters, refer to the Filtering Issues (see page 601) section.

Request Packet Structure


A request XML packet retrieving a mailing list preferences includes the get-list operation node:
<packet version="1.4.2.0"> <maillist> <get-list> ... </get-list> </maillist> </packet>

Supported Operations

615

The get-list node is presented by the MaillistGetListInputType type (maillist.xsd), and its graphical representation is as follows:

The filter node is required. It specifies the filtering rule. For information on this filter, refer to the Filtering Issues (see page 598) section. Data type: MaillistFilterType (maillist.xsd).

Remarks You can retrieve parameters of multiple mailing lists using different filtering rules in a single packet. Add as many get-list operations as the number of different filtering rules to be applied.
<get-list> </get-list> <get-list> </get-list>

Request Samples
Retrieving information on a single mailing list This packet retrieves preferences of the mailing list called MyMailer.
<packet version="1.4.2.0"> <maillist> <get-list> <filter> <name>MyMailer</name> </filter> </get-list> </maillist> </packet>

Retrieving information on multiple mailing lists This packet retrieves preferences of the mailing lists called MyMailer and SubscribeMe.
<packet version="1.4.2.0"> <maillist> <get-list> <filter> <name>MyMailer</name> <name>SubscribeMe</name> </filter> </get-list> </maillist> </packet>

Supported Operations

616

This packet retrieves preferences of all mailing lists on domains Mydomain.com and My2domain.com.

<packet version="1.4.2.0"> <maillist> <get-list> <filter> <domain-name>Mydomain.com</domain-name> <domain-name>My2domain.com</domain-name> </filter> </get-list> </maillist> </packet>

This packet retrieves preferences of all mailing lists on domain Mydomain.com and the domain specified by ID 7.

<packet version="1.4.2.0"> <maillist> <get-list> <filter> <domain-name>Mydomain.com</domain-name> </filter> </get-list> <get-list> <filter> <domain-id>7</domain-id> </filter> </get-list> </maillist> </packet>

Supported Operations

617

Response Packet Structure


The get-list node of the output XML packet is presented by type MaillistGetOutputType (maillist.xsd) and structured as follows:

The result node is required. It warps the response retrieved from the server. Data type: ResultFilterType (common.xsd). The status node is required. It specifies the execution status of the get-list operation. Data type: string. Allowed values: ok | error. The errcode node is optional. Is returns the error code if the get-list operation fails. Data type: integer. The errtext node is optional. It returns the error message if the get-list operation fails. Data type: string. The filter-id node is optional. It holds the filtering rule parameter. For information, refer to the Filtering Issues (see page 600) section. Data type: anySimpleType. The id node is optional. It returns ID of the mailing list in Plesk database if the operation succeeds. Data type: integer. The name node is optional. It is required if the operation succeeds. It returns the name of the mailing list. Data type: string. The list-status is optional. It is required if the operation succeeds. It returns the status of the mailing list. Data type: boolean.

Supported Operations

618

Response Samples
Retrieving information on a single mailing list This request packet retrieves preferences of the mailing list called MyMailer.
<packet version="1.4.2.0"> <maillist> <get-list> <filter> <name>MyMailer</name> </filter> </get-list> </maillist> </packet>

A positive response from the server can look as follows:


<packet version="1.4.2.0"> <maillist> <get-list> <result> <status>ok</status> <filter-id>MyMailer</filter-id> <id>2</id> <name>MyMailer</name> <list-status>false</list-status> </result> </get-list> </maillist> </packet>

If mailing list MyMailer was not found on the server, the response is as follows:
<packet version="1.4.2.0"> <maillist> <get-list> <result> <status>error</status> <errcode>1013</errcode> <errtext>Maillist does not exist</errtext> <filter-id>MyMailer</filter-id> </result> </get-list> </maillist> </packet>

Supported Operations

619

Retrieving information on multiple mailing lists This request packet retrieves preferences of all mailing lists on the domains with ID 1 and ID 21.
<packet version="1.4.2.0"> <maillist> <get-list> <filter> <domain-id>1</domain-id> <domain-id>21</domain-id> </filter> </get-list> </maillist> </packet>

If the domain with ID 21 was not found on the server, and the domain with ID 1 has two active mailing lists, a response from the server can look as follows:
<packet version="1.4.2.0"> <maillist> <get-list> <result> <status>ok</status> <filter-id>1</filter-id> <id>12</id> <name>MailerOne</name> <list-status>true</list-status> </result> <result> <status>ok</status> <filter-id>1</filter-id> <id>17</id> <name>MailerTwo</name> <list-status>true</list-status> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>Domain does not exist</errtext> <filter-id>21</filter-id> </result> </get-list> </maillist> </packet>

Supported Operations

620

Retrieving Subscribers' Info


Use the get-members to retrieve e-mail addresses of people who were subscribed to a specified mailing list.

Request Packet Structure


A request XML packet retriev