Sign in
DataVolumes

Get a data volume

Changed on
get/api/v1/datavolumes/{name}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/datavolumes/{name}
  • Auth: none declared

Path parameters

namestring required

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Response

Data volume detail (with mount occupancy).

accessModesstring[]

Access modes (ReadWriteOnce/ReadWriteMany/ReadOnlyMany). Immutable after creation.

createdAtstring date-time

Volume creation timestamp (RFC3339).

descriptionstring

Free-text description of the volume.

labelsStringMap
namestring required

Data volume name, unique within the tenant.

sizestring

Requested storage size as a Kubernetes quantity (e.g. 200Gi).

storageClassstring

StorageClass backing the volume; cluster default when empty. Immutable after creation.

Example response

{
  "accessModes": [
    "ReadWriteMany"
  ],
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "Shared raw datasets directory.",
  "labels": {
    "team": "vision"
  },
  "name": "shared-datasets",
  "size": "2Ti",
  "status": {
    "boundCapacity": "2Ti",
    "mounts": [
      {
        "kind": "Deployment",
        "mountPath": "/data/shared",
        "running": true,
        "workload": "ws-jupyter-3"
      }
    ],
    "phase": "Bound"
  },
  "storageClass": "nfs-rwx"
}

Changes