Sign in
Docs
API referenceCoordinator

API reference

List terminals

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

The terminal sessions your Mac is sharing, by handle, with each one's sealed description (ciphertext only; the server cannot read it) and when its last frame arrived. Only your own person token is served: a team's or an app's is refused. View only: input_enabled is always false.

Needs scope terminals: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.coordinator.v1.ListTerminalsResponse

application/json
  1. response

iohr.coordinator.v1.ListTerminalsResponse

mac_online*boolean
next_page_token*string
pair_id*string
sessions*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 terminalSession of api.coordinator.allListTerminals()) {    console.log(terminalSession);  }} 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
{  "mac_online": true,  "next_page_token": "string",  "pair_id": "string",  "sessions": [    {      "handle": "string",      "input_enabled": true,      "last_frame_at": "string",      "sealed_meta": "string"    }  ]}