v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Status Pages

List maintenances

Lists all maintenances for the organization. Optionally filter by status and page.

get/api/v2/statuspages/maintenances

Query parameters

filter[page_id]string

Optional page id filter.

page[offset]integer

Offset to use as the start of the page.

page[limit]integer

The number of maintenances to return per page.

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

filter[status]string

Optional maintenance status filter. Supported values: scheduled, in_progress, completed.

sortstring

Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, start_date, -start_date.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "components_affected": [
          {
            "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
            "status": "operational"
          }
        ],
        "updates": [
          {
            "components_affected": [
              {
                "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
                "status": "operational"
              }
            ]
          }
        ]
      },
      "relationships": {
        "created_by_user": {
          "data": {
            "type": "users"
          }
        },
        "last_modified_by_user": {
          "data": {
            "type": "users"
          }
        },
        "status_page": {
          "data": {
            "type": "status_pages"
          }
        }
      },
      "type": "maintenances"
    }
  ],
  "included": [
    {
      "type": "users"
    }
  ],
  "meta": {
    "page": {
      "first_offset": 0,
      "last_offset": 900,
      "limit": 100,
      "next_offset": 100,
      "offset": 0,
      "prev_offset": 100,
      "total": 1000,
      "type": "offset_limit"
    }
  }
}