Status Pages
Create and manage public status pages that display the operational status of your monitored websites, recent incidents, and maintenance windows.
Status pages can be public (accessible by anyone) or restricted to customer members. Custom domains are supported with DNS verification.
Authentication
All examples assume a bearer token:
BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"Endpoints
- List Status Pages
- Create Status Page
- Update Status Page
- Delete Status Page
- Get Public Status Page
- Get Status Page
- Get Status Page Design
- Update Status Page Design
- List Status Page Subscribers
- Delete Status Page Subscriber
- Export Status Page Subscribers
- Add Custom Domain
- Get Status Page Domain
- Status Page Domain Diagnostics
- Remove Custom Domain
- Verify Status Page Domain
- Activate Status Page Domain
- Get Status Page Module
- Activate Status Page Module
- List Status Page Components
- Create Status Page Component
- Update Status Page Component
- Delete Status Page Component
- Reorder Status Page Components
- List Status Page Component Groups
- Create Status Page Component Group
- Update Status Page Component Group
- Delete Status Page Component Group
- List Status Page Maintenance
- Schedule Status Page Maintenance
- Get Status Page Maintenance
- Update Status Page Maintenance
- Delete Status Page Maintenance
- Cancel Status Page Maintenance
- Complete Status Page Maintenance
- Post Status Page Maintenance Update
- List Status Page Templates
- Create Status Page Template
- Get Status Page Template
- Update Status Page Template
- Delete Status Page Template
Customer, components and groups
A status page belongs either to one customer (customerId) or, without a customer (customerId: null), to the whole organization. Only organization-wide roles and API tokens see and manage a page without a customer: customer-scoped users and tokens do not get it in lists and are answered 403 on its component and group endpoints.
What a page shows:
- Components: explicit rows, each either a monitor (
sourceKind: monitor) or a manually maintained entry (sourceKind: manual), optionally bundled in groups. - Customer monitors: with
includeCustomerMonitors: true, every monitor of the page's customer except those inhiddenMonitorsappears automatically after the components. Defaultfalsefor a new page (until 28 October 2026:truefor a page with a customer), so a new monitor never becomes public without being chosen; existing pages keep their stored value.
On a page with a customer, monitor components must be monitors of that customer; on a page without a customer, any monitor of the organization. Deleting a monitor removes its components automatically.
Scheduled maintenance
Announce planned work on your status pages: a maintenance has a title, a description, a start and an end, and covers whole pages or single components of any source (manual, monitor, third-party). It starts and ends by itself; while it runs, its components show maintenance. Subscribers get an announcement, an optional reminder, optional start and the end message, plus your updates. Monitor maintenance windows from monitoring (which also pause alerts) keep appearing on pages with those monitors and stay in monitoring.
Managed and self-service
Like a monitor, a page with a customer has an ownership class, managementType: managed (default, the organization operates the page) or self_service (the customer operates it). Organization-wide admins and editors change every page. Customer-bound users (also with the role readonly) and customer-bound API tokens change only self_service pages of their customers (settings, components, groups), unless the customer has the canEditManaged exception; a managed page answers 403 with data.code: managed_by_organization. They create pages as self_service only, and only if the customer's package or the customer allows self-service (403 selfServiceNotAllowed otherwise). Only organization admins set or change managementType (403 managementTypeOrgOnly). The design stays with the roles admin and editor: readonly reads it on every page in scope but does not change it, not on its own self_service pages either.
Who may change a status page
One rule covers a page and everything that hangs off it: settings, components and groups, custom domain, subscribers (reading them too, they are personal data), incidents and maintenance on the page.
- Organization-wide callers (organization users and organization API tokens): role
adminoreditor. Organization-widereadonlyonly reads and gets403 forbidden. - Customer-bound callers (customer users, also with the role
readonly, and customer-bound API tokens): the page'smanagementTypedecides, not the role.self_servicepages yes;managedpages only if the customer has thecanEditManagedexception; otherwise403withdata.code: managed_by_organization. This applies to a customer-boundeditortoo. - An incident or a maintenance must pass for every page it is linked to (when created: every page in
statusPageIds). One linked to no page keeps the role rule (adminoreditor).
Exceptions: deleting a page stays role based (readonly never deletes) on top of the ownership class; verifying and activating a custom domain needs admin for organization-wide callers; templates and the module stay with organization admins. canEdit in List Status Pages and Get Status Page tells you in advance whether this rule lets you change a page.
A customer user who may not change a page asks the organization instead with Create Status Page Change Request, which is also how a customer asks the organization to take a self_service page over.
Module and limits
Status pages are a module each organization activates once with Activate Status Page Module. While it is off, every endpoint on this page answers 403 with data.code: statusPagesModuleDisabled, except Get Status Page Module, the activation itself and the public endpoints.
An organization can have any number of status pages. A customer's package can cap the status pages per customer (maxStatusPages in the package config, null = unlimited); creating one more page for that customer, or moving a page to them, answers 409 with data.code: statusPageLimitReached and the limit in data.max. Pages without a customer never count. A page has at most 500 components and at most 500 groups; one more answers the same code, with the limit in data.max. Audience groups have their own limits: at most 20 per page, each with at most 20 email domains and at most 100 components. More answers 400 (invalidRequestBody).
The public endpoints, the RSS feed and custom domains answer 404 (statusPageNotFound) for a page whose organization is suspended or deleted or has the module switched off, exactly as for an unpublished page. Subscribers of such a page receive no notifications until the organization is active again. Unsubscribing always works.
Sender Domain
Send your organization's emails from your own domain through Uptimeify's mail infrastructure, without running your own SMTP server. Enterprise feature, enabled per organization by Uptimeify. Admin-only.
Activate Status Page Domain
Activates a verified custom domain for a status page. Organization-wide: admin only; customer-bound: by the page's ownership class.