Skip to Content
Uptimeify Docs
Status pages

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)

FieldTypeDescription
customerIdnumber|nullMove 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.
includeCustomerMonitorsbooleanShow every monitor of the customer, except those in hiddenMonitors, automatically after the explicit components. A change of customerId leaves it as it is.
managementTypestringmanaged or self_service. Only organization admins without a customer binding may change it (403 managementTypeOrgOnly otherwise).
namestringDisplay name (1-120 chars)
slugstringURL slug (1-120 chars, 409 on conflict)
descriptionstring|nullDescription (max 1000 chars). null clears it.
visibilitystringpublic, 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)
accessPasswordstringSets 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.
ipAllowlistarrayReplaces the IP allowlist: IPv4/IPv6 addresses or CIDR ranges, at most 50, stored as addr/prefix. [] removes the restriction.
audienceGroupsarrayReplaces all audience groups, at most 20: [{ "name", "emailDomains", "componentIds" }]. [] removes them. See below.
isPublishedbooleanPublish or unpublish the page
showRecentIncidentsbooleanShow recent incidents section
showRecentMaintenancebooleanShow recent maintenance section
smsSubscriptionsEnabledbooleanOffer 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.
pushSubscriptionsEnabledbooleanOffer browser push subscriptions on the public page (default false). Switching it off stops push to existing push subscribers too.
monitorUpdatesEnabledbooleanMonitors 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).
designConfigobjectVisual design settings (layout, colors, typography, …). See Update Status Page Design for all fields.
hiddenMonitorsarrayMonitors 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 answers 401 passwordRequired. Switching to password_protected needs accessPassword only while the page has no stored password yet (hasPassword: false); otherwise the request is rejected with 400 passwordRequired.
  • sso_members_only: like customer_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 answers 401 ssoRequired. While your organization has no verified SSO, the value is rejected with 400 ssoNotConfigured.
  • ipAllowlist applies on top of every visibility: visitors from other networks get 403 statusPageIpNotAllowed. The address that counts is the one our reverse proxy sees; an X-Forwarded-For header sent by the client does not count. An invalid entry is rejected with 400 (invalidRequestBody).
  • audienceGroups (PATCH only): each group has a name (1-80 chars), emailDomains (1-20 domains, stored lowercase) and componentIds (1-100 components of this page, numeric id or publicId; 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, ipAllowlist and audienceGroups replace the stored value in full.
  • A page with ipAllowlist or audienceGroups, like every page whose visibility is not public, has no badge, no embed widget, no Atom/RSS feeds and accepts no subscriptions (these addresses answer 404 like 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 Unauthorized when not authenticated
  • 400 Bad Request (statusPageComponentMonitorCustomerMismatch) when the new customer does not own all monitor components of the page
  • 403 Forbidden (forbidden) when an organization-wide caller has neither the role admin nor editor, or for a global supporter
  • 403 Forbidden (forbidden) when a customer-bound readonly user or a token issued by one sends designConfig, showRecentIncidents or showRecentMaintenance: the design needs the role admin or editor
  • 403 Forbidden (managed_by_organization) when a customer-bound user or token changes a managed page without the customer's canEditManaged exception
  • 403 Forbidden (managementTypeOrgOnly) when anyone but an organization admin without a customer binding changes managementType
  • 403 Forbidden (smsQuotaRequired) when smsSubscriptionsEnabled is 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, with data.max) when customerId moves the page to a customer whose package allows no more status pages
  • 403 Forbidden (forbidden) when a customer-scoped user or token edits a page without a customer, sends customerId: null or names a customer outside its scope
  • 404 Not Found (customerNotFound) when customerId is not a customer of your organization
  • 404 Not found when the status page does not exist
  • 409 Conflict when slug is already taken
  • 400 Bad Request (passwordRequired) when the page is or becomes password_protected, has no stored password and accessPassword is missing
  • 400 Bad Request (invalidRequestBody) when accessPassword is shorter than 8 or longer than 200 characters
  • 400 Bad Request (ssoNotConfigured) when visibility is switched to sso_members_only and your organization has no verified single sign-on
  • 400 Bad Request (invalidRequestBody) when an ipAllowlist entry is not an IPv4/IPv6 address or CIDR range, or ipAllowlist or audienceGroups exceed their limits
  • 400 Bad Request (statusPageComponentNotFound) when an audienceGroups entry names a component that is not on this page

Response

Returns the updated status page object. See Error Codes for error responses.

On this page