get/volumes

Request

  • Base URL
    http://localhost:4973
  • URL
    http://localhost:4973/volumes
  • Auth
    HTTP bearer

Query parameters

tagsTags

User-defined key-value tags.

Filter volumes by tag key-value pairs.

{
  "team": "backend",
  "env": "staging"
}

Response

List of volumes

idstring required

Unique identifier

namestring required

Volume name

size_gbinteger required

Size in gigabytes

tagsTags

User-defined key-value tags.

created_atstring date-time required

Creation timestamp (RFC3339)

Example response

[
  {
    "id": "vol-data-1",
    "name": "my-data-volume",
    "size_gb": 10,
    "tags": {
      "team": "backend",
      "env": "staging"
    },
    "attachments": [
      {
        "instance_id": "inst-abc123",
        "mount_path": "/mnt/data"
      }
    ],
    "created_at": "2025-01-15T09:00:00Z"
  }
]

Changes

    • warning

      deleted the query request parameter metadata

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter tags

    • info

      added the optional property / to the response with the status

    • info

      added the new optional query request parameter metadata

    • info

      added the optional property / to the response with the status