Use the get-physical-hosting-descriptor operation to retrieve descriptor of domain hosting settings. For details on descriptors, refer to the Representation of Object Descriptor section. For details on hosting settings, refer to the Hosting Settings section.
A request XML packet retrieving descriptor of hosting settings includes the get-physical-hosting-descriptor operation node:
<packet version="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
...
</get-physical-hosting-descriptor>
</webspace>
</packet>
You can retrieve descriptor for the specified subscription (or multiple subscriptions specified by customer ID or login name) or the server-level descriptor of hosting settings. The get-physical-hosting-descriptor node has the following graphical representation:
domain_input.xsd
).The get-physical-hosting-descriptor node of the output XML packet is structured as follows:
plesk_common.xsd
). Note: This descriptor contains hosting settings extensions. For details, refer to the Extension of Hosting Settings Descriptor section.
The request packet retrieving descriptor of hosting settings for the subscription with ID 5 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
<filter>
<id>5</id>
</filter>
</get-physical-hosting-descriptor>
</webspace>
</packet>
Response:
<packet version="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
<result>
<status>ok</status>
<filter-id>MyDomain.com</filter-id>
<id>5</id>
<descriptor>
<property>
<name>ftp_login</name>
<type>string</type>
<writable-by>admin</writable-by>
<label>hst_def__fp_admin_login</label>
</property>
<property>
<name>fp_admin_password</name>
<type>passwordString</type>
<writable-by>none</writable-by>
<label>hst_def__fp_admin_passwd</label>
</property>
...
</descriptor></result></get-physical-hosting-descriptor>
</webspace></packet>
The request packet retrieving descriptor of hosting settings for subscriptions with ID 5 and ID 7 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
<filter>
<name>5</name>
<name>7</name>
</filter>
</get-physical-hosting-descriptor>
</webspace>
</packet>
The request packet retrieving descriptor of hosting settings for subscriptions of the customer specified by ID 3 looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
<filter>
<owner-id>3</owner-id>
</filter>
</get-physical-hosting-descriptor>
</webspace>
</packet>
The request packet retrieving the server-level descriptor of hosting settings looks as follows:
<packet version ="1.6.3.0">
<webspace>
<get-physical-hosting-descriptor>
<filter/>
</get-physical-hosting-descriptor>
</webspace>
</packet>