To remove a host from the ACL of your name server, use the remove_from_acl operation. You can remove multiple hosts from the ACL using a single packet. This operation is available on Linux only.

Request Packet Structure

A request XML packet removing a host from the ACL includes the remove_from_acl operation node:

<packet>
    <dns>
        <remove_from_acl>
            ...
        </remove_from_acl>
    </dns>
</packet>

The graphical representation of the remove_from_acl node is as follows:

image 34918

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

  • The filter node is required. It specifies the filtering rule. For more information, refer to the Available Filters section. Data type: aclFilter (dns_input.xsd) .

You can remove multiple hosts from the ACL in a single packet using filters. Add as many host parameters to the filter node as the number of hosts you want to remove from ACL.

Response Packet Structure

The remove_from_acl node of the output XML packet is structured as follows:

image 34912

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

  • The result node is optional. It is required in case when an error (if it occurred) was not of a common type. Data type: resultType (common.xsd).
  • The status node is required. It specifies the execution status of the remove_from_acl operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. It is used to return the error code when the remove_from_acl operation fails. Data type: unsignedInt.
  • The errtext node is optional. It is used to return the error message if the remove_from_acl operation fails. Data type: string.
  • The host node is optional. It is required in case an error (if it was) was not of a common type. Returns the IP address or name of hosts from the ACL. Data type: string.

Samples

Removing a single host from ACL

This request packet removes host 192.168.34.56 from the ACL.

<packet>
    <dns>
        <remove_from_acl>
            <filter>
                <host>192.168.34.56</host>
            </filter>
        </remove_from_acl>
    </dns>
</packet>

Response:

<packet>
    <dns>
        <remove_from_acl>
            <result>
                <status>ok</status>
                <host>192.168.34.56</host>
            </result>
        </remove_from_acl>
    </dns>
</packet>

Removing a host from ACL two twice

This request packet remove host 192.168.34.56 from ACL two times.

<packet>
    <dns>
        <remove_from_acl>
            <filter>
                <host>192.168.34.56</host>
            </filter>
        </remove_from_acl>
        <remove_from_acl>
            <filter>
                <host>192.168.34.56</host>
            </filter>
        </remove_from_acl>
    </dns>
</packet>

Response:

<packet>
    <dns>
        <remove_from_acl>
            <result>
                <status>ok</status>
                <host>192.168.34.56</host>
            </result>
        </remove_from_acl>
        <remove_from_acl>
            <result>
                <status>error</status>
                <errcode>1007</errcode>
                <errtext>IP address 192.168.34.56 already exists.</errtext>
            </result>
        </remove_from_acl>
    </dns>
</packet>