|docs
Start Trial
REST APIMaintenance windows

List maintenance windows

List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the API Concepts Document

Scoped OAuth requires: services.read

Authorization

api_key
Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

query?string

Filters the result, showing only the records whose name matches the query.

limit?integer

The number of results per page.

offset?integer

Offset to start pagination search results.

total?boolean

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated.

See our Pagination Docs for more information.

Defaultfalse
team_ids[]?array<string>

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

service_ids[]?array<string>

An array of service IDs. Only results related to these services will be returned.

include[]?string

Array of additional Models to include in response.

Value in

  • "teams"
  • "services"
  • "users"
filter?string

Only return maintenance windows in a given state.

Value in

  • "past"
  • "future"
  • "ongoing"
  • "open"
  • "all"

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"
Content-Type*"application/json"
Default"application/json"

Value in

  • "application/json"

Response Body

application/json

application/json

application/json

application/json

application/json

Get a maintenance window GET

Get an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.read`

Update a maintenance window PUT

Update an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`