API referenceInfrastructure
API reference
List hosts
Have a token? Manage tokens in the console
GET
The account's hosts, a page at a time: each with its name, groups, labels and reachability. Reachability stays unknown until a run reports the host.
Needs scope infra:read.
bearerheader
AuthorizationBearer <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.
page_size?integerAt most this many; 0 means 50, above 200 means 200.
Format
int32page_token?stringFrom the previous page's next_page_token.
iohr.infra.v1.ListHostsResponse
application/json- response
iohr.infra.v1.ListHostsResponse
hosts*array<>next_page_token*stringSDK
HTTP
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 host of api.infra.allListHosts()) { console.log(host); }} 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
{ "hosts": [ { "agent_id": "string", "environment": "string", "host_id": "string", "labels": { "property1": "string", "property2": "string" }, "last_seen_at": "string", "name": "string", "reachability": "string", "site": "string", "updated_at": "string", "updated_by": "string" } ], "next_page_token": "string"}