Skip to main content

The status page maintenance update object

component_statuses
object[]
required

The updated statuses of affected components

Example:
[
{
"component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
"component_status": "operational"
}
]
id
string
required

A unique ID for this status page maintenance update

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"

message
string
required

Markdown update on what's changed about this status page maintenance window

Example:

"abc123"

published_at
string<date-time>
required

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

Example:

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

status_page_maintenance_id
string
required

The ID of the corresponding status page maintenance window

Example:

"01FCNDV6P870EA6S7TK1DSYDG1"