Sign in
Docs
API referenceInfrastructure

API reference

List clusters

Have a token? Manage tokens in the console
GET
/v1/infra/clusters

The account's Kubernetes clusters, a page at a time: each with its environment, distribution, the agent that serves it, the kubeconfig context's name, and the version and node count the agent last reported.

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

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.infra.v1.ListClustersResponse

application/json
  1. response

iohr.infra.v1.ListClustersResponse

clusters*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 cluster of api.infra.allListClusters()) {    console.log(cluster);  }} 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
{  "clusters": [    {      "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"    }  ],  "next_page_token": "string"}