Domain Alias¶
The create operation of the site-alias
operator enables you to
create a domain alias belonging to an existing subscription, set the ICP
permit status, and assign an ICP permit ID to the domain alias.
Request Packet Structure¶
To create a domain alias and set the ICP permit information for it, use
the create operation of the site-alias
operator with the
pref, icp-status, and icp-permit nodes.
<packet>
<site-alias>
<create>
...
<pref>
<icp-status>false</icp-status>
<icp-permit>123456789</icp-permit>
</pref>
</create>
</site-alias>
</packet>
For more information about the create 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 create 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 creates a domain alias named sample.com for the example.com domain, grants it the “ICP permit approved” status, and assigns the ICP permit “123456789” to it:
<packet>
<site-alias>
<create>
<pref>
<icp-status>true</icp-status>
<icp-permit>123456789</icp-permit>
</pref>
<site-id>2</site-id>
<name>sample.com</name>
</create>
</site-alias>
</packet>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
<site-alias>
<create>
<result>
<status>ok</status>
<id>1</id>
</result>
</create>
</site-alias>
</packet>