volumes

Add volume

Creates a new storage volume at the specified path with the given sector capacity.

post/volumes

Request

  • Base URL
    http://localhost:9980/api
  • URL
    http://localhost:9980/api/volumes
  • Auth
    HTTP basic

Request body

localPathstring required

Absolute filesystem path where the volume data will be stored.

maxSectorsinteger required

Initial number of sectors the volume can store. Each sector is 4 MiB.

Response

Volume added.

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.

Changes

No recorded changes to this operation across all 15 revisions of this API.