Sign in
Docs
API referenceInfrastructure

API reference

Register a cluster

Have a token? Manage tokens in the console
PUT
/v1/infra/clusters/{cluster_id}

Register a cluster or change one, keeping what the agent reported. Only the kubeconfig context's name is stored, never a kubeconfig, token or credential; a value that looks like a secret is refused (best-effort). An agent's key may create a cluster or change one bound to itself; binding an existing cluster to an agent needs infra:run.

Needs scope infra:run and infra:worker.

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.

Path Parameters

cluster_id*string

The cluster's id: a name the account picks, home.

Request Body

iohr.infra.v1.RegisterClusterRequest; path variables override their fields

application/json
  1. body

iohr.infra.v1.RegisterClusterRequest

cluster?

iohr.infra.v1.Cluster

cluster_id?string

Response Body

iohr.infra.v1.RegisterClusterResponse

application/json
  1. response

iohr.infra.v1.RegisterClusterResponse

cluster?

iohr.infra.v1.Cluster

created*boolean
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.registerCluster("<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"  },  "created": true}