- About VES Public REST API
- Overview
- Login
- Collectors
- getGet Collector Hierarchy Tree
- getGet List of Registered Collectors
- getGet All Collector Groups
- getGet All Monitoring Jobs
- postMove Collector to Different Group
- postMove Monitoring Jobs to Collector
- postUnregister Collector
- postTrigger Topology Rebuild
- postRebalance Monitoring Load Across All Groups
- postRebalance Monitoring Load in Group
- postCreate Collector Group
- postRename Collector Group
- delDelete Collector Group
- HypervServers
- License
- Settings
- VmwareServers
- getGet VMware Server Hierarchy Tree
- getGet VMware Server Data
- postRegister VMware vCenter or ESXi Host
- postRegister VMware vCenter or ESXi Host Without Immediate Connection
- postRetrieve SSL Certificate
- postUpdate VMware Server Configuration
- postPerform VMware Servers Connectivity Check
- postDiscover Available Monitoring Jobs
- postRemove VMware Servers
- postAdd VMware Topology to Monitoring
- postRemove VMware Topology from Monitoring
- getGet Latest Connectivity Test Results
- postStart Connectivity Test
- postStop Connectivity Test
VES Public REST API (v1)
Download OpenAPI specification:Download
Starting from Veeam Management Pack version 13, the VE Service REST API replaces the deprecated VES PowerShell module.
Veeam Virtualization Extensions Service (VES) exposes its entities through an application programming interface (API) based on the Representational State Transfer (REST) architecture style. The VE Service REST API allows developers to query information about VES entities and perform basic operations with these entities using HTTP requests and standard HTTP methods.
The VE Service REST API is a operation-oriented application programming interface that relies on the client-server model. The client makes a request to the server; the server processes the request and returns a response with a conventional HTTP response code, HTTP response headers and a response body in the JSON format (by default).
The VE Service REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.