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

Stops the monitor and deletes it with its runs.

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.

monitor_id*string

The monitor's id, mon_ and a ULID, from List monitors.

Response Body

iohr.connections.v1.DeleteMonitorResponse

application/json
  1. response

iohr.connections.v1.DeleteMonitorResponse

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.deleteMonitor("<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.

{}

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`.

List a monitor's runs GET

Every run, newest first: when, the outcome, the latency, the status code and the class of error. Never a body. Runs are kept 90 days. Needs scope `connections:read`.