Listing all error pages of a domain¶

Note

The list response always returns an empty content for each error page. To request the actual content of a single error page, use the Get-Error-Page request.

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

Description¶

The List-Error-Pages request allows the user to request a list of all error pages configured for the subdomains of a domain.

Requirements¶

Values of the request: Domain-ID {domainId}

Objects: none

Request¶

To request a list of all error pages, the Domain-ID {domainId} needs to be added to the path of the request.

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

The object provides the following information:

Attributes	Description	Values
`subDomainName`	The name of the subdomain the error page belongs to.	`string`
`errorCode`	The error code the error page is shown for. The value `9999` represents blocked requests.	`400` `404` `405` `429` `500` `502` `503` `504` `9999`
`permissions`	The actions the requesting user is allowed to perform on the entry, for example `edit`.	`array`
`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",
    "subDomainName": "string",
    "errorCode": 0,
    "content": "",
    "permissions": [],
    "id": 0,
    "modified": "string",
    "created": "string"
  }
]

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.