API SpecificationContainer Files
ReadFile
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
target?|
FsTarget names the running workload whose filesystem to address. Exactly one.
Apps are deliberately absent. An App's replicas are interchangeable and individually disposable, and it is declared to have no writable state — a file API addressed at one replica would write to a pod that may vanish mid-call and read state that differs between replicas.
path?string
offset?integer|string
Format
int64length?integer|string
0 = to EOF
Format
int64[key: string]?never
Response Body
application/connect+json
application/connect+json
curl -X POST "https://containers.xeonr.io/containers.api.v1.FilesystemService/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": {}
}
]
}