volumes
Creates, updates, deletes, gets or lists a volumes resource.
Overview
| Name | volumes |
| Type | Resource |
| Id | linode.linode.volumes |
Fields
The following fields are returned by SELECT queries:
- list
Returns the Block Storage volumes attached to this Linode.
| Name | Datatype | Description |
|---|---|---|
id | integer | Read-only The unique identifier for the volume. |
linode_id | integer | The unique identifier of the Linode this volume is attached to, if applicable. |
created | string (date-time) | Read-only When this volume was created. (example: 2025-01-01T00:01:01) |
encryption | string | Read-only Whether encryption is enabled on this volume. (enabled, disabled) (example: enabled) |
filesystem_path | string | Read-only The full file system path for the volume, based on its label. The path is /dev/disk/by-id/scsi-0Linode_Volume_label. (example: /dev/disk/by-id/scsi-0Linode_Volume_my-volume) |
hardware_type | string | Read-only The storage type of this volume. This can be either hdd to emulate a hard disk drive for the volume, or nvme to emulate a non-volatile memory express solid state drive. (hdd, nvme) (example: nvme) |
io_ready | boolean | Read-only Indicates whether the volume is successfully attached to a Linode and ready for read and write operations. |
label | string | Filterable The name of the volume. A label can be up to 32 characters long and contain alphanumeric characters, hyphens, and underscores. This value is also used in the volume's filesystem_path. (example: my-volume, pattern: ^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$) |
linode_label | string | Read-only The name of the Linode this volume is attached to, if applicable. (example: linode123) |
region | string | The unique identifier for the region where the volume lives. (example: us-iad) |
size | integer | The volume's size, in gigabytes. |
status | string | Read-only The current status of the volume. This can be one of: - creating. The API is creating the volume and it's not ready for use. - active. The volume is online and ready for use. - resizing. The volume's capacity is being upgraded. - key_rotating. The volume's encryption keys are being rotated to new values. Requests to resize, delete, or clone a volume fail during encryption key rotation. (creating, active, resizing, key_rotating) (example: active) |
tags | array | Filterable Any tags applied to this object. Use tags to label and organize your cloud computing resources. |
updated | string (date-time) | Read-only When this volume was last updated. (example: 2025-01-01T00:01:01) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | linodeId | page, page_size | View the Block Storage volumes attached to this Linode. Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
linodeId | string | ID of the Linode to look up. |
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT examples
- list
View the Block Storage volumes attached to this Linode.
Learn more...
Learn more...
SELECT
id,
linode_id,
created,
encryption,
filesystem_path,
hardware_type,
io_ready,
label,
linode_label,
region,
size,
status,
tags,
updated
FROM linode.linode.volumes
WHERE linodeId = '{{ linodeId }}' -- required
AND page = '{{ page }}'
AND page_size = '{{ page_size }}'
;