InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
POST
/v1/accounts/orgs/{org_id}/connections/{connection_id}/monitors

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.

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.

connection_id*string

The connection's id, con_ and a ULID, from List connections.

Header Parameters

idempotency-key?string

Makes a retry safe: a repeat with the same key and the same body within a day answers what the first call did (with Idempotency-Replayed: true) instead of running again; the same key with another body is 422 unprocessable. 1 to 255 visible characters; a UUID is a good one.

Length1 <= length <= 255

Request Body

iohr.connections.v1.CreateMonitorRequest; path variables override their fields

application/json
  1. body

iohr.connections.v1.CreateMonitorRequest

category?string
connection_id?string
fail_after?integer
Formatint32
interval_secs?integer
Formatint32
name?string
org_id?string
params?

iohr.connections.v1.MonitorParams

rfc?string
tags?

Response Body

iohr.connections.v1.CreateMonitorResponse

application/json
  1. response

iohr.connections.v1.CreateMonitorResponse

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.createMonitor("<org_id>", "<connection_id>", {    category: "<category>",    name: "<name>",    rfc: "<rfc>",  });  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"    }  }}

Get a monitor GET

One monitor: its schedule, expectation, state, health, and when it last ran and runs next. Needs scope `connections:read`.

Change a monitor PATCH

Changes its name, interval, expectation or failure threshold, or pauses (`state: paused`) and resumes it. Fields left out stay as they are. Needs scope `connections:write`.