STstatusstack

Create a new status override

post/v1/status-overrides

Request

  • Base URL
    https://statusstack.com/api
  • Auth
    HTTP bearer

Request body

component_idstring uuid required
stack_idstring uuid nullable

Stack to scope the override to. Only stack-scoped overrides are honoured on public surfaces (status page, embed, badge, public API); omitting this creates a dashboard-only override that is never displayed. Must belong to the API key's team, and the component must be attached to it.

status'operational' | 'degraded_performance' | 'under_maintenance' | 'major_outage' | 'ok' | 'up' | 'online' | 'clear' | 'degraded' | 'warning' | 'partial' | 'minor' | 'partial_outage' | 'outage' | 'down' | 'offline' | 'alert' | 'critical' | 'major' | 'maintenance' | 'info' required

The four canonical values — operational, degraded_performance, under_maintenance, major_outage — are what the override is stored and returned as. Every other value listed is a legacy spelling, accepted on the wire and normalised onto one of those four.

reasonstring nullable
expires_atstring date-time

Response

An override already existed for this component/stack pair and was updated in place rather than duplicated.

idstring uuid
component_idstring uuid
stack_idstring uuid nullable

Stack the override is scoped to. Null means dashboard-only; such an override is not shown on any public surface.

status'operational' | 'degraded_performance' | 'under_maintenance' | 'major_outage'
reasonstring nullable
expires_atstring date-time nullable

When the override lapses; null for one that stays until deleted.

created_atstring date-time
updated_atstring date-time

Changes

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