API reference
File the roll ask
File the one batch roll ask for an environment that is behind main, through the same path the drift pass uses. It is idempotent by payload: a call while the same roll ask stands answers it again and files nothing. It files only while the host's report is fresh, main's CI is green, no roll is running and the host's plan and migration checks passed; otherwise it answers refused with the reason (report_missing, ci_not_green, roll_running, proof_failed or no_finding) and nothing is filed. An ask already standing for the batch answers waiting, an approved roll not yet finished held_back, and a new one filed with the ask it superseded. It never decides or runs the roll: a person approves it. Only production is an environment today.
Needs scope coordinator:write.
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.
iohr.coordinator.v1.FileRollRequest; path variables override their fields
application/json- body
iohr.coordinator.v1.FileRollRequest
account_id?stringenvironment?stringiohr.coordinator.v1.FileRollResponse
application/json- response
iohr.coordinator.v1.FileRollResponse
outcome?iohr.coordinator.v1.RollerOutcome
superseded*stringimport { 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.fileRoll({ environment: "<environment>" }); 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.
{ "outcome": { "ask_id": "string", "at": "2019-08-24T14:15:22Z", "detail": "string", "outcome": "string" }, "superseded": "string"}