API referenceStatus pages
API reference
Preview a status page
Have a token? Manage tokens in the console
GET
The page as readers would see it with the current draft, marked as a preview: what the designer shows.
Needs scope connections:read.
bearerheader
AuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
page_id*stringThe page's id, from List status pages.
iohr.connections.v1.PreviewStatusPageResponse
application/json- response
iohr.connections.v1.PreviewStatusPageResponse
page?iohr.connections.v1.PublishedStatusPage
SDK
HTTP
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.connections.previewStatusPage("<org_id>", "<page_id>"); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
Example Response
{ "page": { "active": [ { "ends_at": "string", "id": "string", "impacts": [ { "component_id": "string", "impact": "string" } ], "incident_id": "string", "kind": "string", "resolved_at": "string", "starts_at": "string", "state": "string", "title": "string", "updates": [ { "body": "string", "by_role": "string", "created_at": "string", "id": "string", "state": "string" } ] } ], "design": { "accent": "string", "corners": "string", "font": "string", "groups": [ { "collapsed": true, "components": [ { "description": "string", "id": "string", "monitor_ids": [ "string" ], "name": "string", "show_history": true, "show_uptime": true } ], "name": "string" } ], "has_logo": true, "header": "string", "hide_footer": true, "keep_logo": true, "language": "string", "logo": "string", "logo_type": "string", "name": "string", "site_url": "string", "support_url": "string", "theme": "string", "wording": { "degraded": "string", "footer": "string", "full_outage": "string", "maintenance": "string", "operational": "string", "partial_outage": "string" } }, "generated_at": "string", "groups": [ { "collapsed": true, "components": [ { "checks": 0, "description": "string", "history": [ { "date": "string", "failed": 0, "maintenance": true, "runs": 0 } ], "id": "string", "name": "string", "since": "string", "source": "string", "state": "string", "uptime": { "d30": 0.1, "d7": 0.1, "h24": 0.1 } } ], "name": "string" } ], "overall": "string", "past": [ { "ends_at": "string", "id": "string", "impacts": [ { "component_id": "string", "impact": "string" } ], "incident_id": "string", "kind": "string", "resolved_at": "string", "starts_at": "string", "state": "string", "title": "string", "updates": [ { "body": "string", "by_role": "string", "created_at": "string", "id": "string", "state": "string" } ] } ], "preview": true, "published_at": "string", "scheduled": [ { "ends_at": "string", "id": "string", "impacts": [ { "component_id": "string", "impact": "string" } ], "incident_id": "string", "kind": "string", "resolved_at": "string", "starts_at": "string", "state": "string", "title": "string", "updates": [ { "body": "string", "by_role": "string", "created_at": "string", "id": "string", "state": "string" } ] } ], "slug": "string", "version": 0 }}