General APIs with JWT

Update a volume

Changed on

Endpoint to update a volume.

put/volumes/{volume_id}

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/volumes/{volume_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

volume_idstring uuid required

Request body

namestring required
descriptionstring nullable

Example request

{
  "description": "my volume description",
  "name": "my volume"
}

Response

Volume updated successfully

idstring uuid required
namestring required
descriptionstring nullable
created_atstring required
updated_atstring required
current_size_bytesinteger nullable
current_file_countinteger nullable
current_size_gbnumber nullable
current_size_mbnumber nullable
last_metrics_updatestring nullable

Changes

  • 99cfcca04ef3Revision changes
    • info

      added the optional property // to the response with the status

  • 37963d1ef9feRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status