List Volumes

Name
get
Type
/v1/volumes
Description
You can get a list of volumes associated with your account by sending a GET.

Request

Example

curl -X GET "https://api.simplystack.com/v1/volumes" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token d359ad9cc9422b5ff07aede0cd2707da4ff82be0"

Response

JSON object with key named volumes. The value of volumes will return an array with the following identifiers:

💡

Note: In order to execute the method for certain volumes available in specific region or regions, user should use the syntax region i.e. /v2/volumes?region=fra

Attributes

See volume model.

Example

json

{
  "volumes": [
    {
      "id": "6c848d7f-0389-4fdf-95bf-7d4d58d9cc04",
      "name": "volume01",
      "created_at": "2020-01-07T18:37:45.190194Z",
      "task": null
      "region": {
        "available": true,
        "features": [
            "floating_ips"
        ],
        "name": "Frankfurt",
        "slug": "fra"
      },
      "size": 10737418240,
      "size_gigabytes": 10.0,
      "stacklet": null
    },
    {
      "id": "21848c7e-0389-4fdf-95bf-7d4d58d62c22",
      "name": "volume02",
      "created_at": "2020-02-05T12:12:45.172394Z",
      "task": null
      "region": {
        "available": true,
        "features": [
            "floating_ips"
        ],
        "name": "Frankfurt",
        "slug": "fra"
      },
      "size": 356515840,
      "size_gigabytes": 34.0,
      "stacklet": null
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "pages": 1,
      "per_page": 25,
      "previous_page": null,
      "total": 2
    },
    "query": null,
    "sort": null
  }
}

Create volume Retrieve volume