Xeonr Developer Docs
API Specificationcontainers.api.v1.VolumeService

List Volume Files

POST
/containers.api.v1.VolumeService/ListVolumeFiles

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.

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

volumeId?string
Length1 <= length <= 64
path?string
Lengthlength <= 4096
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.VolumeService/ListVolumeFiles" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "files": [
    {
      "path": "string",
      "size": "string",
      "mode": 0,
      "isDir": true,
      "sha256": "string",
      "mtimeUnix": "string",
      "symlinkTarget": "string"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Get Volume POST

Returns a volume by `volume_id`, or by `namespace` + `cache_key` for a cache volume; InvalidArgument if neither is given. Access is checked against the volume's own namespace. **Access:** any role in the volume's namespace, or a platform admin.

List Volumes POST

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.