API referenceCoordinator
API reference
Get a pool's policy
Have a token? Manage tokens in the console
GET
One pool's policy, the current version or any earlier one with who set it and why. A version that never existed answers not found.
Needs scope coordinator: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.
pool_id*stringThe pool's id, from List pools.
version?integer0 is the current version.
Format
int32account_id?stringThe account's id: org in GET /v1/me.
iohr.coordinator.v1.GetPoolPolicyResponse
application/json- response
iohr.coordinator.v1.GetPoolPolicyResponse
policy?iohr.coordinator.v1.PoolPolicy
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.coordinator.getPoolPolicy("<pool_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
{ "policy": { "max_load_per_core": 0.1, "max_slots": 0, "min_free_disk_bytes": "string", "paused": true, "pool_id": "string", "reason": "string", "runners": [ { "max_build_slots": 0, "max_slots": 0, "runner_id": "string" } ], "thermal_limits": { "property1": 0.1, "property2": 0.1 }, "trust_tier": "string", "updated_at": "string", "updated_by": "string", "version": 0 }}