--- title: Obtenir le volume attaché par ID slug: obtenir-le-volume-attache-par-id docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "Cw16aUhpCDLEiZXx4Jmsx", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}" } ], "name": "Get Attached Volume by ID", "description": "Retrieves the properties of the volume attached to the specified server.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "datacenterId", "type": "string", "description": "The unique ID of the data center." }, { "kind": "required", "name": "serverId", "type": "string", "description": "The unique ID of the server." }, { "kind": "required", "name": "volumeId", "type": "string", "description": "The unique ID of the volume." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

Controls whether the response is pretty-printed (with indentations and new lines).

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects.\nGET /datacenters/[ID]\n- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n- depth=1: Direct properties and children references are included.\n- depth=2: Direct properties and children properties are included.\n- depth=3: Direct properties and children properties and children's children are included.\n- depth=... and so on

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Volume", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/VolumeProperties", "customType": "VolumeProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "type", "kind": "optional", "type": "string", "description": "

Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.

", "example": "HDD", "enum": [ "HDD", "SSD", "SSD Standard", "SSD Premium", "DAS", "ISO" ] }, { "name": "size", "kind": "required", "type": "number", "description": "The size of the volume in GB.", "example": 100 }, { "name": "availabilityZone", "kind": "optional", "type": "string", "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.

", "example": "AUTO", "enum": [ "AUTO", "ZONE_1", "ZONE_2", "ZONE_3" ] }, { "name": "image", "kind": "optional", "type": "string", "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.

", "example": "d6ad1576-fde9-4696-aa41-1ebd75bdaf49" }, { "name": "imagePassword", "kind": "optional", "type": "string", "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.

", "example": "mypass123" }, { "name": "sshKeys", "kind": "optional", "type": "array", "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.

", "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\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "bus", "kind": "optional", "type": "string", "description": "

The bus type for this volume; default is VIRTIO.

", "example": "VIRTIO", "enum": [ "VIRTIO", "IDE", "UNKNOWN" ] }, { "name": "licenceType", "kind": "optional", "type": "string", "description": "OS type for this volume.", "example": "LINUX" }, { "name": "applicationType", "kind": "optional", "type": "string", "description": "The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN.", "example": "MSSQL-2019-Standard", "modelRef": "#/components/schemas/ApplicationType", "customType": "ApplicationType", "schema": [] }, { "name": "cpuHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable CPU (no reboot required).

", "example": true }, { "name": "ramHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable RAM (no reboot required).

", "example": true }, { "name": "nicHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable NIC (no reboot required).

", "example": true }, { "name": "nicHotUnplug", "kind": "optional", "type": "boolean", "description": "

Hot-unplug capable NIC (no reboot required).

", "example": true }, { "name": "discVirtioHotPlug", "kind": "optional", "type": "boolean", "description": "

Hot-plug capable Virt-IO drive (no reboot required).

", "example": true }, { "name": "discVirtioHotUnplug", "kind": "optional", "type": "boolean", "description": "

Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.

", "example": true }, { "name": "exposeSerial", "kind": "optional", "type": "boolean", "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

", "example": true, "modelRef": "#/components/schemas/ExposeSerial", "customType": "ExposeSerial", "schema": [] }, { "name": "requireLegacyBios", "kind": "optional", "type": "boolean", "description": "Indicates if the image requires the legacy BIOS for compatibility or specific needs.", "example": true, "default": true, "modelRef": "#/components/schemas/RequireLegacyBios", "customType": "RequireLegacyBios", "schema": [] }, { "name": "deviceNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.

", "example": 3, "format": "int64" }, { "name": "pciSlot", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.

", "example": 7, "format": "int32" }, { "name": "backupunitId", "kind": "optional", "type": "string", "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.", "example": "25f67991-0f51-4efc-a8ad-ef1fb31a481c", "format": "uuid" }, { "name": "userData", "kind": "optional", "type": "string", "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.

" }, { "name": "bootServer", "kind": "optional", "type": "string", "readOnly": true, "description": "The UUID of the attached server.", "example": "25f67991-0f51-4efc-a8ad-ef1fb31a481c" }, { "name": "bootOrder", "kind": "optional", "type": "string", "nullable": true, "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.\nA 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.

", "example": "AUTO", "default": "AUTO", "enum": [ "AUTO", "NONE", "PRIMARY" ] } ] } ], "modelRef": "#/components/schemas/Volume", "isExpanded": true } ] }, { "statusCode": "default", "description": "

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).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Iq_qK2Cjxc_xMmjq3jgzI", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "LkJoKz-rZi35hCCkGhqTV", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WKtijnAeqAA8A4AO6GPEj", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "SuG6blM4TxAMMJud9WwEU", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}?pretty=true&depth=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Iq_qK2Cjxc_xMmjq3jgzI" }, "results": { "languages": [ { "id": "QYsrPbAU0uYeLBE-Vg1sy", "language": "200", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My resource\",\n \"type\": \"HDD\",\n \"size\": 100,\n \"availabilityZone\": \"AUTO\",\n \"image\": \"d6ad1576-fde9-4696-aa41-1ebd75bdaf49\",\n \"imagePassword\": \"mypass123\",\n \"sshKeys\": [\n \"\"\n ],\n \"bus\": \"VIRTIO\",\n \"licenceType\": \"LINUX\",\n \"applicationType\": \"MSSQL-2019-Standard\",\n \"cpuHotPlug\": true,\n \"ramHotPlug\": true,\n \"nicHotPlug\": true,\n \"nicHotUnplug\": true,\n \"discVirtioHotPlug\": true,\n \"discVirtioHotUnplug\": true,\n \"exposeSerial\": true,\n \"requireLegacyBios\": true,\n \"deviceNumber\": 3,\n \"pciSlot\": 7,\n \"backupunitId\": \"25f67991-0f51-4efc-a8ad-ef1fb31a481c\",\n \"userData\": \"\",\n \"bootServer\": \"25f67991-0f51-4efc-a8ad-ef1fb31a481c\",\n \"bootOrder\": \"AUTO\"\n }\n}" }, { "id": "gEOOT2FD7u6hKVLRtkZLT", "language": "default", "code": "// 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).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "QYsrPbAU0uYeLBE-Vg1sy" } }, "children": [ { "text": "", "id": "ptH2sMhpQ2AsqVl8E8daX" } ] }