Sign in
Docs
API referenceStatus pages

API reference

Get a status page

Have a token? Manage tokens in the console
GET
/v1/accounts/orgs/{org_id}/status-pages/{page_id}

One page: its draft, the draft's version and what is published.

Needs scope connections:read.

Authorization

bearer
headerAuthorizationBearer <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.

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

page_id*string

The page's id, from List status pages.

Query Parameters

Response Body

iohr.connections.v1.GetStatusPageResponse

application/json
  1. response

iohr.connections.v1.GetStatusPageResponse

page?

iohr.connections.v1.StatusPage

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.getStatusPage("<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": {    "created_at": "string",    "draft": {      "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"      }    },    "draft_version": 0,    "id": "string",    "published_at": "string",    "published_version": 0,    "slug": "string",    "unpublished_changes": true,    "updated_at": "string",    "url": "string"  }}