This is documentation for Plesk 12.5.
Go to documentation for the latest version, Plesk Obsidian.
Excluding an App From a Service Plan
The remove-package operation is used to exclude apps from service plans. Excluded apps are not available to plan subscribers.
Request Packet Structure
A request XML packet excluding an app from a service plan includes the remove-package operation node:
<packet>
<service-plan>
<remove-package>
...
</remove-package>
</service-plan>
</packet>
The remove-package node is presented by type ServicePlanApplicationInput (domain_template.xsd
). Its graphical representation is as follows:
- The filter node is required. It serves to specify the criteria by which the necessary service plans will be selected from the database. Data type: DomainTemplateFilterType (
domain_template.xsd
). See the Available Filters section for details on this node. - The owner-id node is optional. It specifies the ID of the service plan owner. Data type: integer.
- The owner-login node is optional. It specifies the login name of the service plan owner. Data type: string.
- The package node is required. It specifies what type of information about the removed package is requested. Data type: ApplicationInput (
plesk_common.xsd
). - The name node is required. It specifies whether the name or the URL of the application removed from the service plan will be specified. Data type: string.
- The value node is required. It specifies the value of the name or the URL of the application that will be removed from the service plan. Data type: string.
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
Response Packet Structure
The remove-package node of the output XML packet is of complex type (domain_template.xsd)
which has the following presentation:
- 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 service plan was filtered by in the request packet. Data type: anySimple.
- The id node is optional. Returns the identifier of the service plan from which the application was removed. Data type: id_type (
common.xsd
).
Samples
This packet excludes an app WordPress from the service plan base_plan owned by user with login name JDoe.
<packet>
<service-plan>
<remove-package>
<filter>
<name>base_plan</name>
</filter>
<owner-login>JDoe</owner-login>
<package>
<name>name</name>
<value>WordPress</value>
</package>
</remove-package>
</service-plan>
</packet>