Xeonr Developer Docs
API SpecificationContainer Files

Export Container Zip

POST
/containers.api.v1.FilesystemService/ExportZip

Streams a subtree of a running workload's container as a zip (empty path means /). The subtree is sized first and refused if it exceeds max_bytes, which defaults to and is capped at 256 MiB. The target must be a RUNNING sandbox or job (FailedPrecondition otherwise); errno is mapped to a status (ENOENT NotFound, EEXIST AlreadyExists, EACCES/EPERM PermissionDenied, EROFS FailedPrecondition, ENOSPC ResourceExhausted). /.cp is hidden. Unavailable when the in-container handler is not running; Unimplemented without cluster access.

Access: namespace VIEWER or above (read) on the target's namespace. Workspace-scoped credentials (a workload's own agent key) are refused.

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

target*&
path?string

subtree root; empty = "/"

Lengthlength <= 4096
maxBytes?string

Refuse rather than truncate if the subtree exceeds this many bytes. 0 = the server's own ceiling (256 MiB), which also caps anything set here. validate:skip clamped server-side to 256 MiB

Formatint64
[key: string]?never

Response Body

application/connect+json

application/connect+json

curl -X POST "https://containers.xeonr.io/containers.api.v1.FilesystemService/ExportZip" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/connect+json" \  -d '<target/>'
{
  "data": "string",
  "eof": true
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Copy Container File POST

Copies a file or tree within a running workload's container, moving real bytes. Refuses to replace an existing destination unless overwrite is set. The target must be a RUNNING sandbox or job (FailedPrecondition otherwise); errno is mapped to a status (ENOENT NotFound, EEXIST AlreadyExists, EACCES/EPERM PermissionDenied, EROFS FailedPrecondition, ENOSPC ResourceExhausted). /.cp is hidden. Unavailable when the in-container handler is not running; Unimplemented without cluster access. **Access:** namespace OPERATOR or above (write) on the target's namespace. Workspace-scoped credentials (a workload's own agent key) are refused.

Import Zip Into Container POST

Client-streaming zip upload unpacked into a running workload's container under dest_path (empty means /). The first message must be the header; the archive is capped at 64 MiB. Returns files and bytes written. The target must be a RUNNING sandbox or job (FailedPrecondition otherwise); errno is mapped to a status (ENOENT NotFound, EEXIST AlreadyExists, EACCES/EPERM PermissionDenied, EROFS FailedPrecondition, ENOSPC ResourceExhausted). /.cp is hidden. Unavailable when the in-container handler is not running; Unimplemented without cluster access. **Access:** namespace OPERATOR or above (write) on the target's namespace. Workspace-scoped credentials (a workload's own agent key) are refused.