Xeonr Developer Docs
API SpecificationConsole Sessions

Attach Console

POST
/containers.api.v1.ConsoleService/AttachConsole

Bidirectional interactive attach. The first client message must be the AttachSpec (InvalidArgument otherwise); later messages are stdin bytes or resize events. The server streams output from from_offset (replay with 0 starts at the oldest retained byte; otherwise 0 starts at the live tail), marks truncated when bytes were evicted, and ends with an exit event when the process exits. Hanging up leaves the session running. Browsers reach this through the /ws/console bridge.

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/connect+json

resize?

Response Body

application/connect+json

application/connect+json

curl -X POST "https://containers.xeonr.io/containers.api.v1.ConsoleService/AttachConsole" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/connect+json" \  -d ''
{
  "exit": {
    "code": 0,
    "state": "CONSOLE_SESSION_STATE_UNSPECIFIED"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Console Sessions

Persistent terminal sessions that outlive the client attached to them, addressed by byte offset.

Close Console Session POST

Ends a session: signals its process group with TERM and escalates to KILL after a grace window (force kills at once), then drops its index entry. Closing a LOST session just removes the record. **Access:** namespace OPERATOR or above (write)