SPspectate
Scheduled maintenance

List scheduled maintenance

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

get/status-pages/{statusPage}/maintenances

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Maintenances per page, 1 to 100.

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.

Only maintenance with this status.

Response

Paginated set of ScheduledMaintenance

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "title": "Database upgrade",
      "description": "The API is read-only for about ten minutes.",
      "affected_components": [
        {
          "component": {
            "name": "API"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.