Primary Domain, Add-on domain, or Subdomain

The get operation of the site operator enables you to retrieve the information about the ICP permit status and the ID of the assigned ICP permit (if any) for one or more primary domains, add-on domains, or subdomains.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 
Request Packet Structure

A request XML packet getting information about the ICP permit status and the ICP permit ID of one or more domains or subdomains must include the get, dataset, and prefs operation nodes:

<packet>
   <site>
      <get>
         ...
         <dataset>
            <prefs />
         </dataset>
      </get>
   </site>
</packet>

For more information about the get node, including its graphical representation and the descriptions and properties of dependent nodes, click here.

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.

 
Response Packet Structure

The structure of the get node of the response packet is described here.

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.

 
Samples

The following packet retrieves the ICP permit information for the domain example.com.

<packet>
   <site>
      <get>
         <filter>
            <name>example.com</name>
         </filter>
         <dataset>
            <prefs />
         </dataset>
      </get>
   </site>
</packet>

Response:

<packet version="1.6.7.0">
   <site>
      <get>
         <result>
            <status>ok</status>
            <filter-id>example.com</filter-id>
            <id>5</id>
            <data>
               <gen_info>
                  <cr_date>2015-08-06</cr_date>
                  <name>example.com</name>
                  <ascii-name>example.com</ascii-name>
                  <status>0</status>
                  <real_size>0</real_size>
                  <dns_ip_address>10.58.70.125</dns_ip_address>
                  <htype>vrt_hst</htype>
                  <guid>FCB4F048-0B07-45EC-A22A-CF8145634A91</guid>
                  <webspace-guid>FCB4F048-0B07-45EC-A22A-CF8145634A91</webspace-guid>
                  <sb-site-uuid />
                  <webspace-id>5</webspace-id>
                  <description />
               </gen_info>
               <prefs>
                  <www>true</www>
                  <stat_ttl>3</stat_ttl>
                  <icp-status>true</icp-status>
                  <icp-permit>123456789</icp-permit>
               </prefs>
            </data>
         </result>
      </get>
   </site>
</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.