Xeonr Developer Docs
API Specificationcontainers.api.v1.VolumeService

Resize Volume

POST
/containers.api.v1.VolumeService/ResizeVolume

Grows a volume. size_mb must be larger than the current size (volumes cannot shrink) and at most 512 GiB. Workload-scoped agent keys are refused.

Access: operator or admin 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
sizeMb?string

New size, which must be larger than the current one and at most 512 GiB.

Formatint64
Range0 < value <= 524288
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.VolumeService/ResizeVolume" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "volume": {
    "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": {}
    }
  ]
}

Remove Volume File POST

Removes a file or empty directory, or a whole tree when `recursive` 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.

Restore Volume POST

Replaces a volume's contents from a snapshot in the same namespace, defaulting to the volume's most recent archive. Refused (FailedPrecondition) while the volume is mounted or when it has never been archived and no `snapshot_id` is given. 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.