Available Filters

Filtering is the way the request XML packet indicates the object (one or several subdomains) to which the operation will be applied. Parameters nested in the filter node are called filtering rule.

The filter node is presented by the SubdomainFilterType complex type (subdomain.xsd). This data type is structured as follows:

SubdomainFilterType

  • The id node is optional. It specifies subdomain ID in Plesk database. Data type: id_type.
  • The name node is optional. It specifies full subdomain name (including parent site name). Data type: string.
  • The parent-name node is optional. It specifies a name of site/subdomain on which the subdomain is created. Data type: string.

A subdomain can be filtered by either id node, name node or parent-name node. The same is true if several subdomains are filtered by their IDs, names or parent names with one filter node. However, using different nodes within the same filter node is prohibited.

To apply requested operation to all subdomains, use the blank (<filter/>) filter node. For example, a packet that retrieves the information about all subdomains looks as follows:

<packet version="1.5.2.0">
<subdomain>
<get>
   <filter/>
</get>
</subdomain>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.