Sign in
Docs

Deployments

List what runs where

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

What each deployment runs and what changed: its commit, when and how it was deployed, how many merges on main it is behind and which pull requests those are, and main's newest merges with the deployments that run each. Read from what each deploy recorded.

Needs scope decisions: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 deployments; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.deployments.v1.ListResponse

application/json
  1. response

iohr.deployments.v1.ListResponse

deployments*array<>
main*string
next_page_token*string
recent*array<>
recorded_at*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.deployments.list();  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
{  "deployments": [    {      "behind": 0,      "commit": "string",      "commit_title": "string",      "how": "string",      "known": true,      "name": "string",      "namespace": "string",      "pending": [        {          "commit": "string",          "merged_at": "string",          "pr": 0,          "running_in": [            "string"          ],          "title": "string"        }      ],      "rolled_at": "string"    }  ],  "main": "string",  "next_page_token": "string",  "recent": [    {      "commit": "string",      "merged_at": "string",      "pr": 0,      "running_in": [        "string"      ],      "title": "string"    }  ],  "recorded_at": "string"}