The get operation of the site-alias 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 domain aliases.

Request Packet Structure

A request XML packet retrieving a site alias settings from Plesk database includes the get operation node:

<packet>
   <site-alias>
      <get>...</get>
   </site-alias>
</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 alias sample.com.

<packet>
   <site-alias>
      <get>
         <filter>
            <name>sample.com</name>
         </filter>
      </get>
   </site-alias>
</packet>

Response:

<packet>
   <site-alias>
      <get>
         <result>
            <status>ok</status>
            <filter-id>sample.com</filter-id>
            <id>1</id>
            <info>
               <status>0</status>
               <pref>
                  <web>true</web>
                  <mail>true</mail>
                  <tomcat>false</tomcat>
                  <seo-redirect>true</seo-redirect>
                  <icp-status>true</icp-status>
                  <icp-permit>123456789</icp-permit>
               </pref>
               <manage-dns>true</manage-dns>
               <site-id>3</site-id>
               <name>sample.com</name>
               <ascii-name>sample.com</ascii-name>
            </info>
         </result>
      </get>
   </site-alias>
</packet>