Response Packet Structure

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

set-ppb-connection-result

  • The result node is required. It wraps the result of the set-ppb-connection operation. Data type: resultType (common.xsd).
  • The status node is required. It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
  • The errcode node is required if the operation fails. Returns error code. Data type: unsignedInt.
  • The errtext node is is required if the operation fails. Returns error message. Data type: string.

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

 

Samples

A request packet setting a connection to CBM can look as follows:

<packet>
  <server>
    <set-ppb-connection>
      <connection>
         <ppb-url>https://host.name:8443/plesk-billing/</ppb-url>
         <remote-access-hash>f2ad7647377beb58808b8ffceff5527d4f9d4c1d</remote-access-hash>
         <integration-api-version>1.6.3.0</integration-api-version>
      </connection>
    </set-ppb-connection>
  </server>
</packet>

Response:

<packet version="1.6.3.0">
  <server>
    <set-ppb-connection>
      <result>
        <status>ok</status>
      </result>
    </set-ppb-connection>
  </server>
</packet>
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.