The get operation is used to retrieve the following information on a subdomain from Plesk database:
A request XML packet retrieving information on a subdomain includes the get operation node:
<packet version="1.5.2.0">
<subdomain>
<get>
...
</get>
</subdomain>
</packet>
The get node is presented by the SubdomainGetInputType (subdomain.xsd
). Its graphical representation is as follows:
subdomain.xsd
).
The get node of the output XML packet is structured as follows:
common.xsd
).common.xsd
). Allowed values: ok|error
.common.xsd
).subdomain.xsd
). See the structure of this node below.The data node is defined by complex type SubdomainObjectType (subdomain.xsd
). It is structured as follows:
<home/>
), the root directory of the parent site is used. Data type: stringsubdomain.xsd
).
Possible Errors
This packet retrieves information on the subdomain forum.example.com.
<packet>
<subdomain>
<get>
<filter>
<name>forum.example.com</name>
</filter>
</get>
</subdomain>
</packet>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
<subdomain>
<get>
<result>
<status>ok</status>
<filter-id>forum.example.com</filter-id>
<id>3</id>
<data>
<parent>example.com</parent>
<name>forum.example.com</name>
<property>
<name>asp</name>
<value>false</value>
</property>
<property>
<name>ssi</name>
<value>false</value>
</property>
<property>
<name>php</name>
<value>true</value>
</property>
<property>
<name>php_handler_id</name>
<value>fastcgi</value>
</property>
<property>
<name>cgi</name>
<value>true</value>
</property>
<property>
<name>perl</name>
<value>true</value>
</property>
<property>
<name>python</name>
<value>true</value>
</property>
<property>
<name>coldfusion</name>
<value>false</value>
</property>
<property>
<name>fastcgi</name>
<value>true</value>
</property>
<property>
<name>miva</name>
<value>false</value>
</property>
<property>
<name>ssl</name>
<value>true</value>
</property>
<property>
<name>same_ssl</name>
<value>true</value>
</property>
<property>
<name>www_root</name>
<value>/var/www/vhosts/example.com/forum.example.com</value>
</property>
<property>
<name>webstat</name>
<value>webalizer</value>
</property>
<property>
<name>webstat_protected</name>
<value/>
</property>
</data>
</result>
</get>
</subdomain>
</packet>
This packet retrieves information on all subdomains existing on the site example.com.
<packet>
<subdomain>
<get>
<filter>
<parent-name>example.com</parent-name>
</filter>
</get>
</subdomain>
</packet>
This packet retrieves information on all subdomains hosting on the server.
<packet>
<subdomain>
<get>
<filter/>
</get>
</subdomain>
</packet>