Excluding an App From an Add-On Plan

The remove-package operation is used to exclude apps from add-on plans. Excluded apps are not available to plan subscribers.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet excluding an app from an add-on plan includes the remove-package operation node:

<packet>
<service-plan-addon>
   <remove-package>
   ...
   </remove-package>
</service-plan-addon>
</packet>

 

The remove-package node is presented by type ServicePlanAddonApplicationInput (domain_addon_template.xsd). Its graphical representation is as follows:

ServicePlanAddonApplicationInput-remove

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 filter node is required. It serves to specify the criteria by which the necessary add-on 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 add-on plan owner. Data type: integer.
  • The owner-login node is optional. It specifies the login name of the add-on 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 add-on 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 add-on 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_addon_template.xsd)which has the following presentation:

ServicePLanApplicationOutput-remove

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 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 add-on plan was filtered by in the request packet. Data type: anySimple.
  • The id node is optional. Returns the identifier of the add-on plan from which the application was removed. Data type: id_type (common.xsd).
 

Samples

This packet excludes an app WordPress from the add-on plan base_plan owned by user with login name JDoe.

<packet>
<service-plan-addon>
<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-addon>
</packet>

Response:

<packet>
<service-plan-addon>
<remove-package>
   <result>
      <status>ok</status>
      <filter-id>base_plan</filter-id>
      <id>1234</id>
   </result>
</remove-package>
</service-plan-addon>
</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.