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

The account's agents, newest first: each one's environment, the verified domains it is bound to, whether it is online, offline or revoked, the version it reported and when it was last heard from. Paged with page_size (0 means 50, at most 200) and next_page_token.

Needs scope agents: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

Agents per page: 0 means 50, above 200 is read as 200.

Formatint32
page_token?string

The previous page's next_page_token; empty for the first page.

Response Body

iohr.agents.v1.ListAgentsResponse

application/json
  1. response

iohr.agents.v1.ListAgentsResponse

agents*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 agent of api.agents.allListAgents("<org_id>")) {    console.log(agent);  }} 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.

{  "agents": [    {      "agent_id": "string",      "arch": "string",      "capabilities": [        "string"      ],      "checks": {        "accepted": 0,        "checks_hash": "string",        "reconciled_at": "string",        "rejected": [          {            "key": "string",            "reason": "string"          }        ]      },      "clock_skew_ms": "string",      "domains": [        "string"      ],      "enrolled_at": "string",      "environment": "string",      "last_seen_at": "string",      "name": "string",      "os": "string",      "policy_hash": "string",      "revoked_at": "string",      "rtt_last_ms": 0,      "rtt_p95_ms": 0,      "status": "string",      "version": "string"    }  ],  "next_page_token": "string"}

List notifications GET

The account's notable events, newest first: units near the allowance, a health alert, a webhook endpoint turned off, a member who joined or left, a revoked key or token, a domain that lost its proof, a revoked agent, a deleted connection. Each says whether you have read it, and `unread` counts the rest (at most 99). Needs scope `events:read`.

Get an agent GET

One agent by id. Needs scope `agents:read`.