Volumes

Clone Volume

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

Creates a Volume on your Account. In order for this request to complete successfully, your User must have the add_volumes grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account.

Authorizations

Personal Access Token
OAuth: ( volumes:read_write)

Path Parameters

volumeId
Required
integer

ID of the Volume to clone.

Request Body Schema

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

The Volume's label is for display 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/clone

Response Samples

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

Responses

200: Clone started.

id
integer

The unique ID of this Volume.

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

The Volume's label is for display purposes only.

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.
tags
Filterable
array of objects

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

created
string <date-time>

When this Volume was created.

updated
string <date-time>

When this Volume was last updated.

size
integer

The Volume's size, in GiB.

region
string

The unique ID of this Region.

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.

linode_label
Nullable
string

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

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.