Add Website Aliases (WSM 4.5.7.0+ only)
Adds aliases to a given website, ignoring any pre-existing aliases.
URL
/api/v1/website/[website_id]/aliases
HTTP Method
POST
URL Parameters
Parameter |
Required |
Type |
Description |
---|---|---|---|
website_id |
true |
integer |
Specifies the website ID to add aliases to. |
POST Parameters
POST takes a JSON array of strings containing new aliases. An empty array will do nothing successfully. Aliases which already exist for the given website will be ignored.
Response Parameters
Returns a string indicating success/error.
Example: Set Website Aliases
Request
/api/v1/website/[website_id]/aliases
curl -kv \
-u api_ninja:ninja_password \
-X PUT \
-H 'Content-Type: application/json' \
-d '[ "www.example.com", "another.example.com" ]' \
https://172.31.1.172:4849/api/v1/website/1/aliases
Response
{"result":"success"}