Volumes - Equinix Metal API Documentation

Volumes copied!

Volume Management (Block Storage). Notice: Block storage support will be deprecated soon. Please check here: https://metal.equinix.com/developers/docs/resilience-recovery/elastic-block-storage/ for more details.

Retrieve volume's events copied!

GET

/volumes/{id}/events

Returns a list of the current volume’s events

Parameters

id: string (required) in path
Volume UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

page

integer in query (minimum: 1) (maximum: 100000)

Page to return

Default: 1

per_page

integer in query (minimum: 1) (maximum: 1000)

Items returned per page

Default: 10

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Retrieve the custom metadata of a storage volume copied!

GET

/storage/{id}/customdata

Provides the custom metadata stored for this storage volume in json format

Parameters

id: string (required) in path
Storage Volume UUID

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Retrieve all volume attachment copied!

GET

/storage/{id}/attachments

Returns a list of the current volume’s attachments.

Parameters

id: string (required) in path
Volume UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Attach your volume copied!

POST

/storage/{id}/attachments

Attach your volume to a device.

Parameters

id: string (required) in path
Volume UUID

attachment

(required) in body

Device to attach

Required : device_id

{
    "device_id": "string"
}

Retrieve an attachment copied!

GET

/storage/attachments/{id}

Returns a single attachment if the user has access

Parameters

id: string (required) in path
Attachment UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Detach volume copied!

DELETE

/storage/attachments/{id}

Detach volume.

Parameters

id: string (required) in path
Attachment UUID

Retrieve all volume snapshot copied!

GET

/storage/{id}/snapshots

Returns a list of the current volume’s snapshots. To create Volume Snapshots, please check the Volume Snapshot Policies feature.

Parameters

id: string (required) in path
Volume UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Delete volume snapshot copied!

DELETE

/storage/{volume_id}/snapshots/{id}

Delete volume snapshot.

Parameters

volume_id: string (required) in path
Volume UUID

id: string (required) in path
Snapshot UUID

Create a volume snapshot policy copied!

POST

/storage/{id}/snapshot-policies

Creates a new snapshot policy of your volume.

Parameters

id: string (required) in path
Volume UUID

snapshot_count: integer in query
Snapshot count

snapshot_frequency: string (required) in query
Snapshot frequency

Update the volume snapshot policy copied!

PUT

/storage/snapshot-policies/{id}

Updates the volume snapshot policy.

Parameters

id: string (required) in path
Snapshot Policy UUID

snapshot_count: integer in query
Snapshot count

snapshot_frequency: string (required) in query
Snapshot frequency

Delete the volume snapshot policy copied!

DELETE

/storage/snapshot-policies/{id}

Deletes the volume snapshot policy.

Parameters

id: string (required) in path
Snapshot Policy UUID

Retrieve all volumes copied!

GET

/projects/{id}/storage

Returns a list of the current projects’s volumes.

Parameters

id: string (required) in path
Project UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

page

integer in query (minimum: 1) (maximum: 100000)

Page to return

Default: 1

per_page

integer in query (minimum: 1) (maximum: 1000)

Items returned per page

Default: 10

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Create a volume copied!

POST

/projects/{id}/storage

Creates a new volume in our datacenter. The valid attribute values for plan and facility are:

     "facility": "ams1", "ewr1", "nrt1", "sjc1"
     "plan": "storage_1" (Standard), "storage_2" (Performance)

Parameters

id: string (required) in path
Project UUID

volume

(required) in body

Volume to create

Required : facility, plan, size

{
    "description": "string",
    "facility": "string",
    "plan": "string",
    "size": "integer",
    "locked": "boolean",
    "billing_cycle": "string",
    "snapshot_policies": {
        "$ref": "#\/definitions\/SnapshotPolicyInput"
    },
    "customdata": "object"
}

Retrieve a volume copied!

GET

/storage/{id}

Returns a single volume if the user has access

Parameters

id: string (required) in path
Volume UUID

include: array in query
Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

exclude: array in query
Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

Response Body Show Hide

Request URL Show Hide

cURL Show Hide

Update the volume copied!

PUT

/storage/{id}

Updates the volume.

Parameters

id: string (required) in path
Volume UUID

volume

(required) in body

Volume to update

{
    "description": "string",
    "size": "integer",
    "locked": "boolean",
    "billing_cycle": "string",
    "customdata": "object"
}

Delete the volume copied!

DELETE

/storage/{id}

Deletes the volume.

Parameters

id: string (required) in path
Volume UUID

Restore volume copied!

POST

/storage/{id}/restore

Restore the volume to the given snapshot.

Parameters

id: string (required) in path
Volume UUID

restore_point: string (required) in query
restore point

Clone volume/snapshot copied!

POST

/storage/{id}/clone

Clone your volume or snapshot into a new volume. To clone the volume, send an empty body. To promote a volume snapshot into a new volume, include the snapshot_timestamp attribute in the request body.

Parameters

id: string (required) in path
Volume UUID

snapshot_timestamp: string in query
snapshot timestamp