Packet Structure

A packet can be represented graphically in the following way:

Speaking of the Plesk XML-RPC packet structure, we distinguish the following parts:

1. HTTP header – transport part. Besides other standard information, it must contain data on the server where the operation will be performed, and the login credentials of Plesk user on whose behalf the operation will be performed.
2. Packet header specifying the version of Plesk API RPC protocol.
3. Packet body defining operations that are to be performed by Plesk server.

The packet body is structured as follows:

<[operator]>

<[operation]>

      <[parameter1]>…</[parameter1]>

...

      <[parameter2]>…</[parameter2]>

      …

</[operation]>

</[operator]>

This example shows the common structure of the packet body, with one [operator] element and one [operation] element within. In a particular implementation, labels [operator], [operation], [parameter] should be substituted by real operators, operations, and parameters.

Note: There can be many operation sections within one operator. Also, starting from API RPC v. 1.4.0.0, a single packet allows multiple operator elements.

You can look for particular values of labels [operator], [operation], and [parameter] in two places:

• The Supported Operation section of the API RPC Reference presents the detailed description of how to create a request packet for a particular operation.
• If the operation you need is not described in the Supported Operations section of the API RPC Reference, then you can form the packet on your own using the XML API schemas. All API schemas are listed in the API RPC Versions section of the API RPC Reference. Search within a particular section marked by the API RPC version you need.

Hereinafter, we refer to XML packet header and body together as to a packet.