Removing IP Addresses from Reseller's IP Pool

The ippool-del-ip operation is used to remove IP addresses from the reseller's IP pool.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet removing IP addresses from reseller's IP pool includes the ippool-del-ip node:

<packet>
<reseller>
   <ippool-del-ip>
   ...
   </ippool-del-ip>
</reseller>
</packet>

 

The ippool-del-ip node is specified by ResellerIpPoolDelInput complex type (reseller.xsd). Its graphical representation is as follows:

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

  • The reseller-id node is required. It specifies the ID of a reseller account from whose IP pool an IP address is to be removed. Data type: integer.
  • The ip-address node is required. It specifies an IP address which is to be removed from a reseller's IP pool. Data type: ip_address (common.xsd).

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The ippool-del-ip node of the response packet is structured as follows (data type ResellerIpPoolOperationOutput (reseller.xsd)):

ResellerIpPoolOperationOutput

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.

  • 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 ippool-del-ip operation. Data type: result_status (common.xsd). Allowed values: ok|error.
    • The errcode node is required if the ippool-del-ip operation fails. It returns the error code. Data type: unsignedInt.
    • The errtext node is required if the ippool-del-ip operation fails. It returns the error message. Data type: string.
    • The ip-address node is required if the operation succeeds. It returns the IP address added to the reseller's IP pool. Data type: ip_address (common.xsd).
    • The reseller-id node is optional. It is not returned for this operation.
 

Samples

To remove IP address from a reseller’s IP pool, specify the packet as follows:

<packet version="1.6.0.0">
<reseller>
   <ippool-del-ip>
       <reseller-id>1234</reseller-id>
       <ip-address>192.0.2.111</ip-address>
   </ippool-del-ip>
</reseller>
</packet>

Response:

<packet version="1.6.0.0">
  <reseller>
    <ippool-del-ip>
      <result>
        <status>ok</status>
        <ip-address>192.0.2.111</ip-address>
      </result>
    </ippool-del-ip>
  </reseller>
</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.