Sign in
Docs
API referenceCoordinator

API reference

List pools

Have a token? Manage tokens in the console
GET
/v1/coordinator/pools

The account's runner pools, by pool id, each as its current policy: trust tier, pause, slot cap, the host limits that hold back build work, and the runners in it with their own caps.

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

account_id?string

The account's id: org in GET /v1/me.

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.coordinator.v1.ListPoolsResponse

application/json
  1. response

iohr.coordinator.v1.ListPoolsResponse

next_page_token*string
pools*array<>
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 poolPolicy of api.coordinator.allListPools()) {    console.log(poolPolicy);  }} 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
{  "next_page_token": "string",  "pools": [    {      "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    }  ]}