Update a status page
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).
bearerAuthAuthorizationBearer <token>Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.
id*stringStatus page ID
uuidapplication/json- body
Any subset of the fields below; at least one is required. subdomain and customDomainVerified are managed by the server and rejected with 400.
name?string1 <= length <= 255headline?stringlength <= 255pageDescription?stringlength <= 2000supportUrl?stringSupport contact: an email address or an http(s) URL. Empty string clears it.
length <= 500timezone?stringlength <= 50language?stringPublic page language (ISO 639-1), for example en or pt-BR.
^[a-z]{2,3}(-[A-Z]{2})?$customDomain?stringHostname 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).
length <= 255allowPageSubscribers?booleanallowEmailSubscribers?booleanallowWebhookSubscribers?booleanallowSlackSubscribers?booleanallowIncidentSubscribers?booleanallowRssFeed?booleancssBodyBackgroundColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssFontColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssLightFontColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssGreens?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssYellows?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssOranges?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssBlues?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssReds?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssBorderColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssGraphColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssLinkColor?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$cssNoData?stringHex color such as #1a2b3c.
^#[0-9A-Fa-f]{6}$status?stringLifecycle status. draft and archived unpublish the page. See the operation description for publish preconditions.
"draft""published""archived"Updated status page
application/json- response
statusPage?curl -X PUT 'https://demo.supercheck.dev/api/status-pages/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'{ "statusPage": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "subdomain": "string", "status": "string", "pageDescription": "string", "allowRssFeed": true, "faviconLogo": "string", "transactionalLogo": "string", "heroCover": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}