API Reference
StatiBeat publishes four supported customer API surfaces. The interactive reference lets you switch between visitor workflows, delegated page management, and administrative automation without conflating their credentials.
On the interactive reference, use Try your public API safely to enter your page URL. The helper resolves anonymous public metadata when the page allows browser CORS, remembers the base URL only for the current browser session, and can run a small allowlist of read-only GET requests. It never asks for an API key, sends requests through the docs server, or runs write operations. If a customer page does not allow docs.statibeat.com as a browser origin, copy the request and run it from your own environment instead.
Visitor API
Use this surface for status-page reads and visitor workflows:
- page settings, components, incidents, maintenance, and public metrics
- subscriber signup, verification, preferences, and management links
- public custom views and RSS feeds
- viewer authentication for private status pages
These operations are intended for unauthenticated visitors, although private-page logout requires the visitor session cookie.
Download the Public OpenAPI contract.
Delegated Public Management
Use this surface for page-level management flows initiated from public links:
- managing feeds, custom views, and subscriber preferences
- adding or removing managers and transferring ownership
- creating and updating delegated public resources
Every operation requires a page- or resource-specific MagicToken. This is not an unauthenticated API and must not be treated as an admin bearer-token replacement.
Download the Delegated Public Management contract.
Page Administration
Use this surface to automate the page resolved from your request host:
- incidents and maintenance
- Beats and alerting
- hierarchy, status definitions, subscribers, feeds, and views
- page identity, site appearance, domains, webhooks, API tokens, and integrations
Page-administration operations require a bearer API token and may additionally require a page permission, token scope, account feature, or plan entitlement.
Download the Page Administration contract.
Organisation Administration
Use this surface for organisation-wide operations:
- page inventory and membership
- organisation users, roles, and authorization
- billing and subscription management
- managed domains and identity providers
Organisation-administration operations require a bearer API token with the appropriate organisation permission and token scope.
Download the Organisation Administration contract.
Combined contract
Tooling that needs every supported customer operation can use /api/openapi_customer.json.
The engineering-only contract is not published on this site. It contains application protocols, managed-service operations, recovery utilities, and compatibility aliases that are not supported customer integration APIs.
Route selection
For ordinary integrations, use your status page or custom domain as the base URL:
https://status.example.com
Preferred route families are:
- visitor reads and workflows:
/api/v1/settings,/api/v1/incidents,/api/v1/maintenances - delegated public management:
/api/v1/pages/by-public-slug/{public_slug}/manage/... - page context:
/api/v1/context - page administration:
/api/v1/admin/... - organisation administration:
/api/v1/org/...
Public-slug selectors remain available for visitor and delegated-management workflows that cannot use a page host. Numeric organisation/page selector aliases are compatibility routes and are intentionally excluded from customer contracts.