---
title: "Discover Proxmox guests on a node"
method: POST
path: "/proxmox/discover"
tags: ["Proxmox"]
---

# Discover Proxmox guests on a node

`POST /proxmox/discover`

Connects to an existing SSH host (a Proxmox node) using its stored credentials, runs pvesh to enumerate all guests (VMs and LXC containers) in the cluster, and returns them ready to be imported as Termix hosts. No separate Proxmox API token is required.

## Request body

- object
  - `hostId` number, required — ID of the SSH host that is a Proxmox node.

## Response `200`

Discovered guests.

- object
  - `guests` object[]
    - `name` string
    - `vmid` number
    - `type` 'qemu' | 'lxc'
    - `node` string
    - `status` string
    - `ip` string, nullable
    - `connectionType` 'ssh' | 'rdp'
    - `enableDocker` boolean
  - `credentialId` number, nullable
  - `defaultCredentialId` number, nullable

## Other responses

- `400` — Missing or invalid hostId.
- `401` — Authentication required or session expired.
- `403` — Access denied to the host.
- `404` — Host not found.
- `422` — Host is not a Proxmox node or is unreachable.
- `500` — Discovery failed.

---

[API](https://skmtc.dev/termix/apis/termix-api.md) · [All operations](https://skmtc.dev/termix/apis/termix-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/termix/termix-api/revisions/f4ef343eff1b/schema)