Volumes
Volume View
https://api.linode.com/v4/volumes/{volumeId}Get information about a single Volume.
Path Parameters
ID of the Volume to look up.
Query Parameters
The page of a collection to return.
The number of items to return per page.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/volumes/12345
Response Samples
- 200
- default
{
"status": "active",
"created": "2018-01-01T00:01:01",
"updated": "2018-01-01T00:01:01",
"id": 1234,
"label": "my-volume",
"region": "us-east",
"tags": [],
"size": 30,
"linode_id": 12346,
"filesystem_path": "/dev/disk/by-id/scsi-0Linode_Volume_my-volume",
"linode_label": "linode123",
"hardware_type": "nvme"
}Responses
200: Returns a single Volume object.
The current status of the volume. Can be one of:
creating- the Volume is being created and is not yet available for use.active- the Volume is online and available for use.resizing- the Volume is in the process of upgrading its current capacity.
When this Volume was created.
When this Volume was last updated.
The unique ID of this Volume.
The Volume's label is for display purposes only.
The unique ID of this Region.
An array of Tags applied to this object. Tags are for organizational purposes only.
The Volume's size, in GiB.
If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0LinodeVolume + Volume label.
If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
The storage type of this Volume.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
Volume Update
https://api.linode.com/v4/volumes/{volumeId}Updates a Volume that you have permission to read_write.
Path Parameters
ID of the Volume to look up.
Request Body Schema
The Volume's label is for display purposes only.
If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
The Volume's size, in GiB.
An array of Tags applied to this object. Tags are for organizational purposes only.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"label": "my-volume"
}' \
https://api.linode.com/v4/volumes/12345
Response Samples
- 200
- default
{
"id": 1234,
"label": "my-volume",
"status": "active",
"region": "us-east",
"created": "2018-01-01T00:01:01",
"updated": "2018-01-01T00:01:01",
"tags": [],
"size": 30,
"linode_id": 12346,
"filesystem_path": "/dev/disk/by-id/scsi-0Linode_Volume_my-volume",
"linode_label": "linode123",
"hardware_type": "nvme"
}Responses
200: The updated Volume.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
Volume Delete
https://api.linode.com/v4/volumes/{volumeId}Deletes a Volume you have permission to read_write.
Deleting a Volume is a destructive action and cannot be undone.
Deleting stops billing for the Volume. You will be billed for time used within the billing period the Volume was active.
Volumes that are migrating cannot be deleted until the migration is finished.
Path Parameters
ID of the Volume to look up.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/volumes/12345
Response Samples
- 200
- default
{}Responses
200: Volume deletion successful.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.