API referenceInfrastructure
API reference
Get a cluster
Have a token? Manage tokens in the console
GET
One cluster: its environment, distribution, agent, context name, version, node count and when the agent last saw it.
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.
cluster_id*stringThe cluster's id: a name the account picks, home.
iohr.infra.v1.GetClusterResponse
application/json- response
iohr.infra.v1.GetClusterResponse
cluster?iohr.infra.v1.Cluster
SDK
HTTP
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.infra.getCluster("<cluster_id>"); console.log(value);} 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
{ "cluster": { "agent_id": "string", "cluster_id": "string", "context_name": "string", "environment": "string", "kind": "string", "last_seen_at": "string", "name": "string", "node_count": 0, "updated_at": "string", "updated_by": "string", "version": "string" }}