Get one maintenance window on a status page.

GET

/status_page/{status_page_id}/maintenance/{maintenance_id}

const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/maintenance/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/maintenance/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

maintenance_id

required

string format: uuid

Maintenance window identifier

Responses

200

The maintenance window

application/json

object

required

string format: uuid

status_page_id

required

string format: uuid

title

required

string

body

string | null

status

required

string

Allowed values: scheduled in_progress completed

scheduled_start_at

required

string format: date-time

scheduled_end_at

required

string format: date-time

affected_http_job_ids

required

Array<string>

whole_page

required

Covers the whole page; affected_http_job_ids is then empty.

boolean

created_at

required

string format: date-time

Example

{
  "status": "scheduled"
}

401

Missing or invalid authentication

404

Status page not found, or the window is not on it

500

Internal server error