Adding or changing error pages¶

Note

The selection attribute maps each subdomain name to a set of error codes, for example {"www.example.com": {"400": true, "500": true}}. Only error codes set to true are affected.

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

Description¶

The Save-Error-Pages request allows the user to add or change the error pages of one or more subdomains of a domain.

Requirements¶

Values of the request: Domain-ID {domainId}

Objects: ErrorPageUpdateVO

Request¶

To add or change error pages, the Domain-ID {domainId} needs to be added to the path of the request.

For a detailed specification of which information is required to add or change error pages, the object ErrorPageUpdateVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`pageContent`	The HTML content to set for the selected error pages.	`string`
`selection`	The subdomains and error codes the content is applied to. The attribute is keyed by subdomain name, then by error code, with a boolean that selects the error code.	`array`

Example¶

Example request body:

{
  "pageContent": "string",
  "selection": {
    "www.example.com": {
      "400": true,
      "500": 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.