Sign in

v1

latestOpenAPI 3.0.02026-07-17506168.4 KB
volumes

Get volume

Returns the metadata and statistics for a single storage volume.

get/volumes/{id}

Path parameters

idinteger required

Volume identifier.

Response

Volume metadata.

idinteger required

Unique identifier of the volume.

localPathstring required

Absolute filesystem path of the volume data.

usedSectorsinteger required

Number of sectors currently stored in the volume.

totalSectorsinteger required

Maximum number of sectors the volume can store.

readOnlyboolean required

Whether the volume is read-only.

availableboolean required

Whether the volume is currently available for I/O operations.

failedReadsinteger

Number of failed sector read operations.

failedWritesinteger

Number of failed sector write operations.

successfulReadsinteger

Number of successful sector read operations.

successfulWritesinteger

Number of successful sector write operations.

corruptSectorsinteger

Number of sectors that failed to verify against their root while being read.

statusstring

Current volume status (unavailable, creating, resizing, removing, ready).

errorsstring[] nullable

Recent error messages from volume operations.