API SpecificationConsole Sessions
ReadConsole
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
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
sessionId?string
fromOffset?integer|string
Format
int64maxBytes?integer
waitMs?integer
Wait up to this long for new bytes before returning empty. 0 = return immediately with whatever is there (the polling agent's mode); non-zero turns one request into a long poll and is how a live terminal rides on the same call. Capped server-side.
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://containers.xeonr.io/containers.api.v1.ConsoleService/ReadConsole" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"data": "string",
"nextOffset": 0,
"truncated": true,
"state": "CONSOLE_SESSION_STATE_UNSPECIFIED",
"exitCode": 0
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}