Volumes service API reference¶

See https://docs.openstack.org/api-ref/block-storage/.

In these methods, {project_id} is the ID of the project or tenant, {volume_id} is the ID of the volume, and {snapshot_id} is the ID of the snapshot. These methods allow you to manage volumes and snapshots in the OpenStack Volumes service, including creating, listing, showing details of, updating, and deleting volumes and snapshots.

List volumes¶

Bash

GET /v3/{project_id}/volumes

Show volume details¶

Bash

GET /v3/{project_id}/volumes/{volume_id}

Create a volume¶

Bash

`POST /v3/{project_id}/volumes

Request body

JSON

{
   "volume": {
   "size": 1,
   "name": "volume_name",
   "description": "volume_description"
 }
}

Update a volume¶

Bash

PUT /v3/{project_id}/volumes/{volume_id}

Request body

JSON

{
 "volume": {
 "name": "new_volume_name",
 "description": "new_volume_description"
 }
}

Delete a volume¶

Bash

DELETE /v3/{project_id}/volumes/{volume_id}

List volume snapshots¶

Bash

GET /v3/{project_id}/snapshots

Show snapshot details¶

Bash

GET /v3/{project_id}/snapshots/{snapshot_id}

Create a snapshot¶

Bash

POST /v3/{project_id}/snapshots

Request body

JSON

{
 "snapshot": {
   "volume_id": "volume_id",
   "name": "snapshot_name",
   "description": "snapshot_description"
 }
}

Update a snapshot¶

Bash

PUT /v3/{project_id}/snapshots/{snapshot_id}

Request body

JSON

{
 "snapshot": {
   "name": "new_snapshot_name",
   "description": "new_snapshot_description"
 }
}

Delete a snapshot¶

Text Only

DELETE /v3/{project_id}/snapshots/{snapshot_id}