SUsupercheck-io
Status Pages

Update a status page

Changed on

Update settings and/or status of a status page. Requires status_page:update. The body is strict: unknown fields, subdomain and customDomainVerified return 400, and an empty body returns 400 (No fields to update).

Order of work: when status is published, publish preconditions are checked first and nothing is written if they fail (the page must be accessible to your account and have at least one public component, otherwise 403 or 400). Then settings are saved, then the status is changed. If the status change fails after settings were saved, the error message says so.

Custom domains: setting a non-empty customDomain that differs from the current one resets verification and requires the feature to be available for your account (403 if not), a deployment configured for custom domains (400), a hostname outside the platform status page domain (400) and not used by another page (409).

put/api/status-pages/{id}

Request

  • Base URL
    https://demo.supercheck.dev
  • Auth
    HTTP bearer

Request body

namestring
headlinestring
pageDescriptionstring
supportUrlstring

Support contact: an email address or an http(s) URL. Empty string clears it.

timezonestring
languagestring

Public page language (ISO 639-1), for example en or pt-BR.

customDomainstring

Hostname for the public page, lower-cased by the server. Empty string removes it. Changing it resets verification (customDomainVerified becomes false). It must not use the platform status page domain or its subdomains, must not be used by another status page (409), and requires custom domains to be configured on the deployment (400) and available for your account (403).

allowPageSubscribersboolean
allowEmailSubscribersboolean
allowWebhookSubscribersboolean
allowSlackSubscribersboolean
allowIncidentSubscribersboolean
allowRssFeedboolean
cssBodyBackgroundColorstring

Hex color such as #1a2b3c.

cssFontColorstring

Hex color such as #1a2b3c.

cssLightFontColorstring

Hex color such as #1a2b3c.

cssGreensstring

Hex color such as #1a2b3c.

cssYellowsstring

Hex color such as #1a2b3c.

cssOrangesstring

Hex color such as #1a2b3c.

cssBluesstring

Hex color such as #1a2b3c.

cssRedsstring

Hex color such as #1a2b3c.

cssBorderColorstring

Hex color such as #1a2b3c.

cssGraphColorstring

Hex color such as #1a2b3c.

cssLinkColorstring

Hex color such as #1a2b3c.

cssNoDatastring

Hex color such as #1a2b3c.

status'draft' | 'published' | 'archived'

Lifecycle status. draft and archived unpublish the page. See the operation description for publish preconditions.

Response

Updated status page

Changes