---
title: "Replace virtual machine QEMU Guest Agent configuration"
method: PUT
path: "/vm/{rid}/options/qemu-guest-agent"
tags: ["VM"]
---

# Replace virtual machine QEMU Guest Agent configuration

`PUT /vm/{rid}/options/qemu-guest-agent`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/vm/{rid}/options/qemu-guest-agent`
- Auth: API key in header `Authorization`

Enable or disable the QEMU Guest Agent channel for a shut-off virtual machine

## Path parameters

- `rid` integer, required

## Request body

- InternalHandlersVmModifyQemuGuestAgentRequest
  - `enabled` boolean, required

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseAny
  - `data` unknown
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `413`: Request Entity Too Large
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-08-12** `9a5026bf9057`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/vm/:rid/options/qemu-guest-agent/put.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)