API reference
Start a run
Queue a run of a stack on the account's agent: check (an Ansible stack, ansible-playbook --check --diff) or plan (a tofu stack), both read-only. One check or plan of a stack is queued or running at a time. An apply names the plan run it applies and the approval that allows it, and needs infra:apply; in this release it is recorded, held and labelled stub: no apply runs yet.
Needs scope infra:apply and infra:run.
bearerAuthorizationBearer <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.
stack_id*stringThe stack's id: a name the account picks, base.
iohr.infra.v1.StartRunRequest; path variables override their fields
application/json- body
iohr.infra.v1.StartRunRequest
approval_id?stringplan_run_id?stringstack_id?stringverb?stringiohr.infra.v1.StartRunResponse
application/json- response
iohr.infra.v1.StartRunResponse
run?iohr.infra.v1.Run
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.startRun("<stack_id>", { verb: "<verb>" }); 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.
{ "run": { "adds": 0, "approval_id": "string", "budget_seconds": 0, "changes": 0, "commit": "string", "created_at": "string", "destroys": 0, "diff_hash": "string", "engine": "string", "engine_version": "string", "evidence": [ "string" ], "exit_code": 0, "finished_at": "string", "plan_run_id": "string", "reason": "string", "requested_by": "string", "run_id": "string", "stack_id": "string", "started_at": "string", "state": "string", "stub": true, "verb": "string", "worker_id": "string" }}