API referenceCoordinator
API reference
List runners
Have a token? Manage tokens in the console
GET
The account's runners, or with mine the caller's: name, os, kinds, providers by sign-in method (never a credential), slots and status.
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.
mine?booleanOnly the caller's own runners.
account_id?stringpage_size?integerAt most this many; 0 means 50, above 200 means 200.
Format
int32page_token?stringFrom the previous page's next_page_token.
iohr.coordinator.v1.ListRunnersResponse
application/json- response
iohr.coordinator.v1.ListRunnersResponse
next_page_token*stringrunners*array<>SDK
HTTP
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 runner of api.coordinator.allListRunners()) { console.log(runner); }} 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", "runners": [ { "account_id": "string", "always_on": true, "arch": "string", "capacity": 0, "created_at": "string", "effective_capacity": 0, "holder_subject": "string", "image_digest": "string", "kinds": [ "string" ], "labels": [ "string" ], "last_seen_at": "string", "machine_provider": "string", "name": "string", "os": "string", "pool_id": "string", "providers": [ { "method": "string", "plan_window_until": "string", "provider": "string", "signed_in": true } ], "public_key": "string", "region": "string", "resources": { "cpu_cores": 0, "disk_bytes": "string", "memory_bytes": "string" }, "runner_id": "string", "shed_reason": "string", "signals": { "cache_hit_rate": 0.1, "cpu_throttle_pct": 0.1, "disks": [ { "free_bytes": "string", "mount": "string", "total_bytes": "string" } ], "load_1m": 0.1, "psi_cpu": 0.1, "psi_io": 0.1, "psi_memory": 0.1, "temperatures": [ { "celsius": 0.1, "limit_celsius": 0.1, "sensor": "string" } ] }, "signals_at": "string", "slots_used": 0, "status": "string", "trust_tier": "string", "user": "string", "version": "string" } ]}