SPspectate
Scheduled maintenance

Update scheduled maintenance

Changes only the fields you send; affected_components replaces the list. Setting status to in_progress or completed (or setting completed_at) emails confirmed subscribers unless notify_subscribers is false; other changes are silent.

patch/status-pages/{statusPage}/maintenances/{maintenance}

Request

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

Path parameters

statusPagestring uuid required

Status page ID.

maintenancestring uuid required

Maintenance ID.

Request body

titlestring

Title shown on the page, up to 255 characters

descriptionstring nullable

What happens and what visitors notice, in Markdown; null for none

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.
automaticboolean

true: starts and completes on schedule. false: only changes when you set status

mutes_alertsboolean

true: while in progress, mute alerts on the monitors linked to its components

exclude_from_uptimeboolean

With mutes_alerts: failed checks of those monitors don't count as downtime

scheduled_atstring date-time

Planned start

scheduled_untilstring date-time nullable

Planned end; null for none

completed_atstring date-time nullable

When it completed. Setting it completes the maintenance

notify_subscribersboolean

Email confirmed subscribers when this starts or completes the maintenance (default true)

Example request

{
  "title": "Database upgrade",
  "description": "The API is read-only for about ten minutes."
}

Response

The updated maintenance.

idstring uuid required

Maintenance ID

titlestring required

Title shown on the page

descriptionstring 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.
automaticboolean 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_alertsboolean required

true: while in progress, alerts on the monitors linked to its components are muted

exclude_from_uptimeboolean required

With mutes_alerts: failed checks of those monitors don't count as downtime

scheduled_atstring date-time required

Planned start

scheduled_untilstring date-time nullable required

Planned end; null for none

started_atstring date-time nullable required

When it actually went in progress; null before

completed_atstring date-time nullable required

When it completed; null before

created_atstring date-time required

When it was created

Example response

{
  "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.