Xeonr Developer Docs
API Specificationcontainers.api.v1.VolumeService

List Volumes

POST
/containers.api.v1.VolumeService/ListVolumes

Lists a namespace's volumes, optionally filtered by tier. Workload-scoped agent keys are refused.

Access: any role in the namespace (viewer, operator or admin — via Xeonr team membership or a namespace API key), or a platform admin.

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

namespace?string
Lengthlength <= 64
tier?string

Optional filter; unspecified means every tier. enum.defined_only = true

Value in"VOLUME_TIER_UNSPECIFIED" | "VOLUME_TIER_SCRATCH" | "VOLUME_TIER_CACHE" | "VOLUME_TIER_PERSISTENT"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.VolumeService/ListVolumes" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "volumes": [
    {
      "volumeId": "string",
      "namespace": "string",
      "tier": "VOLUME_TIER_UNSPECIFIED",
      "state": "VOLUME_STATE_UNSPECIFIED",
      "label": "string",
      "cacheKey": "string",
      "sizeMb": "string",
      "usedBytes": "string",
      "node": "string",
      "createdAtUnix": "string",
      "archivedAtUnix": "string",
      "archiveSnapshotId": "string",
      "seedSnapshotId": "string",
      "mountedBy": "string",
      "pendingSeedSnapshotId": "string",
      "lastArchiveDurationMs": 0
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

List Volume Files POST

Lists a directory on the volume. Returns FailedPrecondition if the volume has never been mounted (its node is not known yet) or its node is unreachable, and Unimplemented when the volume file API is not configured. **Access:** any role in the volume's namespace, or a platform admin.

Make Volume Directory POST

Creates a directory, and its missing parents when `parents` is set. Returns FailedPrecondition if the volume has never been mounted (its node is not known yet) or its node is unreachable, and Unimplemented when the volume file API is not configured. **Access:** operator or admin role in the volume's namespace, or a platform admin.