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.
Request Packet Structure
A request XML packet changing the site alias settings in the Plesk database includes the set operation node:
The set node graphical representation is as follows:
- The filter node specifies which site aliases will be affected. For more information, refer to the Available Filters section. Data type: DomainAliasFilterType (
- The settings node defines settings to be applied to these site aliases. For more information, please refer to the Site Alias Settings section. Data type: Settings (
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:
- The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (
- The status node is required. Specifies the execution status of the set operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It returns the error code when the set operation fails. Data type: unsignedInt.
- The errtext node is optional. It returns the error message if the set operation fails. Data type: string.
- The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Available Filters section. Data type:anySimple.
- The id node is optional. It returns the site alias ID; it is required if the alias id was specified in the request packet. Data type: integer.
Updating settings of a single site alias
This packet sets up Web references between MyAlias.com and the primary site.
Updating settings of multiple site aliases
This packet switches off mail redirection from site aliases to the primary site MyPrimary.com.