Sign in
Docs
API referenceInfrastructure

API reference

Get a run's diff

Have a token? Manage tokens in the console
GET
/v1/infra/runs/{run_id}/diff

What a check or plan would change: each resource or host/task with its action and the names of the attributes that change, never their values, and diff_hash, the sha256 an apply's approval is pinned to.

Needs scope infra: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.

Path Parameters

run_id*string

The run's id, run_ and 32 hex characters, from Start a run or List a stack's runs.

Response Body

iohr.infra.v1.GetRunDiffResponse

application/json
  1. response

iohr.infra.v1.GetRunDiffResponse

adds*integer
Formatint32
changes*integer
Formatint32
destroys*integer
Formatint32
diff_hash*string
items*array<>
ready*boolean
run_id*string
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.getRunDiff("<run_id>");  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
{  "adds": 0,  "changes": 0,  "destroys": 0,  "diff_hash": "string",  "items": [    {      "action": "string",      "address": "string",      "attributes": [        "string"      ]    }  ],  "ready": true,  "run_id": "string"}