Getting Supported Protocols

To retrieve a list of API RPC protocol versions supported on a Plesk server, send to the server a request packet with the get_protos operational node:

<packet version="1.4.2.0">

  <server>

    <get_protos/>

  </server>

</packet>

The get_protos node is presented by the GetProtosType (server_input.xsd).

Response packet

The get_protos node of the response packet received from server is presented by the complex type GetProtosType (server_output.xsd) and is structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: GetProtosResultType (server_output.xsd).
• The status node is required. It specifies the execution status of the get_protos operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. It is used to return the error code when the get_protos operation fails. Data type: unsignedInt.
• The errtext node is optional. It is used to return the error message if the get_protos operation fails. Data type: string.
• The protos node is required if the get_protos operation has succeeded. It hold the list of API RPC protocol versions supported on the server. Data Type: ProtosList (server_output.xsd).
• The proto node is required if the get_protos operation has succeeded. It specifies a supported version of API RPC protocol. Data type: string.

A positive response received from server can look as follows:

<packet version="1.4.2.0">

<server>

<get_protos>

   <result>

      <status>ok</status>

      <protos>

         <proto>1.0.0.0</proto>

         <proto>1.1.0.0</proto>

         <proto>1.2.0.0</proto>

         <proto>1.3.0.0</proto>

         <proto>1.3.1.0</proto>

         <proto>1.3.2.0</proto>

         <proto>1.3.3.0</proto>

         <proto>1.3.4.0</proto>

         <proto>1.3.5.0</proto>

         <proto>1.4.0.0</proto>

         <proto>1.4.1.0</proto>

         <proto>1.4.2.0</proto>

         <proto>1.4.1.1</proto>

         <proto>1.4.1.2</proto>

      </protos>

   </result>

</get_protos>

</server>

</packet>