Listing all maintenance pages for a domain¶

Note

In the Myra App the placeholder twitter for X is still used.

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

Description¶

The List-Maintenance-Page request allows the user to request a list of all maintenance pages of a domain of the organisation.

Requirements¶

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

Objects: none

Request¶

To request a list of all maintenance pages of a domain, the Domain-ID {domainId} and the Subdomain name {vHostName} need to be added to the path of the HTTP request.

As a result, the user gets the objects MaintenanceVO with the requested information.

The object MaintenanceVO provides the following information:

Attributes	Description	Values
`fqdn`	The subdomain name to which the maintenance page is assigned.	`string`
`start`	The date as ISO 8601 when the maintenance page starts to be enabled.	`string($date-time)`
`end`	The date as ISO 8601 until the maintenance page is enabled.	`string($date-time)`
`content`	The content of the maintenance page as HTML. Note that no resources from the subdomain that has been set to maintenance mode can be included. If the maintenance page contains images, use a different domain or inline base64-encoded images.	`string`
`active`	The availability of the maintenance page.	`true` `false`
`defaultPage`	An array with defined default pages which should be used instead of an own content page.	Default page generated by Myra, link to an external page such as Facebook or X. One or more default pages can be used.
`vhostId`	The ID of the subdomain to which the maintenance page is assigned.	`integer`
`id`	The ID of the maintenance page.	`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",
    "fqdn": "string",
    "start": "string",
    "end": "string",
    "content": "string",
    "contentFrom": "string",
    "active": true,
    "defaultPage": "string",
    "vhostId": 0,
    "permissions": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "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.