Sign in
InOrbit
Docs

API reference

List incidents

Have a token? Manage tokens in the console
GET
/v1/accounts/orgs/{org_id}/incidents

The account's incidents, newest first: what happened, when it started, was detected and resolved, its severity (1 is the worst), status, duration and the monitors it touched. Open to keys at the incidents launch.

Needs scope incidents:read.

Authorization

bearer
headerAuthorizationBearer <token>

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.

Query Parameters

page_size?integer

At most this many; 0 means 20, above 100 means 100.

Formatint32
page_token?string

From the previous page's next_page_token.

status?string

Only this status: investigating, identified, monitoring or resolved.

severity?integer

Only this severity, 1 to 4; 0 for any.

Formatint32
monitor_id?string

Only incidents that touched this monitor.

include_postmortem?boolean

Include each incident's postmortem.

category?string

Only this category; none for the uncategorised.

tag?string

Tags it carries, each key:value, all of them; at most 10.

Response Body

iohr.incidents.v1.ListIncidentsResponse

application/json
  1. response

iohr.incidents.v1.ListIncidentsResponse

incidents*array<>
next_page_token*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const incident of api.incidents.allListIncidents("<org_id>")) {    console.log(incident);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

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.

{  "incidents": [    {      "acknowledged_at": "string",      "acknowledged_by": "string",      "acknowledged_by_email": "string",      "category": "string",      "created_at": "string",      "created_by": "string",      "detected_at": "string",      "duration_secs": "string",      "figures": {        "acknowledge_secs": "string",        "error_rate": 0.1,        "failed_runs": "string",        "runs": "string"      },      "incident_id": "string",      "linked_provider": "string",      "linked_url": "string",      "monitors": [        "string"      ],      "org_id": "string",      "permissions": {        "can_acknowledge": true,        "can_delete": true,        "can_edit": true,        "can_publish": true      },      "postmortem": {        "action_items": [          {            "due": "string",            "item_id": "string",            "link": "string",            "owner": "string",            "status": "string",            "title": "string"          }        ],        "contributing": "string",        "detection": "string",        "diagnosis": "string",        "evidence": [          {            "kind": "string",            "label": "string",            "ref": "string",            "url": "string"          }        ],        "impact": "string",        "mistakes": "string",        "open_items": "string",        "record": {          "evidence_json": "string",          "preface": "string",          "record_id": "string",          "scenarios": "string",          "source": "string"        },        "repair": "string",        "response": "string",        "root_cause": "string",        "summary": "string",        "timeline": [          {            "at": "string",            "entry_id": "string",            "evidence_ref": "string",            "kind": "string",            "label": "string",            "text": "string"          }        ],        "verification": "string",        "went_badly": "string",        "went_well": "string"      },      "resolved_at": "string",      "responders": [        "string"      ],      "severity": 0,      "source": "string",      "started_at": "string",      "state": "string",      "status": "string",      "tags": {        "property1": "string",        "property2": "string"      },      "title": "string",      "updated_at": "string",      "updated_by": "string",      "updated_by_email": "string",      "version": 0    }  ],  "next_page_token": "string"}

Set monitor data retention PUT

Sets how long the account keeps runs (1 to 90 days) and per-method results (1 to 30 days); 0 returns a field to the default (30 and 7). The account's owner or an admin. Older data is deleted within the hour. Needs scope `connections:write`.

Get an incident GET

One incident with its postmortem: what happened, its root cause and impact, its timeline and what follows. Another account's is not found. Needs scope `incidents:read`.