Partially modify volumes
1 min
PATCH
https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes/{volumeId}
Path Parameters
- datacenterIdstringrequiredDescription
- volumeIdstringrequiredDescription
Query Parameters
- prettybooleanDescriptionDefaulttrue
- depthinteger<int32>DescriptionDefault0Formatint32Minimum0Maximum10
Header Parameters
- X-Contract-Numberinteger<int32>DescriptionFormatint32
Body Parameters
- bodyobjectrequiredDescription
- objectVolumeProperties
- namestringExampleDescription
- typestring<HDD | SSD | SSD Standard | SSD Premium | DAS | ISO>ExampleDescriptionAllowedHDDSSDSSD StandardSSD PremiumDASISO
- sizenumberrequiredExampleDescription
- availabilityZonestring<AUTO | ZONE_1 | ZONE_2 | ZONE_3>ExampleDescriptionAllowedAUTOZONE_1ZONE_2ZONE_3
- imagestringExampleDescription
- imagePasswordstringExampleDescription
- 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 - busstring<VIRTIO | IDE | UNKNOWN>ExampleDescriptionAllowedVIRTIOIDEUNKNOWN
- licenceTypestringExampleDescription
- applicationTypeApplicationTypeExampleDescription
- cpuHotPlugbooleanExampleDescription
- ramHotPlugbooleanExampleDescription
- nicHotPlugbooleanExampleDescription
- nicHotUnplugbooleanExampleDescription
- discVirtioHotPlugbooleanExampleDescription
- discVirtioHotUnplugbooleanExampleDescription
- exposeSerialExposeSerialExampleDescription
- requireLegacyBiosRequireLegacyBiosExampleDescriptionDefaulttrue
- deviceNumberinteger<int64>ExampleDescriptionFormatint64
- pciSlotinteger<int32>ExampleDescriptionFormatint32
- backupunitIdstring<uuid>ExampleDescriptionFormatuuid
- userDatastringDescription
- bootServerstringExampleDescription
- bootOrderstring<AUTO | NONE | PRIMARY>ExampleDescriptionDefaultAUTOAllowedAUTONONEPRIMARY
- objectImageAlias
- imageAliasstringDescription
Responses
202
- Volume
- idstringExampleDescription
- typeobject
- Type
- hrefstring<uri>ExampleDescriptionFormaturi
- metadataDatacenterElementMetadata
- etagstringExampleDescription
- createdDatestring<date-time>ExampleDescriptionFormatdate-time
- createdBystringExampleDescription
- createdByUserIdstringExampleDescription
- lastModifiedDatestring<date-time>ExampleDescriptionFormatdate-time
- lastModifiedBystringExampleDescription
- lastModifiedByUserIdstringExampleDescription
- statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>ExampleDescriptionAllowedAVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
- propertiesVolumePropertiesrequired
- namestringExampleDescription
- typestring<HDD | SSD | SSD Standard | SSD Premium | DAS | ISO>ExampleDescriptionAllowedHDDSSDSSD StandardSSD PremiumDASISO
- sizenumberrequiredExampleDescription
- availabilityZonestring<AUTO | ZONE_1 | ZONE_2 | ZONE_3>ExampleDescriptionAllowedAUTOZONE_1ZONE_2ZONE_3
- imagestringExampleDescription
- imagePasswordstringExampleDescription
- 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 - busstring<VIRTIO | IDE | UNKNOWN>ExampleDescriptionAllowedVIRTIOIDEUNKNOWN
- licenceTypestringExampleDescription
- applicationTypeApplicationTypeExampleDescription
- cpuHotPlugbooleanExampleDescription
- ramHotPlugbooleanExampleDescription
- nicHotPlugbooleanExampleDescription
- nicHotUnplugbooleanExampleDescription
- discVirtioHotPlugbooleanExampleDescription
- discVirtioHotUnplugbooleanExampleDescription
- exposeSerialExposeSerialExampleDescription
- requireLegacyBiosRequireLegacyBiosExampleDescriptionDefaulttrue
- deviceNumberinteger<int64>ExampleDescriptionFormatint64
- pciSlotinteger<int32>ExampleDescriptionFormatint32
- backupunitIdstring<uuid>ExampleDescriptionFormatuuid
- userDatastringDescription
- bootServerstringExampleDescription
- bootOrderstring<AUTO | NONE | PRIMARY>ExampleDescriptionDefaultAUTOAllowedAUTONONEPRIMARY
Response Headers
- X-RateLimit-Remaininginteger<int32>DescriptionFormatint32
- X-RateLimit-Limitinteger<int32>DescriptionFormatint32
- X-RateLimit-Burstinteger<int32>DescriptionFormatint32
- LocationstringDescriptionPatternhttps://[apiBaseUri]/requests/[requestId]/status
default
- Error
- httpStatusinteger<int32>ExampleDescriptionFormatint32
- messagesErrorMessage[]
- errorCodestringExampleDescription
- messagestringExampleDescription
curl
curl --request PATCH \
--url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes/{volumeId}?pretty=true&depth=integer%3Cint32%3E' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"size": 100,
"requireLegacyBios": true,
"bootOrder": "AUTO"
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"size": 100,
"requireLegacyBios": true,
"bootOrder": "AUTO"
});
var requestOptions = {
method: 'PATCH',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes/{volumeId}?pretty=true&depth=integer<int32>", 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/{volumeId}?pretty=true&depth=integer<int32>")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"size": 100,
"requireLegacyBios": true,
"bootOrder": "AUTO"
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/volumes/{volumeId}?pretty=true&depth=integer<int32>"
payload = json.dumps({
"size": 100,
"requireLegacyBios": True,
"bootOrder": "AUTO"
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
202
// Successful operation
{
"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"
}
}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.