URL Redirection | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve URL Redirection Settings.

Query parameters

siteIdinteger · int32optional

The Site ID for which to retrieve the URL RedirectionSettings. (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/URLRedirectionSettings'

200

401

404

{
  "siteId": 1,
  "defaultAction": [
    "0 = DoNotRedirect",
    "1 = Redirect"
  ],
  "replicate": true,
  "urLs": [
    {
      "id": 1,
      "priority": 1,
      "enabled": true,
      "url": "text",
      "action": [
        "0 = DoNotRedirect",
        "1 = Redirect"
      ]
    }
  ]
}

Success

Update

put

Modify URL Redirection Settings.

Query parameters

siteIdinteger · int32optional

The Site ID for which to modify the URL Redirection Settings. (optional)

Body

Update the URL redirection settings

defaultActionstring · enumoptional

Redirect action type options

Available options:

replicateboolean | nullableoptional

Whether the 'Replicate Settings' option is enabled or not.