Updating Site Aliases Settings

The set operation is used to update settings of site aliases stored in Plesk database. You can update all settings of a site alias in bulk or specify some particular settings. To get information on which site alias settings can be updated on a particular server, use the get-supported-services operation.

For more information visit the Site Alias Settings section.

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>

 

The set node graphical representation is as follows:

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The set node of the output XML packet is structured as follows:

 

 

Samples

Updating settings of a single site alias

This packet sets up Web references between MyAlias.com and the primary site.

<packet>
<site-alias>
<set>
   <filter>
      <name>MyAlias.com</name>
   </filter>
   <settings>
      <pref>
          <web>1</web>
      </pref>
   </settings>
</set>
</site-alias>
</packet> 

Response:

<packet>
<site-alias>
<set>
   <result>
      <status>ok</status>
      <id>7</id>
   </result>
</set>
</site-alias>
</packet>
 
Updating settings of multiple site aliases

This packet switches off mail redirection from site aliases to the primary site MyPrimary.com.

<packet>
<site-alias>
<set>
   <filter>
      <site-name>MyPrimary.com</site-name>
   </filter>
   <settings>
      <pref>
          <web>1</web>
          <mail>0</mail>
          <tomcat>0</tomcat>
      </pref>
   </settings>
</set>
</site-alias>
</packet>

Response:

<packet>
<site-alias>
<set>
   <filter>
      <site-name>MyPrimary.com</site-name>
   </filter>
   <settings>
      <pref>
          <full/>
      </pref>
   </settings>
</set>
</site-alias>
</packet>