List volumes

1 min

GET

https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes

List all the volumes within the data center.

Path Parameters

datacenterIdstringrequired
Description
The unique ID of the data center.

Query Parameters

prettyboolean
Description
Controls whether the response is pretty-printed (with indentations and new lines).
Default
true
depthinteger<int32>
Description
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
Default
0
Format
int32
Minimum
0
Maximum
10
offsetinteger<int32>
Description
The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).
Default
0
Format
int32
Minimum
0
limitinteger<int32>
Description
The maximum number of elements to return (use together with offset for pagination).
Default
1000
Format
int32
Minimum
1
Maximum
10000

Header Parameters

X-Contract-Numberinteger<int32>
Description
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Format
int32

Responses

200Successful operation

Volumes
- idstring
  Example
  15f67991-0f51-4efc-a8ad-ef1fb31a480c
  Description
  The resource's unique identifier.
- typeobject
  - Type
- hrefstring<uri>
  Example
  <RESOURCE-URI>
  Description
  URL to the object representation (absolute path).
  Format
  uri
- itemsVolume[]
  Description
  Array of items in the collection.
  - idstring
    Example
    15f67991-0f51-4efc-a8ad-ef1fb31a480c
    Description
    The resource's unique identifier.
  - typeobject
    - Type
  - hrefstring<uri>
    Example
    <RESOURCE-URI>
    Description
    The URL to the object representation (absolute path).
    Format
    uri
  - metadataDatacenterElementMetadata
    - etagstring
      Example
      45480eb3fbfc31f1d916c1eaa4abdcc3
      Description
      Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
    - createdDatestring<date-time>
      Example
      2015-12-04T14:34:09.809Z
      Description
      The last time the resource was created.
      Format
      date-time
    - createdBystring
      Example
      [email protected]
      Description
      The user who created the resource.
    - createdByUserIdstring
      Example
      [email protected]
      Description
      The unique ID of the user who created the resource.
    - lastModifiedDatestring<date-time>
      Example
      2015-12-04T14:34:09.809Z
      Description
      The last time the resource was modified.
      Format
      date-time
    - lastModifiedBystring
      Example
      [email protected]
      Description
      The user who last modified the resource.
    - lastModifiedByUserIdstring
      Example
      63cef532-26fe-4a64-a4e0-de7c8a506c90
      Description
      The unique ID of the user who last modified the resource.
    - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
      Example
      AVAILABLE
      Description
      State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
      Allowed
      AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
  - propertiesVolumePropertiesrequired
    - namestring
      Example
      My resource
      Description
      The name of the resource.
    - typestring<HDD | SSD | SSD Standard | SSD Premium | DAS | ISO>
      Example
      HDD
      Description
      Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.
      Allowed
      HDDSSDSSD StandardSSD PremiumDASISO
    - sizenumberrequired
      Example
      100
      Description
      The size of the volume in GB.
    - availabilityZonestring<AUTO | ZONE_1 | ZONE_2 | ZONE_3>
      Example
      AUTO
      Description
      The availability zone in which the volume should be provisioned. The storage volume will be provisioned on as few physical storage devices as possible, but this cannot be guaranteed upfront. This is uavailable for DAS (Direct Attached Storage), and subject to availability for SSD.
      Allowed
      AUTOZONE_1ZONE_2ZONE_3
    - imagestring
      Example
      d6ad1576-fde9-4696-aa41-1ebd75bdaf49
      Description
      Image or snapshot ID to be used as template for this volume. MSSQL Enterprise Images can be used only if the feature toggle for MSSQL Enterprise is enabled on the contract. If the referenced image supports Confidential Computing, additional rules apply: the volume can only be created inline as part of a server creation request (not via standalone volume creation, nor by attaching to an existing server), and exactly one volume on that server may use such an image. The resulting volume is permanently bound to the server as its boot device and cannot be detached or moved to another server.
    - imagePasswordstring
      Example
      mypass123
      Description
      Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9.
    - sshKeysstring[]
      Example
      [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/4JNoFQBsaGV974hDmloS5LOvSJjKpXs8Ed437ln712345", "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/asdfghjkjhyutry545tgvbn76e4rf43" ]
      Description
      Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation.
    - busstring<VIRTIO | IDE | UNKNOWN>
      Example
      VIRTIO
      Description
      The bus type for this volume; default is VIRTIO.
      Allowed
      VIRTIOIDEUNKNOWN
    - licenceTypestring
      Example
      LINUX
      Description
      OS type for this volume.
    - applicationTypeApplicationType
      Example
      MSSQL-2019-Standard
      Description
      The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN.
    - cpuHotPlugboolean
      Example
      true
      Description
      Hot-plug capable CPU (no reboot required).
    - ramHotPlugboolean
      Example
      true
      Description
      Hot-plug capable RAM (no reboot required).
    - nicHotPlugboolean
      Example
      true
      Description
      Hot-plug capable NIC (no reboot required).
    - nicHotUnplugboolean
      Example
      true
      Description
      Hot-unplug capable NIC (no reboot required).
    - discVirtioHotPlugboolean
      Example
      true
      Description
      Hot-plug capable Virt-IO drive (no reboot required).
    - discVirtioHotUnplugboolean
      Example
      true
      Description
      Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.
    - exposeSerialExposeSerial
      Example
      true
      Description
      If set to true will expose the serial id of the disk attached to the server. If set to false will not expose the serial id. Some operating systems or software solutions require the serial id to be exposed to work properly. Exposing the serial can influence licensed software (e.g. Windows) behavior
    - requireLegacyBiosRequireLegacyBios
      Example
      true
      Description
      Indicates if the image requires the legacy BIOS for compatibility or specific needs.
      Default
      true
    - deviceNumberinteger<int64>
      Example
      3
      Description
      The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.
      Format
      int64
    - pciSlotinteger<int32>
      Example
      7
      Description
      The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.
      Format
      int32
    - backupunitIdstring<uuid>
      Example
      25f67991-0f51-4efc-a8ad-ef1fb31a481c
      Description
      The ID of the backup unit that the user has access to. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.
      Format
      uuid
    - userDatastring
      Description
      The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property. This field is blocked for Confidential Computing VM storage.
    - bootServerstring
      Example
      25f67991-0f51-4efc-a8ad-ef1fb31a481c
      Description
      The UUID of the attached server.
    - bootOrderstring<AUTO | NONE | PRIMARY>
      Example
      AUTO
      Description
      Determines whether the volume will be used as a boot volume. Set to NONE, the volume will not be used as boot volume. Set to PRIMARY, the volume will be used as boot volume and all other volumes must be set to NONE. Set to AUTO or null requires all volumes to be set to AUTO or null; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices. A volume with a Confidential Computing image may be created with bootOrder set to PRIMARY (or left unset / AUTO, in which case it is automatically treated as the boot device), but it must not be created with bootOrder set to NONE. Conversely, no other volume attached to the same server is allowed to be set to PRIMARY — only the confidential computing volume can be the boot device.
      Default
      AUTO
      Allowed
      AUTONONEPRIMARY
- offsetPaginationOffsetOptional
  Description
  The offset (if specified in the request).
- limitPaginationLimitOptional
  Example
  1000
  Description
  The limit (if specified in the request).
- _linksPaginationLinks
  - prevstring<uri>
    Example
    <PREVIOUS-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.
    Format
    uri
  - selfstring<uri>
    Example
    <THIS-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the current page.
    Format
    uri
  - nextstring<uri>
    Example
    <NEXT-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.
    Format
    uri

Response Headers

X-RateLimit-Remaininginteger<int32>
Description
The number of requests that can still be made without triggering a failure response.
Format
int32
X-RateLimit-Limitinteger<int32>
Description
The average number of requests per minute allowed.
Format
int32
X-RateLimit-Burstinteger<int32>
Description
The maximum number of concurrent API requests allowed.
Format
int32

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

Error
- httpStatusinteger<int32>
  Example
  400
  Description
  HTTP status code of the operation.
  Format
  int32
- messagesErrorMessage[]
  - errorCodestring
    Example
    123
    Description
    Application internal error code.
  - messagestring
    Example
    Error message example.
    Description
    A human-readable message.

curl

curl --request GET \
     --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes?pretty=true&depth=integer%3Cint32%3E&offset=integer%3Cint32%3E&limit=1000' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": {},
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": {},
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "My resource",
        "type": "HDD",
        "size": 100,
        "availabilityZone": "AUTO",
        "image": "d6ad1576-fde9-4696-aa41-1ebd75bdaf49",
        "imagePassword": "mypass123",
        "sshKeys": [
          ""
        ],
        "bus": "VIRTIO",
        "licenceType": "LINUX",
        "applicationType": "MSSQL-2019-Standard",
        "cpuHotPlug": true,
        "ramHotPlug": true,
        "nicHotPlug": true,
        "nicHotUnplug": true,
        "discVirtioHotPlug": true,
        "discVirtioHotUnplug": true,
        "exposeSerial": true,
        "requireLegacyBios": true,
        "deviceNumber": 3,
        "pciSlot": 7,
        "backupunitId": "25f67991-0f51-4efc-a8ad-ef1fb31a481c",
        "userData": "",
        "bootServer": "25f67991-0f51-4efc-a8ad-ef1fb31a481c",
        "bootOrder": "AUTO"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

default

// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).
{
  "httpStatus": 400,
  "messages": [
    {
      "errorCode": "123",
      "message": "Error message example."
    }
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.