One monitor: its schedule, expectation, state, health, and when it last ran and runs next.
Needs scope connections: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 (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
monitor_id*stringThe monitor's id, mon_ and a ULID, from List monitors.
iohr.connections.v1.GetMonitorResponse
application/json- response
iohr.connections.v1.GetMonitorResponse
monitor?iohr.connections.v1.Monitor
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.getMonitor("<org_id>", "<monitor_id>"); 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.
{ "monitor": { "agent_id": "string", "category": "string", "check": { "expect": { "max_ms": 0, "status": 0, "valid_for_days": 0 }, "key": "string", "notify": true, "refuse_by": "string", "service": "string", "surface": "string", "target": { "host": "string", "port": 0, "tls": true, "url": "string" } }, "connection_id": "string", "created_at": "string", "executor": { "agent_id": "string", "kind": "string" }, "fail_after": 0, "health": "string", "interval_secs": 0, "last_run_at": "string", "managed_by": "string", "monitor_id": "string", "name": "string", "next_run_at": "string", "params": { "expect_status": 0, "max_ms": 0, "path": "string" }, "paused_reason": "string", "rfc": "string", "slo_target": 0.1, "state": "string", "tags": { "property1": "string", "property2": "string" } }}List monitors GET
The account's monitors, each with its connection, schedule, expectation, state and health (`up`, `down` or `unknown`). Needs scope `connections:read`.
Create a monitor POST
Runs the connection's `check` every `interval_secs` (60 at least) from the connection's executor, our cloud or your agent. `fail_after` failures in a row (1 to 5, 2 when 0) make it `down`. Needs scope `connections:write`.