Skip to Content
Uptimeify Docs
Status pages

Create Status Page

Creates a new status page. Requires the role `admin` or `editor`; customer-bound users and tokens (also `readonly`) create self-service pages of their customers.

POST /api/status-pages

Request Body

FieldTypeRequiredDefaultDescription
customerIdnumberNo-Customer ID (must belong to your organization). Omit it for a page of the whole organization, without a customer; only organization-wide roles and API tokens may create one.
includeCustomerMonitorsbooleanNofalseShow every monitor of the customer, except those in hiddenMonitors, automatically after the explicit components, including monitors created later. Has no effect on a page without a customer. Until 28 October 2026 the default was true for a page with a customer; send true to keep that behavior.
managementTypestringNomanagedmanaged or self_service, like monitors. Only organization admins may choose it; customer-bound users and tokens always create self_service pages.
namestringYes-Display name (1-120 chars). Slug auto-generated from name.
slugstringNoautoURL slug (1-120 chars, auto-normalized to lowercase-hyphens)
descriptionstringNonullDescription (max 1000 chars)
visibilitystringNopublicpublic, 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)
accessPasswordstringNo-Page password, 8-200 characters. Required with visibility: password_protected. Write-only: stored as a bcrypt hash and never returned; status page responses only show hasPassword and accessPasswordSetAt.
ipAllowlistarrayNo[]IPv4/IPv6 addresses or CIDR ranges (e.g. 203.0.113.0/24, 2001:db8::/32), at most 50. Only visitors from these networks see the page, on top of visibility. Stored normalized as addr/prefix (203.0.113.7 becomes 203.0.113.7/32), duplicates removed. [] = no IP restriction.
isPublishedbooleanNotrueWhether the page is publicly visible
smsSubscriptionsEnabledbooleanNofalseOffer SMS subscriptions on the public page. Each SMS draws on your organization's SMS quota and stops at its SMS safety cap. Needs SMS quota (403 smsQuotaRequired otherwise). Shown to visitors only while the platform can send SMS and your organization has SMS quota.
pushSubscriptionsEnabledbooleanNofalseOffer browser push subscriptions on the public page. Shown to visitors only while the platform has VAPID keys.
customDomainHostnamestringNonullCustom domain (3-253 chars). Creates a pending DNS verification record.
hiddenMonitorsarrayNo[]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.

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. Creating a page with password_protected and without accessPassword 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.

Example (cURL)

curl -X POST "$BASE_URL/api/status-pages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 5,
    "name": "Production Status",
    "description": "Real-time status of our production services",
    "visibility": "public",
    "hiddenMonitors": [{ "type": "http", "id": 42 }]
  }'

Response

{
  "statusPage": {
    "id": 1,
    "publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organizationId": 1,
    "customerId": 5,
    "includeCustomerMonitors": true,
    "managementType": "managed",
    "name": "Production Status",
    "slug": "production-status",
    "description": "Real-time status of our production services",
    "visibility": "public",
    "isPublished": true,
    "showRecentIncidents": false,
    "showRecentMaintenance": false,
    "customDomainId": null,
    "ipAllowlist": [],
    "audienceGroups": [],
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z"
  },
  "dns": null
}

If customDomainHostname is provided, the response includes DNS verification instructions:

{
  "dns": {
    "txtName": "_verify-status.status.deinkunde.com",
    "txtValue": "abc123-def456-ghi789"
  }
}

The page starts without components. Add them with Create Status Page Component.

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.

Common errors

  • 401 Unauthorized when not authenticated
  • 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 showRecentIncidents or showRecentMaintenance: the design needs the role admin or editor
  • 403 Forbidden (selfServiceNotAllowed) when a customer-bound user or token creates a page and the customer's package does not allow self-service
  • 403 Forbidden (forbidden) when a customer-scoped user or token omits customerId or names a customer outside its scope
  • 404 Not Found (customerNotFound) when customerId is not a customer of your organization
  • 403 Forbidden (statusPagesModuleDisabled) when the status pages module is not activated
  • 409 Conflict when slug is already taken
  • 409 Conflict (statusPageLimitReached, with data.max) when the customer's package allows no more status pages (maxStatusPages); pages without a customer are unlimited
  • 403 Forbidden (smsQuotaRequired) when smsSubscriptionsEnabled is true and your organization cannot send an SMS right now (no included SMS left, overage off or the SMS safety cap reached)
  • 400 Bad Request (passwordRequired) when visibility is password_protected 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 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 the list has more than 50 entries

On this page