Use the get-physical-hosting-descriptor operation to retrieve descriptor of hosting settings you can set for your sites. For details on descriptors, refer to the Representation of Object Descriptor section:
- For information on property descriptors, refer to the section Representation of Object Descriptors: Property Descriptor.
- For information about property extensions, refer to the section Representation of Object Descriptors: Property Descriptor > Extension of Hosting Settings Descriptor.
For details on hosting settings, refer to the Hosting section.
Request Packet Structure
A request XML packet retrieving descriptor of hosting settings includes the get-physical-hosting-descriptor operation node:
You can retrieve descriptor for the specified site (or multiple sites specified by a filtering rule) or the server-level descriptor of hosting settings. The get-physical-hosting-descriptor node (
site.xsd) has the following graphical representation:
It specifies a filtering rule. For info on filters, refer to the Filters of Descriptors section. Data type: siteFilterType (
Response Packet Structure
The get-physical-hosting-descriptor node of the output XML packet is structured as follows:
It wraps the response retrieved from the server. Data type: ResultFilterType (
It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
It is used to return the error code when the operation fails. Data type: unsignedInt.
Can be used to return the error message if the operation fails. Data type: string.
It is required if the operation succeeds. It returns a filtering rule you specified in the request packet. For info on filters, refer to the Filters of Descriptors section. Data type: anySimple.
It is required if the operation succeeds. Returns the unique identifier of the site. Data type: integer.
It specifies the object descriptor. For details, refer to Representation of Object Descriptor. Data type: string.
Note: This descriptor contains hosting settings extensions. For details, refer to the Extension of Hosting Settings Descriptor section.
A request for available hosting settings for site with ID 19 looks as follows:
<extension> element indicates the level at which a property is applicable (domain or subdomain).
If the site specified in the request packet was not found on the server, the result is as follows:
You can see the full list of properties available in the system if you send the following request packet: