Response Packet Structure

The get_info 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 get_info operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the get_info operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the get_info operation fails. Data type: string.
• The key node is optional. It holds the key value if the operation fails. Data type: string.
• The key_info node is optional. It holds info on the key if the operation succeeds. Data type: SecretKeyInfo (plesk_secretkeys.xsd).

  The following parameters are nested in the key_info node:

  • The key node is required. It specifies the secret key value. Data type: string.
  • The ip_address node is required. It specifies the IP address linked to the secret key. Data type: ip_address (common.xsd).
  • The description node is required. It specifies the secret key description. Data type: string.