Xeonr Developer Docs
API SpecificationWorkspaces

List Snapshots

POST
/containers.api.v1.WorkspaceService/ListSnapshots

Lists snapshots newest first, either of one workspace (workspace_id) or of a whole namespace (namespace, which includes snapshots whose source workspace was deleted). Exactly one of the two must be set (InvalidArgument). page_size defaults to 100 and is clamped to 1000.

Access: namespace VIEWER or above (read); the namespace form is refused for workspace-scoped agent keys

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

Snapshots of one workspace. Mutually exclusive with namespace.

Lengthlength <= 128
pageSize?integer

validate:skip 0 = default 100; values above 1000 are clamped, not refused

pageToken?string
namespace?string

Every snapshot in a namespace, including ones whose source workspace has been deleted. Without this a snapshot of an ephemeral workspace becomes unreachable the moment its owner is torn down — it survives, but only a caller who kept the id could find it.

Lengthlength <= 64
[key: string]?never

Response Body

application/json

application/json

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

List Files POST

Lists the entries under a directory in a workspace or snapshot, optionally recursively. Exactly one of workspace_id / snapshot_id must be set; path is required (use "/" for the root). **Access:** namespace VIEWER or above (read); a workspace-scoped agent key may act only on the trees it was minted for

List Workspaces POST

Lists workspaces in a namespace, most recently updated first. Ephemeral workspaces (owned by a sandbox, job or app replica) are excluded unless include_ephemeral is set. namespace is required unless the caller is a platform admin. page_size defaults to 100 and is clamped to 1000. **Access:** namespace VIEWER or above (read); refused for workspace-scoped agent keys