Status Page Maintenances

Getting started

Webhooks

Audit logs

Deprecated endpoints

The status page maintenance object

component_maintenance_periods

object[]

required

A list of time periods where components were under maintenance during this status page maintenance window

Show child attributes

Example:

[
  {
    "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN",
    "end_at": "2021-08-17T13:28:57.801578Z",
    "start_at": "2021-08-17T13:28:57.801578Z"
  }
]

string

required

A unique ID for this status page maintenance window

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

maintenance_status

enum<string>

required

Current status for this maintenance window

Available options:

maintenance_scheduled,

maintenance_in_progress,

maintenance_complete

Example:

"maintenance_scheduled"

name

string

required

A title for the maintenance window

Example:

"Routine infrastructure upgrade"

published_at

string<date-time>

required

When this status page maintenance window was published to the status page

Example:

"2021-08-17T13:28:57.801578Z"

status_page_id

string

required

The ID of the corresponding status page

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

updates

object[]

required

A list of updates posted to this status page maintenance window

Show child attributes

Example:

[
  {
    "component_statuses": [
      {
        "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
        "component_status": "operational"
      }
    ],
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "maintenance_status": "maintenance_scheduled",
    "message": "abc123",
    "published_at": "2021-08-17T13:28:57.801578Z",
    "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1"
  }
]

Create

List

⌘I

{
  "component_maintenance_periods": [
    {
      "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN",
      "end_at": "2021-08-17T13:28:57.801578Z",
      "start_at": "2021-08-17T13:28:57.801578Z"
    }
  ],
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "maintenance_status": "maintenance_scheduled",
  "name": "Routine infrastructure upgrade",
  "published_at": "2021-08-17T13:28:57.801578Z",
  "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "updates": [
    {
      "component_statuses": [
        {
          "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
          "component_status": "operational"
        }
      ],
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "maintenance_status": "maintenance_scheduled",
      "message": "abc123",
      "published_at": "2021-08-17T13:28:57.801578Z",
      "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1"
    }
  ]
}

​The status page maintenance object

The status page maintenance object