Xeonr Developer Docs
API SpecificationConsole Sessions

List Console Sessions

POST
/containers.api.v1.ConsoleService/ListConsoleSessions

Lists a sandbox's terminal sessions with their live state. Sessions the pod no longer has (suspended, restarted or evicted) are reported LOST; exited sessions are omitted unless include_exited is set.

Access: namespace VIEWER or above (read)

Authorization

BearerAuth
AuthorizationBearer <token>

A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC token for humans. The key's namespace and role are pinned server-side.

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

sandboxId?string
Length1 <= length <= 64
includeExited?boolean

Include sessions whose process has exited (retained briefly with their scrollback, so a client that reconnects late still sees how it ended). validate:skip a bool has no bounds

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.ConsoleService/ListConsoleSessions" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "sessions": [
    {
      "sessionId": "string",
      "sandboxId": "string",
      "namespace": "string",
      "name": "string",
      "argv": [
        "string"
      ],
      "env": {
        "property1": "string",
        "property2": "string"
      },
      "cwd": "string",
      "cols": 0,
      "rows": 0,
      "state": "CONSOLE_SESSION_STATE_UNSPECIFIED",
      "exitCode": 0,
      "createdAtUnix": "string",
      "lastActivityUnix": "string",
      "headOffset": "string",
      "tailOffset": "string",
      "attached": 0,
      "idleTtlSec": 0,
      "createdBy": "string"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Get Console Session POST

Returns one session's live state, or its record in state LOST when its sandbox's pod is gone. **Access:** namespace VIEWER or above (read)

Read Console POST

Reads output from from_offset, optionally long-polling up to wait_ms (capped at 25 s) for new bytes. max_bytes is capped at 1 MiB (0 means 1 MiB). truncated is set when the requested offset was already evicted. Returns the next offset, session state and exit code. **Access:** namespace VIEWER or above (read)