Update Status Page
Updates a status page. At least one field must be provided. Requires the role `admin` or `editor`; customer-bound users and tokens (also `readonly`) update self-service pages of their customers.
PATCH /api/status-pages/:id
Request Body (all optional)
| Field | Type | Description |
|---|---|---|
customerId | number|null | Move the page to another customer of your organization. null detaches it from its customer (page of the whole organization); only organization-wide roles and API tokens may do that. |
includeCustomerMonitors | boolean | Show every monitor of the customer, except those in hiddenMonitors, automatically after the explicit components. A change of customerId leaves it as it is. |
managementType | string | managed or self_service. Only organization admins without a customer binding may change it (403 managementTypeOrgOnly otherwise). |
name | string | Display name (1-120 chars) |
slug | string | URL slug (1-120 chars, 409 on conflict) |
description | string|null | Description (max 1000 chars). null clears it. |
visibility | string | public, customer_members_only, password_protected (anyone with the page password, see below) or sso_members_only (like customer_members_only, and the session must come from your organization's single sign-on) |
accessPassword | string | Sets a new page password (8-200 characters). Required when the page becomes password_protected and has no password yet; otherwise omit it to keep the current one. A new password logs out every visitor who unlocked the page. The password cannot be removed: switching to another visibility keeps it stored (hasPassword stays true) and switching back reuses it. Never returned; the response shows hasPassword and accessPasswordSetAt. |
ipAllowlist | array | Replaces the IP allowlist: IPv4/IPv6 addresses or CIDR ranges, at most 50, stored as addr/prefix. [] removes the restriction. |
audienceGroups | array | Replaces all audience groups, at most 20: [{ "name", "emailDomains", "componentIds" }]. [] removes them. See below. |
isPublished | boolean | Publish or unpublish the page |
showRecentIncidents | boolean | Show recent incidents section |
showRecentMaintenance | boolean | Show recent maintenance section |
smsSubscriptionsEnabled | boolean | Offer SMS subscriptions on the public page (default false). Switching it off stops SMS to existing SMS subscribers too. Switching it on needs SMS quota (403 smsQuotaRequired otherwise); a page that already has it on keeps it. |
pushSubscriptionsEnabled | boolean | Offer browser push subscriptions on the public page (default false). Switching it off stops push to existing push subscribers too. |
monitorUpdatesEnabled | boolean | Monitors write to this page (default true): their state sets components and the page status, monitoring incidents show in the history and reach subscribers. false: the page only shows what you report or explicitly link (linked incidents, maintenance, Incident Management rules). |
designConfig | object | Visual design settings (layout, colors, typography, …). See Update Status Page Design for all fields. |
hiddenMonitors | array | Monitors to hide from this status page. Each entry is { "type": "http"|"dns"|"icmp"|"smtp"|"ssh"|"ftp"|"imap_pop", "id": <monitor id> }. Omit or send [] to show all monitors (the default). Monitors added later appear automatically. Maximum 500 entries. |
When present, hiddenMonitors replaces the stored list in full; omit the field to leave it unchanged; send [] to show all monitors again.
Private pages (since 28 October 2026).
password_protected: anyone who knows the page password sees the page. Visitors unlock it with the verify-password endpoint, which sets an access cookie for 30 days; without it the public page answers401 passwordRequired. Switching topassword_protectedneedsaccessPasswordonly while the page has no stored password yet (hasPassword: false); otherwise the request is rejected with400 passwordRequired.sso_members_only: likecustomer_members_only(signed-in members of the customer, or of the organization for a page without a customer), and the session must have been created through your organization's single sign-on (OIDC or SAML). Not signed in, or signed in without SSO, the public page answers401 ssoRequired. While your organization has no verified SSO, the value is rejected with400 ssoNotConfigured.ipAllowlistapplies on top of every visibility: visitors from other networks get403 statusPageIpNotAllowed. The address that counts is the one our reverse proxy sees; anX-Forwarded-Forheader sent by the client does not count. An invalid entry is rejected with400(invalidRequestBody).audienceGroups(PATCH only): each group has aname(1-80 chars),emailDomains(1-20 domains, stored lowercase) andcomponentIds(1-100 components of this page, numeric id orpublicId; stored as numeric ids). A component listed in a group is shown on the public page only to visitors signed in with a verified email address of one of that group's domains (exactly that domain, subdomains do not match) and to admins and editors of the page. Components in no group are shown to everyone who may view the page. Incidents and maintenance that only affect hidden components are left out for that visitor too, and the overall status is computed from what the visitor sees.- When present,
ipAllowlistandaudienceGroupsreplace the stored value in full. - A page with
ipAllowlistoraudienceGroups, like every page whose visibility is notpublic, has no badge, no embed widget, no Atom/RSS feeds and accepts no subscriptions (these addresses answer404like a missing page). Existing subscribers of such a page receive no more notifications.
Moving the page to another customer is rejected with 400 (statusPageComponentMonitorCustomerMismatch) while the page has monitor components of a different customer; delete those components first. Components themselves are managed with the component endpoints.
Compatibility: since 27 October 2026 customerId can be null in responses (a page of the whole organization, without a customer), together with customerPublicId and customerName where present. A client that assumes customerId is always a number must handle null.
Example (cURL)
curl -X PATCH "$BASE_URL/api/status-pages/1" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Status - Updated",
"isPublished": true,
"showRecentIncidents": true,
"hiddenMonitors": [{ "type": "http", "id": 42 }]
}'Common errors
401 Unauthorizedwhen not authenticated400 Bad Request(statusPageComponentMonitorCustomerMismatch) when the new customer does not own all monitor components of the page403 Forbidden(forbidden) when an organization-wide caller has neither the roleadminnoreditor, or for a global supporter403 Forbidden(forbidden) when a customer-boundreadonlyuser or a token issued by one sendsdesignConfig,showRecentIncidentsorshowRecentMaintenance: the design needs the roleadminoreditor403 Forbidden(managed_by_organization) when a customer-bound user or token changes amanagedpage without the customer'scanEditManagedexception403 Forbidden(managementTypeOrgOnly) when anyone but an organization admin without a customer binding changesmanagementType403 Forbidden(smsQuotaRequired) whensmsSubscriptionsEnabledis switched on and your organization cannot send an SMS right now (no included SMS left, overage off or the SMS safety cap reached)409 Conflict(statusPageLimitReached, withdata.max) whencustomerIdmoves the page to a customer whose package allows no more status pages403 Forbidden(forbidden) when a customer-scoped user or token edits a page without a customer, sendscustomerId: nullor names a customer outside its scope404 Not Found(customerNotFound) whencustomerIdis not a customer of your organization404 Not foundwhen the status page does not exist409 Conflictwhen slug is already taken400 Bad Request(passwordRequired) when the page is or becomespassword_protected, has no stored password andaccessPasswordis missing400 Bad Request(invalidRequestBody) whenaccessPasswordis shorter than 8 or longer than 200 characters400 Bad Request(ssoNotConfigured) whenvisibilityis switched tosso_members_onlyand your organization has no verified single sign-on400 Bad Request(invalidRequestBody) when anipAllowlistentry is not an IPv4/IPv6 address or CIDR range, oripAllowlistoraudienceGroupsexceed their limits400 Bad Request(statusPageComponentNotFound) when anaudienceGroupsentry names a component that is not on this page
Response
Returns the updated status page object. See Error Codes for error responses.
Remove Custom Domain from Status Page
Removes a custom domain from a status page. Deletes the domain record; the status page's customDomainId is automatically set to null. Organization-wide: admin or editor; customer-bound: by the page's ownership class.
Update Status Page Design
Updates the visual design configuration of a status page. Only the fields you provide are changed. All other settings keep their current values. Requires the role `admin` or `editor`; `readonly` can read the design but not change it.