--- updatedAt: 2026-06-08T17:29:40.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/linode-api/llms.txt --- # Update a volume Update a specific Block Storage volume. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `update_volume` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `volumes:read_write` **CLI** ```shell linode-cli volumes update 12345 \ --label my_volume ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) # OpenAPI definition ````json { "components": { "securitySchemes": { "oauth": { "flows": { "authorizationCode": { "authorizationUrl": "https://login.linode.com/oauth/authorize", "scopes": { "account:read_only": "Allows access to GET information about your account.", "account:read_write": "Allows access to all endpoints related to your account.", "child_account:read_only": "Allows access to GET information about deprecated parent/child operations.", "child_account:read_write": "Allows access to deprecated parent/child operations.", "databases:read_only": "Allows access to GET information about databases.", "databases:read_write": "Allows access to all endpoints related to databases.", "domains:read_only": "Allows access to GET Domains on your account.", "domains:read_write": "Allows access to all Domain endpoints.", "events:read_only": "Allows access to GET your Events.", "events:read_write": "Allows access to all endpoints related to your Events.", "firewall:read_only": "Allows access to GET information about your Firewalls.", "firewall:read_write": "Allows access to all Firewall endpoints.", "images:read_only": "Allows access to GET your Images.", "images:read_write": "Allows access to all endpoints related to your Images.", "ips:read_only": "Allows access to GET your ips.", "ips:read_write": "Allows access to all endpoints related to your ips.", "linodes:read_only": "Allows access to GET Linodes on your account.", "linodes:read_write": "Allow access to all endpoints related to your Linodes.", "lke:read_only": "Allows access to GET LKE Clusters on your account.", "lke:read_write": "Allows access to all endpoints related to LKE Clusters on your account.", "longview:read_only": "Allows access to GET your Longview Clients.", "longview:read_write": "Allows access to all endpoints related to your Longview Clients.", "monitor:read_only": "Allows access to Monitor (Akamai Cloud Pulse) data.", "monitor:read_write": "Allows access to GET Monitor (Akamai Cloud Pulse) data.", "nodebalancers:read_only": "Allows access to GET NodeBalancers on your account.", "nodebalancers:read_write": "Allows access to all NodeBalancer endpoints.", "object_storage:read_only": "Allows access to GET information related to your Object Storage.", "object_storage:read_write": "Allows access to all Object Storage endpoints.", "stackscripts:read_only": "Allows access to GET your StackScripts.", "stackscripts:read_write": "Allows access to all endpoints related to your StackScripts.", "volumes:read_only": "Allows access to GET your Volumes.", "volumes:read_write": "Allows access to all endpoints related to your Volumes.", "vpc:read_write": "Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion." }, "tokenUrl": "https://login.linode.com/oauth/token" } }, "type": "oauth2" }, "personalAccessToken": { "scheme": "bearer", "type": "http" } } }, "externalDocs": { "description": "See documentation for Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference" }, "info": { "description": "\"[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).\"", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Volumes", "version": "4.229.1" }, "openapi": "3.0.1", "paths": { "/{apiVersion}/volumes/{volumeId}": { "put": { "description": "Update a specific Block Storage volume.\n\n\n**Permissions and scopes**\n\nTo call this operation, you need the following:\n\n- **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles).\n - Permissions: `update_volume`\n- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).\n\n - Scopes: `volumes:read_write`\n\n\n**CLI**\n\n```shell\nlinode-cli volumes update 12345 \\\n --label my_volume\n```\n\n[Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-volume" }, "operationId": "put-volume", "requestBody": { "content": { "application/json": { "example": { "label": "my-volume", "tags": [ "blk-stg-volume-1", "videos-storage" ] }, "schema": { "additionalProperties": false, "properties": { "label": { "description": "The name of the volume. A `label` can be up to 32 characters long and contain alphanumeric characters, dashes, and underscores. This value is also used in the volume's `filesystem_path`.", "example": "my-volume", "maxLength": 32, "minLength": 1, "pattern": "^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$", "type": "string" }, "tags": { "description": "Any tags applied to this object. Use [tags](https://techdocs.akamai.com/linode-api/reference/post-tag) to label and organize your cloud computing resources.", "example": [ "blk-stg-volume-1", "videos-storage" ], "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/added-put-volume.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created": "2025-01-01T00:01:01", "encryption": "enabled", "filesystem_path": "/dev/disk/by-id/scsi-0Linode_Volume_my-volume", "hardware_type": "nvme", "id": 12345, "io_ready": true, "label": "my-volume", "linode_id": 12346, "linode_label": "linode123", "locks": [ "cannot_delete" ], "region": "us-iad", "size": 30, "status": "active", "tags": [ "blk-stg-volume-1", "videos-storage" ], "updated": "2025-01-01T00:01:01" }, "schema": { "additionalProperties": false, "description": "A Block Storage volume on your account.", "properties": { "created": { "description": "__Read-only__ When this volume was created.", "example": "2025-01-01T00:01:01", "readOnly": true, "type": "string" }, "encryption": { "description": "__Read-only__ Indicates whether encryption is `enabled` or `disabled` on this volume.", "enum": [ "enabled", "disabled" ], "example": "enabled", "readOnly": true, "type": "string", "x-linode-cli-display": 8 }, "filesystem_path": { "description": "__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", "readOnly": true, "type": "string" }, "hardware_type": { "description": "__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.", "enum": [ "hdd", "nvme" ], "example": "nvme", "readOnly": true, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the volume.", "example": 12345, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "io_ready": { "description": "__Read-only__ Indicates whether the volume is successfully attached to a Linode and ready for read and write operations.", "example": true, "readOnly": true, "type": "boolean" }, "label": { "description": "__Filterable__ The name of the volume. A `label` can be up to 32 characters long and contain alphanumeric characters, dashes, and underscores. This value is also used in the volume's `filesystem_path`.", "example": "my-volume", "maxLength": 32, "minLength": 1, "pattern": "^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$", "type": "string", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-cli-display": 2, "x-linode-filterable": true }, "linode_id": { "description": "The unique identifier of the Linode this volume is attached to, if applicable.", "example": 12346, "nullable": true, "type": "integer", "x-linode-cli-display": 6 }, "linode_label": { "description": "__Read-only__ The name of the Linode this volume is attached to, if applicable.", "example": "linode123", "nullable": true, "readOnly": true, "type": "string", "x-linode-cli-display": 7 }, "locks": { "description": "__Beta__ A resource lock applied to the Block Storage volume. You can optionally [set up this lock](https://techdocs.akamai.com/linode-api/reference/post-resource-lock) to prevent you from inadvertently deleting the volume. Supported values here include:\n\n- `cannot_delete`. The volume itself can't be deleted. Any sub-resources assigned to it can be freely deleted. You need to unlock the volume by [deleting its lock](https://techdocs.akamai.com/linode-api/reference/delete-resource-lock) to delete the volume.\n\n- `cannot_delete_with_subresources`. The volume and various sub-resources assigned to it can't be deleted. For example, if a volume has a configuration profile interface assigned to it, this lock prevents you from deleting either of them. You need to unlock the resource (the volume) by deleting its lock. Then you can delete the volume and any of its sub-resources.\n\n- **Empty**. The volume doesn't have a resource lock configured. This is also empty when you clone a volume, because resource lock settings aren't carried to the cloned volume.\n\n> 📘\n>\n> This array appears for a volume only if you call this operation using the `v4beta` path parameter in the URL.", "example": [ "cannot_delete" ], "items": { "enum": [ "cannot_delete", "cannot_delete_with_subresources" ], "type": "string" }, "type": "array", "x-akamai": { "status": "BETA" } }, "region": { "description": "The unique identifier for the region where the volume lives.", "example": "us-iad", "type": "string", "x-linode-cli-display": 5 }, "size": { "description": "The volume's size, in gigabytes.", "example": 30, "maximum": 10240, "type": "integer", "x-linode-cli-display": 4 }, "status": { "description": "__Read-only__ The current status of the volume. This can be one of:\n\n- `creating`. The API is creating the volume and it's not ready for use.\n\n- `active`. The volume is online and ready for use.\n\n- `resizing`. The volume's capacity is being upgraded.\n\n- `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.", "enum": [ "creating", "active", "resizing", "key_rotating" ], "example": "active", "readOnly": true, "type": "string", "x-linode-cli-color": { "active": "green", "contact_support": "red", "default_": "yellow" }, "x-linode-cli-display": 3 }, "tags": { "description": "__Filterable__ Any tags applied to this object. Use [tags](https://techdocs.akamai.com/linode-api/reference/post-tag) to label and organize your cloud computing resources.", "example": [ "blk-stg-volume-1", "videos-storage" ], "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-filterable": true }, "updated": { "description": "__Read-only__ When this volume was last updated.", "example": "2025-01-01T00:01:01", "readOnly": true, "type": "string" } }, "title": "Volume", "type": "object", "x-akamai": { "file-path": "schemas/volume.yaml" } } } }, "description": "The volume was updated successfully." }, "default": { "content": { "application/json": { "example": { "errors": [ { "reason": "Invalid JSON" } ] }, "schema": { "additionalProperties": false, "properties": { "errors": { "description": "Any warnings associated with a response.", "items": { "additionalProperties": false, "description": "An object for describing a single error that occurred during the processing of a request.", "properties": { "field": { "description": "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.", "example": "fieldname", "type": "string" }, "reason": { "description": "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](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully.", "example": "fieldname must be a valid value", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/error-object.yaml" } }, "type": "array" } }, "type": "object" } } }, "description": "See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes." } }, "security": [ { "personalAccessToken": [] }, { "oauth": [ "volumes:read_write" ] } ], "summary": "Update a volume", "tags": [ "Volumes" ], "x-akamai": { "tabs": [ { "syntax": "linode-cli volumes update 12345 \\\n --label my_volume", "title": "CLI", "url": "https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli" } ] }, "x-linode-cli-action": "update", "x-linode-grant": "read_write", "x-linode-iam": [ { "permissions": [ "update_volume" ] } ] }, "parameters": [ { "description": "__Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.", "in": "path", "name": "apiVersion", "required": true, "schema": { "enum": [ "v4", "v4beta" ], "example": "v4", "type": "string" }, "x-akamai": { "file-path": "parameters/api-version-path.yaml" } }, { "description": "The unique identifier for the target volume. Run the [List volumes](https://techdocs.akamai.com/linode-api/reference/get-volumes) operation and store the `id` for the target volume as your `volumeId`.", "in": "path", "name": "volumeId", "required": true, "schema": { "example": 251, "type": "integer" }, "x-akamai": { "file-path": "parameters/volume-id.yaml" } } ], "x-akamai": { "file-path": "paths/volume.yaml", "path-info": "/{apiVersion}/volumes/{volumeId}" }, "x-linode-cli-command": "volumes" } }, "servers": [ { "url": "https://api.linode.com" } ], "tags": [ { "description": "The Block Storage service lets you add additional storage drives to Linodes, to store more data without resizing your Linode to a larger plan. These storage drives, called volumes, can be formatted with any Linux-compatible file system and attached and mounted to a Linode.", "name": "Volumes" } ], "x-akamai": { "auth-type": "OAUTH", "file-path": "volumes.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ```` # Sibling pages * [Create a volume](https://techdocs.akamai.com/linode-api/reference/post-volume.md) * [List volumes](https://techdocs.akamai.com/linode-api/reference/get-volumes.md) * [Get a volume](https://techdocs.akamai.com/linode-api/reference/get-volume.md) * [Delete a volume](https://techdocs.akamai.com/linode-api/reference/delete-volume.md) * [Attach a volume](https://techdocs.akamai.com/linode-api/reference/post-attach-volume.md) * [Clone a volume](https://techdocs.akamai.com/linode-api/reference/post-clone-volume.md) * [Detach a volume](https://techdocs.akamai.com/linode-api/reference/post-detach-volume.md) * [Resize a volume](https://techdocs.akamai.com/linode-api/reference/post-resize-volume.md)