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

**Change VPS firmware mode**

Change firmware mode to `incus` or `legacy`. Use `incus` for UEFI with Secure Boot and TPM 2.0; use `legacy` for BIOS without TPM. Optional `storage` is an advanced placement hint matching `[A-Za-z0-9_-]{1,64}`.

### Related Endpoints

- `GET /api/v2/vps/{id}/firmware`: Get 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 scopes: `write:vm`, `write:storage`
- `Content-Type`: application/json

### 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 Body

- `mode` (string, required) Example: `incus`
  Allowed values: incus, legacy
- `storage` (string, optional) Example: `local-lvm`

### Request Examples

#### Enable UEFI Secure Boot and TPM

```bash
curl -X PUT "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/firmware" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "incus"
  }'
```

```json
{
  "mode": "incus"
}
```

#### Switch back to legacy BIOS

```bash
curl -X PUT "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/firmware" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "legacy"
  }'
```

```json
{
  "mode": "legacy"
}
```

### Response Schema

- `mode` (string, required) Example: `incus`
  Allowed values: incus, legacy
- `summary` (string, required) Example: `Firmware mode was changed to UEFI with Secure Boot and TPM 2.0.`
- `firmware` (object | null, required) Example: `null`
- `firmware.status` (string,null, required) Example: `stopped`
- `firmware.bios` (string,null, required) Example: `ovmf`
- `firmware.machine` (string,null, required) Example: `q35`
- `firmware.mode` (string,null, required) Example: `incus`
- `firmware.efi` (object | null, required) Example: `null`
- `firmware.efi.volume` (string,null, required) Example: `local-lvm:vm-100-disk-0`
- `firmware.efi.type` (string,null, required) Example: `4m`
- `firmware.efi.size` (string,null, required) Example: `4M`
- `firmware.efi.preEnrolledKeys` (boolean, required) Example: `true`
- `firmware.tpm` (object | null, required) Example: `null`
- `firmware.tpm.volume` (string,null, required) Example: `local-lvm:vm-100-disk-1`
- `firmware.tpm.size` (string,null, required) Example: `4M`
- `firmware.tpm.version` (string,null, required) Example: `2.0`
- `firmware.secureBootReady` (boolean, required) Example: `true`
- `firmware.tpmReady` (boolean, required) Example: `true`
- `firmware.actions` (object, required)
- `firmware.actions.canChangeMode` (object, required)
- `firmware.actions.canChangeMode.allowed` (boolean, required) Example: `true`
- `firmware.actions.canChangeMode.reason` (string,null, required) Example: `null`

### Responses

#### 200 - Firmware mode changed.
```json
{
  "mode": "incus",
  "summary": "Firmware mode was changed to UEFI with Secure Boot and TPM 2.0.",
  "firmware": {
    "status": "stopped",
    "bios": "ovmf",
    "machine": "q35",
    "mode": "incus",
    "efi": {
      "volume": "local-lvm:vm-100-disk-0",
      "type": "4m",
      "size": "4M",
      "preEnrolledKeys": true
    },
    "tpm": {
      "volume": "local-lvm:vm-100-disk-1",
      "size": "4M",
      "version": "2.0"
    },
    "secureBootReady": true,
    "tpmReady": true,
    "actions": {
      "canChangeMode": {
        "allowed": true,
        "reason": null
      }
    }
  }
}
```

#### 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"
}
```