API reference
Get an incident version
An incident as it was at one saved version.
Needs scope incidents:read.
bearerAuthorizationBearer <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.
org_id*stringThe account's id: org in GET /v1/me.
incident_id*stringThe incident's id, inc_ and 26 characters, from List incidents.
version*integerThe version's number, from List an incident's versions.
int32iohr.incidents.v1.GetIncidentVersionResponse
application/json- response
iohr.incidents.v1.GetIncidentVersionResponse
incident?iohr.incidents.v1.Incident
saved?iohr.incidents.v1.IncidentVersion
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.incidents.getIncidentVersion("<org_id>", "<incident_id>", "<version>"); console.log(value);} 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.
{ "incident": { "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 }, "saved": { "note": "string", "saved_at": "string", "saved_by": "string", "saved_by_email": "string", "version": 0 }}List an incident's versions GET
Every saved version of an incident, newest first: its number, who saved it, when, and what changed. Needs scope `incidents:read`.
Search extensions GET
The extensions catalogue (RFC 0073) the account may see, by publisher and name: InOrbit's own, the account's private listings, and public ones. Each listing has its kind, the publisher's description in the publisher's words, and its latest version. Another account's private listing never appears. Needs scope `extensions:read`.