Xeonr Developer Docs
API SpecificationConsole Sessions

Resize Console

POST
/containers.api.v1.ConsoleService/ResizeConsole

Sets the session's PTY window size; cols and rows must both be non-zero (InvalidArgument otherwise).

Access: namespace OPERATOR or above (write)

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

sessionId?string
Length1 <= length <= 64
size*
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.ConsoleService/ResizeConsole" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{    "size": {}  }'
{
  "session": {
    "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": {}
    }
  ]
}

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)

Write Console POST

Sends stdin to a session without holding a stream and returns the ring's tail offset after the write, so the caller can read back only this input's output. The in-pod daemon reads at most 1 MiB per write. FailedPrecondition for an exited or lost session. **Access:** namespace OPERATOR or above (write)