URL Redirection

Get

Retrieve URL Redirection Settings.

GET/api/URLRedirectionSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

The site ID to which the URL redirection settings refer to.

defaultActionRedirectActionType (enum)

Redirect action type options

0 = DoNotRedirect,1 = Redirect

replicateboolean

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

urLsnullable array of URLRedirectEntry (object)

The URL redirect list.

Request

JavaScriptCurlPython

const response = await fetch('/api/URLRedirectionSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "defaultAction": [
    "0 = DoNotRedirect",
    "1 = Redirect"
  ],
  "replicate": false,
  "urLs": [
    {
      "enabled": false,
      "url": "text",
      "action": [
        "0 = DoNotRedirect",
        "1 = Redirect"
      ]
    }
  ]
}

Update

Modify URL Redirection Settings.

PUT/api/URLRedirectionSettings

Query parameters

Body

application/json; api-version=1.0

URL Redirection Settings.

defaultActionRedirectActionType (enum)

Redirect action type options

0 = DoNotRedirect,1 = Redirect

replicatenullable boolean

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

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/URLRedirectionSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}