SPspectate
Maintenance windows

Create a maintenance window

One-off with starts_at and ends_at, or weekly with schedule. Targets must belong to the team (422 otherwise).

post/maintenance-windows

Request

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

Request body

namestring required

Name, up to 255 characters

reasonstring nullable

Why, for the team; up to 500 characters

starts_atstring date-time nullable

A one-off window's start

ends_atstring date-time nullable

A one-off window's end, after starts_at and in the future

repeat_untilstring date nullable

A weekly window's last date, in its time zone

covers_everythingboolean

true: covers everything in the team. Default false

exclude_from_uptimeboolean

false: failed checks during the window count as downtime. Default true

Example request

{
  "name": "Sunday deploys",
  "schedule": {
    "timezone": "Europe/Amsterdam",
    "days": [
      7
    ],
    "start_time": "02:00",
    "end_time": "04:00"
  }
}

Response

The new window.

idstring uuid required

Window ID

namestring required

Name

reasonstring nullable required

Why, for the team; null for none

starts_atstring date-time nullable required

A one-off window's start; null for a weekly window

ends_atstring date-time nullable required

A one-off window's end; null for a weekly window

repeat_untilstring date nullable required

A weekly window's last date, in its time zone; null for no last date

covers_everythingboolean required

true: covers everything in the team, and targets is ignored

exclude_from_uptimeboolean required

true: failed checks during the window don't count as downtime

activeboolean required

true while it runs

paused_atstring date-time nullable required

When it was paused; null if it isn't. A paused window covers nothing

next_start_atstring date-time nullable required

When the current or next occurrence starts; null when none is to come

current_end_atstring date-time nullable required

When the running occurrence ends; null when it isn't running

created_atstring date-time required

When it was created

Example response

{
  "name": "Sunday deploys",
  "schedule": {
    "timezone": "Europe/Amsterdam",
    "days": [
      7
    ],
    "start_time": "02:00",
    "end_time": "04:00"
  }
}

Changes

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