Domain Alias

The set operation of the site-alias operator enables you to update the information about the ICP permit status and the ID of the assigned ICP permit for one or more domain aliases.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 
Request Packet Structure

A request XML packet changing the site alias settings in the Plesk database includes the set operation node:

<packet>
   <site-alias>
      <set>...</set>
   </site-alias>
</packet>

For more information about the set 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 set 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 grants the "ICP permit approved" status and assign the ICP permit "123456789" to the domain alias sample.com:

<packet>
   <site-alias>
      <set>
         <filter>
            <name>sample.com</name>
         </filter>
         <settings>
            <pref>
               <icp-status>true</icp-status>
               <icp-permit>123456789</icp-permit>
            </pref>
         </settings>
      </set>
   </site-alias>
</packet>

Response:

<packet>
   <site-alias>
      <set>
         <result>
            <status>ok</status>
            <filter-id>sample.com</filter-id>
            <id>1</id>
         </result>
      </set>
   </site-alias>
</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.