Sign in
Docs
API referenceSensors

API reference

List sensors

Have a token? Manage tokens in the console
GET
/v1/atlas/sensors

An account's sensors grouped by source, each with its state (active, paused, revoked), health (ok, stale after three missed intervals, silent before the first reading; up, down, unknown or paused for a monitor), rate and last reading. The built-in ones (monitors, incidents, coordinator sessions, queued asks) come first and are read-only.

Needs scope atlas-signals:read.

Authorization

bearer
headerAuthorizationBearer <JWT>

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.

Query Parameters

account_id?string

A team you belong to, to act on its events; empty for your own account.

source?string

Only this source (mac, server, agent, connection, phone, or a built-in one: monitors, incidents, coordinator, asks); empty for all.

exclude_builtin?boolean

Leave the built-in sensors out.

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.

Response Body

iohr.sensors.v1.ListResponse

application/json
  1. response

iohr.sensors.v1.ListResponse

groups*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 sensorGroup of api.sensors.allList()) {    console.log(sensorGroup);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

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.

Example Response
{  "groups": [    {      "sensors": [        {          "account_id": "string",          "builtin": true,          "created_at": "string",          "health": "string",          "interval_seconds": 0,          "kind": "string",          "label_keys": [            "string"          ],          "last_seen_at": "string",          "name": "string",          "owner": "string",          "producer_kind": "string",          "producer_ref": "string",          "rate_per_minute": 0.1,          "revoked_at": "string",          "schema_version": 0,          "sensor_id": "string",          "source": "string",          "state": "string",          "unit": "string"        }      ],      "source": "string"    }  ],  "next_page_token": "string"}