Xeonr Developer Docs
API SpecificationWorkspaces

ListWorkspaces

POST
/containers.api.v1.WorkspaceService/ListWorkspaces

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

namespace?string
pageSize?integer
pageToken?string
includeEphemeral?boolean

Include workspaces owned by a sandbox, job or app replica. Off by default: they are scratch, they can outnumber durable workspaces by a lot (an app scaled to 50 replicas has 50), and a listing buried in them is useless.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.WorkspaceService/ListWorkspaces" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "workspaces": [
    {
      "workspaceId": "string",
      "namespace": "string",
      "totalBytes": 0,
      "fileCount": 0,
      "updatedAtUnix": 0,
      "label": "string",
      "revision": 0,
      "ephemeral": true,
      "ownerKind": "string",
      "ownerId": "string"
    }
  ],
  "nextPageToken": "string"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}