Xeonr Developer Docs
API SpecificationWorkspaces

ListSnapshots

POST
/containers.api.v1.WorkspaceService/ListSnapshots

snapshots were write-only before this

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 in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

workspaceId?string

Snapshots of one workspace. Mutually exclusive with namespace.

pageSize?integer
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.

[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 "Content-Type: application/json" \  -d '{}'
{
  "snapshots": [
    {
      "snapshotId": "string",
      "workspaceId": "string",
      "label": "string",
      "atUnix": 0,
      "totalBytes": 0,
      "fileCount": 0,
      "ownerKind": "string",
      "ownerId": "string"
    }
  ],
  "nextPageToken": "string"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}