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

**Get VPS firmware mode**

Return firmware mode and readiness flags. `incus` means UEFI with Secure Boot and TPM 2.0; `legacy` means BIOS without TPM. Stop the VPS before changing firmware mode if `actions.canChangeMode.allowed` is false.

### Related Endpoints

- `PUT /api/v2/vps/{id}/firmware`: Change VPS firmware mode
- `GET /api/v2/vps/{id}`: Get VPS details
- `GET /api/v2/vps/{id}/iso`: List VPS ISO media

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:vm`

### Parameters

- `id` (path, string, required): Public VPS ID. Get it from GET /api/v2/vps `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/firmware" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `status` (string,null, required) Example: `running`
- `bios` (string,null, required) Example: `seabios`
- `machine` (string,null, required) Example: `q35`
- `mode` (string,null, required) Example: `legacy`
- `efi` (object | null, required) Example: `null`
- `efi.volume` (string,null, required) Example: `null`
- `efi.type` (string,null, required) Example: `null`
- `efi.size` (string,null, required) Example: `null`
- `efi.preEnrolledKeys` (boolean,null, required) Example: `null`
- `tpm` (object | null, required) Example: `null`
- `tpm.volume` (string,null, required) Example: `null`
- `tpm.size` (string,null, required) Example: `null`
- `tpm.version` (string,null, required) Example: `null`
- `secureBootReady` (boolean, required) Example: `false`
- `tpmReady` (boolean, required) Example: `false`
- `actions` (object, required)
- `actions.canChangeMode` (object, required)
- `actions.canChangeMode.allowed` (boolean, required) Example: `false`
- `actions.canChangeMode.reason` (string,null, required) Example: `Firmware changes are not allowed while the VM is running. Stop the VM first.`

### Responses

#### 200 - Firmware state.
```json
{
  "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."
    }
  }
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```