Skip to content

List ISO images and CD/DVD drives

GET /api/v2/vps/{id}/iso

Lists the ISO images the VPS can use, its CD/DVD drives and its boot order. available[] holds the images you downloaded with POST /api/v2/vps/{id}/iso/actions/from-url and the images Hostup shares with all customers. Mount one with POST /api/v2/vps/{id}/iso/actions/mount. actions.canMount is false when every CD/DVD slot already holds an image.

Authentication: An API key with the scope read:vm. About keys and scopes

Request

Path parameters

idstringrequired
The VPS ID (vps_…).

Example

GET /api/v2/vps/{id}/iso
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/iso" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 ISO images, CD/DVD drives and boot order of the VPS.

Response 200
{
"available": [
{
"id": "iso_01hxa3b4c5d6e7f8g9h0j1k2m3",
"name": "ubuntu-24.04-live-server-amd64.iso",
"displayName": "Ubuntu 24.04 LTS",
"sizeGb": 5.9,
"format": "iso"
}
],
"mounted": [
{
"device": "ide2",
"isoId": "iso_01hxa3b4c5d6e7f8g9h0j1k2m3",
"mounted": true,
"isCloudInit": false
}
],
"bootOrder": {
"order": [
"scsi0",
"ide2"
],
"devices": {
"scsi0": "Disk",
"ide2": "CD/DVD 3"
},
"availableDevices": [
{
"id": "scsi0",
"name": "Disk",
"type": "disk"
},
{
"id": "ide2",
"name": "CD/DVD 3",
"type": "cdrom"
}
]
},
"availableDevices": [
{
"device": "ide2",
"type": "existing_cdrom",
"description": "CD/DVD 3",
"inUse": true
},
{
"device": "ide3",
"type": "available",
"description": "CD/DVD 4",
"inUse": false
}
],
"actions": {
"canMount": {
"allowed": true,
"reason": null
},
"canUpload": {
"allowed": true,
"reason": null
}
}
}
Response fields
availablearray of object
ISO images the VPS can mount.
idstring
The ISO ID (iso_…).
namestring or null
The stored file name. Own downloads carry an account prefix.
displayNamestring or null
The name to show, for example the file name given at download.
sizeGbnumber
Size in gigabytes (1024³ bytes), rounded to three decimals.
formatstring or null
File format, for example iso.
mountedarray of object
The CD/DVD drives of the VPS, with or without an image.
devicestring or null
The drive, for example ide2.
isoIdstring or null
The ID of the image in the drive. Null when the drive is empty.
mountedboolean
True when the drive holds an image.
isCloudInitboolean
Always false. Cloud-init drives are not listed.
bootOrderobject or null
The boot order. Null when it could not be read.
availableDevicesarray of object
CD/DVD slots ide0 to ide3. A free ide1 slot is not offered.
devicestring or null
The slot, for example ide3.
typestring or null
existing_cdrom when the slot has a drive. available when it is free.
descriptionstring or null
Label to show, for example CD/DVD 4.
inUseboolean
True when the drive holds an image.
actionsobject
What the caller can do now.
canMountobject
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.
canUploadobject
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.