Sign in
Docs
API referenceInfrastructure

API reference

Get a stack

Have a token? Manage tokens in the console
GET
/v1/infra/stacks/{stack_id}

One stack: its engine, repository, path, revision, hosts, budget and last runs.

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

stack_id*string

The stack's id: a name the account picks, base.

Response Body

iohr.infra.v1.GetStackResponse

application/json
  1. response

iohr.infra.v1.GetStackResponse

last_runs*array<>
stack?

iohr.infra.v1.Stack

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.getStack("<stack_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
{  "last_runs": [    {      "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"    }  ],  "stack": {    "budget_seconds": 0,    "cluster_id": "string",    "engine": "string",    "environment": "string",    "host_ids": [      "string"    ],    "inventory": "string",    "kind": "string",    "name": "string",    "path": "string",    "playbook": "string",    "ref": "string",    "repository": "string",    "stack_id": "string",    "updated_at": "string",    "updated_by": "string",    "workspace": "string"  }}