Volumes

View Volume

get
https://api.linode.com/v4/volumes/{volumeId}

Get information about a single Volume.

Authorizations

Personal Access Token
OAuth: ( volumes:read_only)

Path Parameters

volumeId
Required
integer

ID of the Volume to look up.

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 100]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/volumes/12345

Response Samples

{
  "id": 1234,
  "created": "2018-01-01T00:01:01",
  "status": "active",
  "label": "my-volume",
  "tags": [],
  "size": 30,
  "region": "us-east",
  "updated": "2018-01-01T00:01:01",
  "linode_id": 12346,
  "filesystem_path": "/dev/disk/by-id/scsi-0Linode_Volume_my-volume"
}

Responses

200: Returns a single Volume object.

id
integer

The unique ID of this Volume.

created
string <date-time>

When this Volume was created.

status
string
Enum: "creating""active""resizing""contact_support"

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.
  • contact_support - there is a problem with your Volume. Please open a Support Ticket to resolve the issue.
label
Filterable
string [1 .. 32] characters ^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$

The Volume's label is for display purposes only.

tags
Filterable
array of objects

An array of Tags applied to this object. Tags are for organizational purposes only.

size
integer

The Volume's size, in GiB.

region
string

The unique ID of this Region.

updated
string <date-time>

When this Volume was last updated.

linode_id
Nullable
integer

If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.

filesystem_path
string

The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0LinodeVolume + Volume label.

default: Error

errors
array of objects
reason
string

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.

field
string

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.

Update Volume

put
https://api.linode.com/v4/volumes/{volumeId}

Updates a Volume that you have permission to read_write.

Authorizations

Personal Access Token
OAuth: ( volumes:read_write)

Path Parameters

volumeId
Required
integer

ID of the Volume to look up.

Request Body Schema

label
Filterable
string [1 .. 32] characters ^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$

The Volume's label is for display purposes only.

linode_id
integer

If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.

size
integer

The Volume's size, in GiB.

tags
Filterable
array

An array of Tags applied to this object. Tags are for organizational purposes only.

Request Samples

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

{
  "id": 1234,
  "label": "my-volume",
  "status": "active",
  "tags": [],
  "created": "2018-01-01T00:01:01",
  "size": 30,
  "region": "us-east",
  "updated": "2018-01-01T00:01:01",
  "linode_id": 12346,
  "filesystem_path": "/dev/disk/by-id/scsi-0Linode_Volume_my-volume"
}

Responses

200: The updated Volume.

default: Error

errors
array of objects
reason
string

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.

field
string

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.

Delete 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.

Authorizations

Personal Access Token
OAuth: ( volumes:read_write)

Path Parameters

volumeId
Required
integer

ID of the Volume to look up.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/volumes/12345

Response Samples

{}

Responses

200: Volume deletion successful.

default: Error

errors
array of objects
reason
string

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.

field
string

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.