Sign in
Docs
API referenceInfrastructure

API reference

List stacks

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

The account's stacks, a page at a time: an Ansible playbook or an OpenTofu (or Terraform) root in one of the account's repositories, with its engine, path, hosts 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.

Query Parameters

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.infra.v1.ListStacksResponse

application/json
  1. response

iohr.infra.v1.ListStacksResponse

next_page_token*string
stacks*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const stack of api.infra.allListStacks()) {    console.log(stack);  }} 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
{  "next_page_token": "string",  "stacks": [    {      "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"    }  ]}