Listing all redirect entries of a subdomain¶

Sends a GET request to the endpoint /domain/{domainId}/redirects/{vHostName}.

Description¶

The List-Redirects request allows the user to request a list of all redirect entries of a subdomain of the organisation.

Requirements¶

Values of the request: Domain-ID {domainId}, Subdomain name {vHostName}

Objects: none

Request¶

To request a list of all redirect entries of a subdomain, the Domain-ID {domainId} and the Subdomain name {vHostName} need to be added to the path of the request.

As a result, the user gets one or more objects DnsRedirectVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`source`	The path of a domain or subdomain that is to be redirected.	`string`
`destination`	The target to where the redirect pins.	`string`
`type`	The type of the redirect.	`permanent` -> HTTP status code 301 `redirect` -> HTTP status code 302
`subDomainName`	The name of the subdomain.	`string`
`matchingType`	The condition for the alignment.	`exact` `prefix` `suffix`
`expertMode`	The availability of the expert mode. If the expert mode is enabled, Myra skips the check of the rule for infinite loops.	`true` `false`
`sort`	The ascending order for the entry.	`integer`
`comment`	An individual comment for the entry.	`string`
`enabled`	The availability of the entry.	`true` `false`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "source": "string",
    "destination": "string",
    "type": "string",
    "subDomainName": "string",
    "matchingType": "string",
    "expertMode": true,
    "sort": 0,
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "string",
    "enabled": true
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.