show

Volumes

Volume Management (Block Storage).

Retrieve volume's events

GET
/volumes/{id}/events

Returns a list of the current volume’s events

  • Parameters
  • id
    string  (required)in path

    Volume UUID

    include
    stringin query

    related attributes to include

    page
    integerin query

    page to display, default to 1, max 100_000

    per_page
    integerin query

    items per page, default to 10, max 1_000

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Retrieve the custom metadata of a storage volume

GET
/storage/{id}/customdata

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

Retrieve all volume attachment

GET
/storage/{id}/attachments

Returns a list of the current volume’s attachments.

  • Parameters
  • id
    string  (required)in path

    Volume UUID

    include
    stringin query

    related attributes to include

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Attach your volume

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

    device_id

    { "device_id": "string"}

Retrieve an attachment

GET
/storage/attachments/{id}

Returns a single attachment if the user has access

  • Parameters
  • id
    string  (required)in path

    Attachment UUID

    include
    stringin query

    related attributes to include

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Detach volume

DELETE
/storage/attachments/{id}

Detach volume.

  • Parameters
  • id
    string  (required)in path

    Attachment UUID

Retrieve all volume snapshot

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
    stringin query

    related attributes to include

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Delete volume snapshot

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

POST
/storage/{id}/snapshot-policies

Creates a new snapshot policy of your volume.

  • Parameters
  • id
    string  (required)in path

    Volume UUID

    snapshot_count
    integerin query

    Snapshot count

    snapshot_frequency
    string  (required)in query

    Snapshot frequency

Update the volume snapshot policy

PUT
/storage/snapshot-policies/{id}

Updates the volume snapshot policy.

  • Parameters
  • id
    string  (required)in path

    Snapshot Policy UUID

    snapshot_count
    integerin query

    Snapshot count

    snapshot_frequency
    string  (required)in query

    Snapshot frequency

Delete the volume snapshot policy

DELETE
/storage/snapshot-policies/{id}

Deletes the volume snapshot policy.

  • Parameters
  • id
    string  (required)in path

    Snapshot Policy UUID

Retrieve all volumes

GET
/projects/{id}/storage

Returns a list of the current projects’s volumes.

  • Parameters
  • id
    string  (required)in path

    Project UUID

    include
    stringin query

    related attributes to include

    page
    integerin query

    page to display, default to 1, max 100_000

    per_page
    integerin query

    items per page, default to 10, max 1_000

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Create a volume

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

    facility, plan, size

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

Retrieve a volume

GET
/storage/{id}

Returns a single volume if the user has access

  • Parameters
  • id
    string  (required)in path

    Volume UUID

    include
    stringin query

    related attributes to include

  •  
  • Response BodyShowHide
  • Request URLShowHide
  • cURLShowHide

Update the volume

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": "string"}

Delete the volume

DELETE
/storage/{id}

Deletes the volume.

  • Parameters
  • id
    string  (required)in path

    Volume UUID

Restore volume

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

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
    stringin query

    snapshot timestamp

Navigate with  api navigate