Xeonr Developer Docs
API SpecificationWorkspaces

Export Zip

POST
/containers.api.v1.WorkspaceService/ExportZip

Server stream of a workspace subtree as a zip in 64 KiB frames; empty path exports the whole workspace.

Access: namespace VIEWER or above (read); a workspace-scoped agent key may act only on the trees it was minted for

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

workspaceId?string
Length1 <= length <= 128
path?string

subtree root; empty = whole workspace

Lengthlength <= 4096
[key: string]?never

Response Body

application/connect+json

application/connect+json

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

Delete Workspace POST

Deletes a workspace and its content. Snapshots cannot be deleted through this call (FailedPrecondition); use DeleteSnapshot. **Access:** namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for

Get Workspace POST

Returns a workspace with derived stats (total bytes, file count, revision). NotFound for an unknown id. **Access:** namespace VIEWER or above (read); a workspace-scoped agent key may act only on the trees it was minted for