API referenceCoordinator
API reference
Get the state machine
Have a token? Manage tokens in the console
GET
The job state machine as data: stages, modes, every edge with its gate and checks, and the compensation each records.
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.
iohr.coordinator.v1.GetMachineResponse
application/json- response
iohr.coordinator.v1.GetMachineResponse
await_kinds*array<string>edges*array<>mode_edges*array<>modes*array<string>stages*array<string>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.getMachine(); 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
{ "await_kinds": [ "string" ], "edges": [ { "checks": [ "string" ], "compensation": [ "string" ], "from": "string", "gate": "string", "kind": "string", "to": "string" } ], "mode_edges": [ { "from": "string", "gate": "string", "kind": "string", "to": "string" } ], "modes": [ "string" ], "stages": [ "string" ]}