---
title: "Get virtual machine guest-agent information"
method: GET
path: "/vm/{rid}/guest-agent"
tags: ["VM"]
---

# Get virtual machine guest-agent information

`GET /vm/{rid}/guest-agent`

Retrieve operating-system and network information reported by the QEMU Guest Agent of a running virtual machine

## Path parameters

- `rid` integer, required

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQemuGuestAgentInfo
  - `data` GithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQemuGuestAgentInfo
    - `interfaces` GithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQGANetworkInterface[]
      - `hardware-address` string
      - `ip-addresses` GithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQGANetworkIPAddress[]
        - `ip-address` string
        - `ip-address-type` string
        - `prefix` integer
      - `name` string
      - `statistics` GithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQGANetworkStatistics
        - `rx-bytes` integer
        - `rx-dropped` integer
        - `rx-errs` integer
        - `rx-packets` integer
        - `tx-bytes` integer
        - `tx-dropped` integer
        - `tx-errs` integer
        - `tx-packets` integer
    - `osInfo` GithubComAlchemillahqSylveInternalInterfacesServicesLibvirtQGAOSInfo
      - `id` string
      - `kernel-release` string
      - `kernel-version` string
      - `machine` string
      - `name` string
      - `pretty-name` string
      - `version` string
      - `version-id` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `409` — Conflict
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.net/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alchemillahq/sylve-api/revisions/7a7bea85004e/schema)