---
title: "List scheduled maintenance"
method: GET
path: "/status-pages/{statusPage}/maintenances"
tags: ["Scheduled maintenance"]
---

# List scheduled maintenance

`GET /status-pages/{statusPage}/maintenances`

## Request

- Base URL: `https://api.spectate.net/v1`
- URL: `https://api.spectate.net/v1/status-pages/{statusPage}/maintenances`
- Auth: HTTP bearer

Returns the page's maintenance, the latest planned start first.

## Path parameters

- `statusPage` string, uuid, required

## Query parameters

- `page` integer
- `per_page` integer
- `filter[status]` 'scheduled' | 'in_progress' | 'completed': Where a scheduled maintenance stands. | | |---| | `scheduled` <br/> Announced, not started yet. | | `in_progress` <br/> Going on: its components show as under maintenance. | | `completed` <br/> Over. |

## Response `200`

Paginated set of `ScheduledMaintenance`

- object
  - `current_page` integer, required
  - `data` ScheduledMaintenance[], required
    - `id` string, uuid, required: Maintenance ID
    - `title` string, required: Title shown on the page
    - `description` string, nullable, required: What happens and what visitors notice, in Markdown; `null` for none
    - `status` 'scheduled' | 'in_progress' | 'completed', required: Where a scheduled maintenance stands. | | |---| | `scheduled` <br/> Announced, not started yet. | | `in_progress` <br/> Going on: its components show as under maintenance. | | `completed` <br/> Over. |
    - `automatic` boolean, required: `true`: starts at `scheduled_at` and completes at `scheduled_until` by itself (without a planned end it is completed by hand). `false`: only changes when you set `status`
    - `mutes_alerts` boolean, required: `true`: while in progress, alerts on the monitors linked to its components are muted
    - `exclude_from_uptime` boolean, required: With `mutes_alerts`: failed checks of those monitors don't count as downtime
    - `scheduled_at` string, date-time, required: Planned start
    - `scheduled_until` string, date-time, nullable, required: Planned end; `null` for none
    - `started_at` string, date-time, nullable, required: When it actually went in progress; `null` before
    - `completed_at` string, date-time, nullable, required: When it completed; `null` before
    - `affected_components` StatusPageAffectedComponent[], required: Components it affects
      - `component` StatusPageComponentReference, required: A component of the status page.
        - `id` string, uuid, required: Component ID
        - `name` string, required: Component name
      - `impact` 'none' | 'degraded_performance' | 'partial_outage' | 'major_outage', required: An impact on a status page, including `none`: how an incident or maintenance affects a component, or an incident's overall impact. | | |---| | `none` <br/> No impact (for a component: not affected). | | `degraded_performance` <br/> Slower or less reliable than usual. | | `partial_outage` <br/> Down for some visitors or some functions. | | `major_outage` <br/> Down. |
    - `created_at` string, date-time, required: When it was created
  - `first_page_url` string, nullable, required
  - `from` integer, nullable, required
  - `last_page_url` string, nullable, required
  - `last_page` integer, required
  - `links` object[], required: Generated paginator links.
    - `url` string, nullable, required
    - `label` string, required
    - `active` boolean, required
  - `next_page_url` string, nullable, required
  - `path` string, nullable, required: Base path for paginator generated URLs.
  - `per_page` integer, required: Number of items shown per page.
  - `prev_page_url` string, nullable, required
  - `to` integer, nullable, required: Number of the last item in the slice.
  - `total` integer, required: Total number of items being paginated.

## Other responses

- `401`: `UNAUTHENTICATED`: no token was sent. `INVALID_TOKEN`: the token is unknown or revoked. `TOKEN_EXPIRED`: the token has expired.
- `403`: `FORBIDDEN`: the token lacks an ability this endpoint requires (listed in `details.required_abilities`). `TEAM_PENDING_DELETION`: the team is scheduled for deletion. `TEAM_SUSPENDED`: Spectate suspended the team.
- `404`: `RESOURCE_NOT_FOUND`: there is no such resource in this team.
- `429`: `RATE_LIMITED`: too many requests for this token. Wait for the number of seconds in `Retry-After`.

---

[API](https://skmtc.dev/spectate/apis/spectate-api.md) - [All operations](https://skmtc.dev/spectate/apis/spectate-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spectate/apis/spectate-api/revisions/9b1a233997de?raw)