Skip to main content
GET
Get hardware settings

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Response

The record, as a JSON object. There is no envelope.

bios_type
enum<string>
required

The boot firmware: seabios is legacy BIOS and ovmf is UEFI.

Available options:
seabios,
ovmf
Example:

"seabios"

sev_snp_enabled
boolean
required

Whether memory encryption is switched on for this server.

Example:

false

sev_snp_supported
boolean
required

Whether the host supports memory encryption. Enabling encryption is rejected if this is false.

Example:

false

guest_agent_enabled
boolean
required

Whether the guest agent is enabled.

Example:

true

tpm_enabled
boolean
required

Whether the server has a virtual TPM 2.0 device.

Example:

false