canonical: https://jentic.com/apis/proxmox.com/proxmox

# Proxmox VE API

Proxmox VE uses a REST-like API for managing virtual machines, containers, storage, networking, clusters, and access control. The API supports JSON as the primary data format and uses JSON Schema for formal definition. The API exposes 16 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create authentication ticket, get API index. Covers 16 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for cloud infrastructure only.

## Capabilities

- Create authentication ticket
- Get API index
- List cluster nodes
- Start a virtual machine

## Use cases

### Cloud Infrastructure Operations

Use the Proxmox VE API to perform cloud infrastructure operations programmatically. The API provides 16 endpoints covering core functionality including create authentication ticket, get API index, get proxmox ve version.

Example prompt: Call POST `/access/ticket` to create authentication ticket

### Automated Access Management

Automate access operations by combining multiple Proxmox VE API endpoints. Agents can get API index and then get proxmox ve version in a single workflow.

Example prompt: Call GET / to get API index, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Proxmox VE API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create authentication ticket', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/access/ticket` | Create authentication ticket |
| GET | `/` | Get API index |
| GET | `/version` | Get Proxmox VE version |
| GET | `/nodes` | List cluster nodes |
| POST | `/nodes/{node}/qemu` | Create a virtual machine |
| GET | `/nodes/{node}/qemu` | List virtual machines |
| POST | `/nodes/{node}/qemu/{vmid}/status/start` | Start a virtual machine |
| POST | `/nodes/{node}/qemu/{vmid}/status/stop` | Stop a virtual machine |

## Key resources

- **Access** — Operations for access
- **Cluster** — Operations for cluster
- **Nodes** — Operations for nodes
- **Pools** — Operations for pools
- **Storage** — Operations for storage

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 65 / 100
- **View full report:** https://jentic.com/apis/proxmox.com/proxmox/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Proxmox VE API by hand means obtaining an access ticket, sending the API token in the Authorization header, and targeting your own host and node names yourself. Through Jentic you install once, import Proxmox VE from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Proxmox puts the node and VM id in the URL path (`/nodes/{node}/qemu/{vmid}/...`), so a rule can pin your agent to one node or virtual machine. You choose the operations it may call, so state changes like stopping a VM are not included unless you add them.
- **Credential handling:** Your Proxmox VE API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list nodes' or 'start a virtual machine', and Jentic returns the matching Proxmox operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Amazonaws** — Alternative cloud infrastructure API
- **Azure** — Alternative cloud infrastructure API
- **Googleapis** — Complementary cloud infrastructure API
- **Digitalocean** — Complementary cloud infrastructure API

## FAQ

### What authentication does the Proxmox VE API use?

The Proxmox VE API uses an API key passed in the `PVEAuthCookie` cookie. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create authentication ticket with the Proxmox VE API?

Yes. Use the POST `/access/ticket` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Proxmox VE API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create authentication ticket through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create authentication ticket'. Jentic returns the matching Proxmox VE API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Proxmox VE API have?

The Proxmox VE API exposes 16 endpoints covering access, cluster, nodes operations.

### Can I limit what my agent is allowed to do with the Proxmox VE API?

Yes. Jentic One runs on your own infrastructure, so your rules decide which Proxmox VE operations and credentials the agent may use. Because Proxmox puts the node and VM id in the URL path (`/nodes/{node}/qemu/{vmid}/...`), you can pin the agent to a single node or virtual machine. You also choose exactly which operations it can call, so state changes such as stopping a VM via POST `/nodes/{node}/qemu/{vmid}/status/stop` are excluded unless you grant them.