Xeonr Developer Docs
API SpecificationWorkspaces

Snapshot Workspace

POST
/containers.api.v1.WorkspaceService/SnapshotWorkspace

Freezes a workspace's current content into an immutable snapshot. Flushes any live sandbox holding the workspace first and fails with Unavailable if it cannot, rather than returning a stale snapshot. Returns the snapshot id and full record.

Access: namespace OPERATOR or above (write); 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/json

workspaceId?string
Length1 <= length <= 128
label?string
Lengthlength <= 255
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.WorkspaceService/SnapshotWorkspace" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "snapshotId": "string",
  "atUnix": "string",
  "snapshot": {
    "snapshotId": "string",
    "workspaceId": "string",
    "label": "string",
    "atUnix": "string",
    "totalBytes": "string",
    "fileCount": 0,
    "ownerKind": "string",
    "ownerId": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Set File Attributes POST

Updates a node's mode, mtime or symlink target; a zero/empty value leaves that attribute unchanged. **Access:** namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for

Stat File POST

Returns metadata for one path in a workspace or snapshot. Exactly one of workspace_id / snapshot_id must be set (InvalidArgument); path is required and is cleaned and rooted, with traversal rejected. **Access:** namespace VIEWER or above (read); a workspace-scoped agent key may act only on the trees it was minted for