API SpecificationWorkspaces
ReadFile
offset/length => partial reads
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/connect+json
workspaceId?string
path?string
offset?integer|string
Format
int64length?integer|string
0 = to EOF
Format
int64snapshotId?string
Address an immutable snapshot instead of a live workspace; exactly one of workspace_id / snapshot_id must be set. Serves static content straight from a snapshot with no workspace fork. (A9)
[key: string]?never
Response Body
application/connect+json
application/connect+json
curl -X POST "https://containers.xeonr.io/containers.api.v1.WorkspaceService/ReadFile" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/connect+json" \ -d ''{
"data": "string",
"offset": 0,
"eof": true
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}