Status Pages

Update a status page

put/api/{org_id}/status_pages/{id}

Request

Path parameters

org_idstring required

Organization name

idstring required

Resource id

Request body

accent_colorstring nullable
brand_namestring nullable
confirm_after_secsinteger nullable
confirm_failuresinteger nullable
confirm_recoveryinteger nullable
descriptionstring nullable
favicon_imgstring nullable

Base64-encoded browser-tab icon; gated like logo_img.

logo_imgstring nullable

Base64-encoded image. Enterprise-gated on write (see apply_logo_field); an already-set logo keeps rendering under a lapsed license or an OSS build.

namestring nullable
noindexboolean nullable
passwordstring nullable

Plaintext in; hashed at rest; never returned. Setting an empty string clears the password (visibility must then leave 2).

show_response_timeboolean nullable
show_timeline_barsboolean nullable
show_uptime_percentboolean nullable
visibilityinteger nullable

0 draft, 1 public, 2 password.

Response

Success

accent_colorstring nullable
brand_namestring nullable
component_countinteger required
confirm_after_secsinteger nullable
confirm_failuresinteger required
confirm_recoveryinteger required
created_atinteger required
descriptionstring nullable
favicon_imgstring nullable
health'operational' | 'no_data' | 'maintenance' | 'degraded' | 'partial_outage' | 'major_outage'

Component status by notice precedence: Major > Partial > Degraded > Maintenance > Operational. NoData is orthogonal (a dead probe is gray, not green — and not an outage either).

idstring required
logo_imgstring nullable
namestring required
noindexboolean required
ownerstring nullable
password_setboolean required
show_response_timeboolean required
show_timeline_barsboolean required
show_uptime_percentboolean required
slugstring required
tracking_sinceinteger nullable
updated_atinteger required
visibilityinteger required

Changes

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