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

The account's monitors, each with its connection, schedule, expectation, state and health (up, down or unknown).

Needs scope connections: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 (docs.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 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

connection_id?string

Only this connection's monitors.

agent_id?string
category?string
tag?string

Response Body

iohr.connections.v1.ListMonitorsResponse

application/json
  1. response

iohr.connections.v1.ListMonitorsResponse

monitors*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 monitor of api.connections.allListMonitors("<org_id>")) {    console.log(monitor);  }} 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.

{  "monitors": [    {      "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"      }    }  ],  "next_page_token": "string"}