Skip to content

Get VPS firmware mode

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

Get the firmware the VPS boots with. mode: "incus" is UEFI with Secure Boot and TPM 2.0. mode: "legacy" is any other setup, usually BIOS without TPM. actions.canChangeMode is false while the VPS is running. Stop it before you change the mode with PUT /api/v2/vps/{id}/firmware. A VPS that is still being set up answers 409 vps_not_ready. A VPS that has ended answers 409 service_not_active.

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}/firmware
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/firmware" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Firmware state.

Response 200
{
"status": "running",
"bios": "seabios",
"machine": "q35",
"mode": "legacy",
"efi": {
"volume": null,
"type": null,
"size": null,
"preEnrolledKeys": null
},
"tpm": {
"volume": null,
"size": null,
"version": null
},
"secureBootReady": false,
"tpmReady": false,
"actions": {
"canChangeMode": {
"allowed": false,
"reason": "Firmware changes are not allowed while the VM is running. Stop the VM first."
}
}
}
Response fields
statusstring or null
Power state of the VPS, for example running or stopped.
biosstring or null
ovmf (UEFI) or seabios (BIOS).
machinestring or null
Machine type, for example q35. Null when not set.
modestring or null
incus: UEFI with Secure Boot and TPM 2.0. legacy: any other setup, usually BIOS without TPM.
efiobject | null
The EFI disk that holds the UEFI settings.
volumestring or null
Storage volume of the EFI disk. Null without one.
typestring or null
EFI disk format, for example 4m. Null without one.
sizestring or null
Size of the EFI disk, for example 528K. Null without one.
preEnrolledKeysstring or null
The EFI disk’s pre-enrolled keys setting, "0" or "1". Null without an EFI disk. One of 0, 1.
tpmobject | null
The TPM state disk.
volumestring or null
Storage volume of the TPM state. Null without one.
sizestring or null
Size of the TPM state. Null without one.
versionstring or null
TPM version, for example v2.0. Null without a TPM.
secureBootReadyboolean
True when UEFI with Secure Boot is set up.
tpmReadyboolean
True when a TPM 2.0 is attached.
actionsobject
canChangeModeobject
Whether the mode can be changed now. False while the VPS is running.
allowedboolean
reasonstring or null

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.
409The VPS is still being set up (vps_not_ready) or the service is no longer active (service_not_active). Both bodies carry actions.canReadFirmware and actions.canChangeFirmware with the reason.
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.