The del operation is used to remove reseller accounts and all their settings from Plesk database.

Request Packet Structure

A request XML packet removing a reseller account from Plesk database includes the del operation node:

<packet>
    <reseller>
        <del>
            ...
        </del>
    </reseller>
</packet>

The del node is presented by the ResellerDelInput type (reseller.xsd). Its graphical representation is as follows:

image 60376

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.

  • filter, required.

    It specifies the filtering rule. Data type: ResellerSelectionFilter (reseller.xsd) . For more information on filters, refer to the Available Filters section.

Response Packet Structure

The del node of the response packet is structured as follows:

image 60377

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 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 del operation. Data type: result_status (common.xsd). Allowed values: ok|error.
    • The errcode node is required if the del operation fails. It returns the error code. Data type: unsignedInt.
    • The errtext node is required if the del operation fails. It returns the error message. Data type: string.
    • The filter-id node is required. It returns the parameter by which the reseller account was filtered in the request packet. Data type: anySimple.
    • The id node is required if the operation succeeds, or if the results are filtered by ID. It returns ID of the removed reseller account. Data type: id_type (common.xsd).

Samples

Removing a single reseller account

To remove a reseller account, specify its ID or login name:

<packet>
    <reseller>
        <del>
            <filter>
                <id>1324</id>
            </filter>
        </del>
    </reseller>
</packet>

Response:

<packet>
    <reseller>
        <del>
            <result>
                <status>ok</status>
                <filter-id>2</filter-id>
                <id>2</id>
            </result>
        </del>
    </reseller>
</packet>

Removing multiple reseller accounts

To remove multiple reseller accounts, add either reseller IDs or login names to the filtering rule:

<packet>
    <reseller>
        <del>
            <filter>
                <id>1324</id>
                <id>1325</id>
            </filter>
        </del>
    </reseller>
</packet>

Response:

<packet>
    <reseller>
        <del>
            <result>
                <status>ok</status>
                <filter-id>2</filter-id>
                <id>1</id>
            </result>
            <result>
                <status>ok</status>
                <filter-id>2</filter-id>
                <id>2</id>
            </result>
        </del>
    </reseller>
</packet>

Removing all reseller accounts

To remove all reseller accounts, use the following packet:

<packet>
    <reseller>
        <del>
            <filter>
                <all/>
            </filter>
        </del>
    </reseller>
</packet>

Response:

<packet>
    <reseller>
        <del>
            <result>
                <status>ok</status>
                <filter-id>3</filter-id>
                <id>3</id>
            </result>
            <result>
                <status>ok</status>
                <filter-id>4</filter-id>
                <id>4</id>
            </result>
        </del>
    </reseller>
</packet>