This is documentation for Plesk 12.5.
Go to documentation for the latest version, Plesk Obsidian.
Enabling Applications Filter
The enable-aps-filter operation is used to turn on applications list for specified subscriptions and make available only added applications, by default all applications are available.
Request Packet Structure
A request XML packet turning on the applications list for a subscription and making available only selected applications includes the enable-aps-filter operation node:
<packet>
<webspace>
<enable-aps-filter>
...
</enable-aps-filter>
</webspace>
</packet>
The enable-aps-filter node is presented by type WebspaceApsFilterInputType (webspace.xsd
). Its graphical representation is as follows:
- The filter node is required. It specifies the subscription to be updated with the specified information. Data type: DomainFilterType (
domain_input.xsd
). To see the structure of this node, proceed to topic Available Filters.
Response Packet Structure
The enable-aps-filter node of the response packet is structured as follows:
- The result node is required. It wraps the response got from the server. Data type: resultFilterType (
common.xsd
). - The status node is required. Specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. Returns the error code when the operation fails. Data type: unsignedInt.
- The errtext node is optional. Returns the error message if the operation fails. Data type: string.
- The filter-id node is optional. Returns the parameter by which the subscription was filtered by in the request packet. Data type: anySimple.
- The id node is optional. Returns the identifier of the subscription for which the applications filter was turned on. Data type: id_type (
common.xsd
).
Samples
A packet that turns on the applications list for the subscription with ID 1234 looks as follows:
<packet>
<webspace>
<enable-aps-filter>
<filter>
<id>1234</id>
</filter>
</enable-aps-filter>
</webspace>
</packet>
Response:
<packet>
<webspace>
<enable-aps-filter>
<result>
<status>ok</status>
<filter-id>1234</filter-id>
<id>1234</id>
</result>
</enable-aps-filter>
</webspace>
</packet>