Proxmox VE

Proxmox Virtual Environment (Proxmox VE) is an open-source server virtualization platform that combines KVM hypervisor and LXC containers, software-defined storage and networking, and clustering and high- availability features in a single web-managed solution. The Proxmox VE API exposes all platform operations under /api2/json on port 8006, including node, cluster, storage, pool, and access management endpoints. Supported authentication methods include stateless API tokens (PVEAPIToken header) and ticket-based sessions issued via /access/ticket.

Proxmox VE publishes 5 API contracts indexed on the APIs.io network, including Access API, Cluster API, Containers API, and 2 more. Tagged areas include Virtualization, KVM, Containers, LXC, and Clustering.

The Proxmox VE catalog on APIs.io includes 1 Spectral governance ruleset.

Proxmox VE’s developer surface includes authentication, documentation, pricing, GitHub presence, and 9 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

26.8/100 thin ▬ flat Agent 19/100 agent aware Front door AI 1/6 silent Heartbeat 98/100 alive saas Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →

1 published contract

Virtualization KVM Containers LXC Clustering Open Source

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Cybersecurity Management

BC-620

Access

POST /access/ticket GET /access/users POST /access/users

Information Technology Management

BC-600

Containers

POST /nodes/{node}/lxc POST /nodes/{node}/lxc/{vmid}/status/start

Kin Score

Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0

Composite quality — 26.8/100 · thin

Contract Quality 8.3 / 19

Developer Ergonomics 3.2 / 15

Access Clarity 1.3 / 15

Operational Transparency 1.4 / 10

Contract Governance 1.2 / 9

Discoverability 5.0 / 8

Regulatory Posture 2.6 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 19/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 0 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/proxmox/"><img src="https://apis.io/badge/proxmox/card.svg" alt="Proxmox VE on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes Ask about this →
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0 Ask about this →
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented) Ask about this →
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link Ask about this →

10 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 8.5 — up to +18.3 composite points Ask about this →
Developer Ergonomics scores 21.4 — up to +15.7 composite points Ask about this →
Contract Quality scores 44.1 — up to +14.0 composite points Ask about this →

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/proxmox/apis.yml: open an issue on github.com/api-evangelist/proxmox to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Obsidian Community Plugins (third-party APIs the Obsidian plugin ecosystem integrates)	unknown	2.5 (thin)	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 5

Individual APIs this provider publishes, each with its own machine-readable definition.

Proxmox VE API

REST-style management API for Proxmox VE covering nodes, virtual machines, containers, storage, networking, clustering, pools, and access management. Authenticated via API token...

Proxmox VE Access API

The Access API from Proxmox VE — 3 operation(s) for access.

Proxmox VE Cluster API

The Cluster API from Proxmox VE — 1 operation(s) for cluster.

Proxmox VE Containers API

The Containers API from Proxmox VE — 2 operation(s) for containers.

Proxmox VE Nodes API

The Nodes API from Proxmox VE — 1 operation(s) for nodes.

Open Collections 5

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Proxmox VE Access API

OPEN COLLECTION

Proxmox VE Access Cluster API

OPEN COLLECTION

Proxmox VE Access Containers API

OPEN COLLECTION

Proxmox VE Access Nodes API

OPEN COLLECTION

Proxmox VE API

OPEN COLLECTION

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

Proxmox VE API Rules

42 rules · 40 error-severity 1 warn-severity 1 info-severity

SPECTRAL

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Proxmox VE Authentication

apiKey · 2 schemes

SECURITY

Proxmox VE Domain Security

TLSv1.3 · HSTS

SECURITY

Proxmox VE Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

Proxmox VE Agentic Access

8 operations · 5 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

GitHub

GitHub

Access & Security 3

Authentication, authorization, and security posture

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 1

Status, limits, changes, and where to get help

Community Forum

Community Forum

Commercial 1

Pricing, plans, and the legal terms of use

Pricing

Pricing

Company 2

The organization behind the API

LinkedIn

Website

Website

Other 3

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Download

Download

API Viewer

API Viewer

Source (apis.yml)

aid: proxmox
name: Proxmox VE
description: Proxmox Virtual Environment (Proxmox VE) is an open-source server virtualization platform that combines KVM hypervisor
  and LXC containers, software-defined storage and networking, and clustering and high- availability features in a single
  web-managed solution. The Proxmox VE API exposes all platform operations under /api2/json on port 8006, including node,
  cluster, storage, pool, and access management endpoints. Supported authentication methods include stateless API tokens (PVEAPIToken
  header) and ticket-based sessions issued via /access/ticket.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  generated: '2026-11-13'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/proxmox.png
tags:
- Virtualization
- KVM
- Containers
- LXC
- Clustering
- Open Source
tags_raw:
- Virtualization
- KVM
- Containers
- LXC
- Clustering
- Open Source
- Open-Source
url: https://raw.githubusercontent.com/api-evangelist/proxmox/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-05-11'
specificationVersion: '0.23'
apis:
- aid: proxmox:ve-api
  name: Proxmox VE API
  description: REST-style management API for Proxmox VE covering nodes, virtual machines, containers, storage, networking,
    clustering, pools, and access management. Authenticated via API tokens (PVEAPIToken header) or ticket-based sessions with
    CSRFPreventionToken for write operations.
  humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
  baseURL: https://your.server:8006/api2/json
  tags:
  - Virtualization
  - Cluster Management
  - Infrastructure
  properties:
  - type: Documentation
    url: https://pve.proxmox.com/wiki/Proxmox_VE_API
  - type: API Viewer
    url: https://pve.proxmox.com/pve-docs/api-viewer/
  - type: Authentication
    url: https://pve.proxmox.com/wiki/Proxmox_VE_API#Authentication
- aid: proxmox:proxmox-access-api
  name: Proxmox VE Access API
  description: The Access API from Proxmox VE — 3 operation(s) for access.
  humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
  baseURL: https://your.server:8006/api2/json
  tags:
  - Access
  properties:
  - type: OpenAPI
    url: openapi/proxmox-access-api-openapi.yml
- aid: proxmox:proxmox-cluster-api
  name: Proxmox VE Cluster API
  description: The Cluster API from Proxmox VE — 1 operation(s) for cluster.
  humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
  baseURL: https://your.server:8006/api2/json
  tags:
  - Cluster
  properties:
  - type: OpenAPI
    url: openapi/proxmox-cluster-api-openapi.yml
- aid: proxmox:proxmox-containers-api
  name: Proxmox VE Containers API
  description: The Containers API from Proxmox VE — 2 operation(s) for containers.
  humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
  baseURL: https://your.server:8006/api2/json
  tags:
  - Containers
  properties:
  - type: OpenAPI
    url: openapi/proxmox-containers-api-openapi.yml
- aid: proxmox:proxmox-nodes-api
  name: Proxmox VE Nodes API
  description: The Nodes API from Proxmox VE — 1 operation(s) for nodes.
  humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
  baseURL: https://your.server:8006/api2/json
  tags:
  - Node
  tags_raw:
  - Nodes
  properties:
  - type: OpenAPI
    url: openapi/proxmox-nodes-api-openapi.yml
common:
- type: CapabilityMap
  url: capabilities/proxmox-capability-edges.yml
  name: Proxmox VE Business Capability Map
- type: AgenticAccess
  url: agentic-access/proxmox-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/proxmox-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/proxmox-domain-security.yml
- type: Authentication
  url: authentication/proxmox-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/proxmox
- type: Website
  url: https://www.proxmox.com
- type: Documentation
  url: https://pve.proxmox.com/pve-docs/
- type: Pricing
  url: https://www.proxmox.com/en/proxmox-virtual-environment/pricing
- type: Download
  url: https://www.proxmox.com/en/downloads
- type: API Viewer
  url: https://pve.proxmox.com/pve-docs/api-viewer/
- type: GitHub
  url: https://github.com/proxmox
- type: Community Forum
  url: https://forum.proxmox.com
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

Proxmox VE API — frequently asked questions

Does Proxmox VE have an API?

Yes. APIs.io lists 5 APIs from Proxmox VE, including Proxmox VE API, Proxmox VE Access API and Proxmox VE Cluster API, and 2 more.

Is there an OpenAPI specification for the Proxmox VE API?

Yes. APIs.io indexes 4 OpenAPI specifications for Proxmox VE, each linked for download from this page.

How do I authenticate with the Proxmox VE API?

Proxmox VE uses bearer-token authentication (apiKey · 2 schemes). The details are profiled on APIs.io as Proxmox VE Authentication.

Is the Proxmox VE API ready for AI agents?

Proxmox VE has a Kin Score of 26.8 out of 100 (thin) and an Agent Readiness score of 19.0 (agent-aware), scored by API Evangelist on 2026-11-13.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/proxmox"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/proxmox/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/proxmox/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.