Veeam ONE exposes its entities through an application programming interface (API) based on the Representational State Transfer (REST) architecture style. The Veeam ONE REST API allows developers to query information about Veeam ONE entities and perform basic operations with these entities using HTTP requests and standard HTTP methods.
All individual resources have a JSON representation and system resource identifiers, which help to locate a resource by its URL. Resources of the same entity type comprise a collection. A collection is modeled as an array of objects.
Veeam ONE REST API 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 JSON format.
In Veeam ONE 12, the following versions of REST API are available:
- REST API v2.1 is the older version.
- REST API v2.2 is the recent version with extended functionality.
Before you start working with REST API, we recommend you to get familiar with Veeam ONE functionality. For details on Veeam ONE Client features, see Veeam ONE Monitoring Guide. For details on Veeam ONE Web Client features, see Veeam ONE Reporting Guide.
To perform REST API operations, a user must have one of the following roles assigned:
- Veeam ONE Administrator can execute all operations.
- Veeam ONE Read-Only User and Veeam ONE Power User can execute all operations except the ones marked with the Licensing, Task Sessions and About tags.
In This Section:
The following topics will help you learn how to connect to Veeam ONE REST API and authorize your access. You will also learn what method-implemented operations you can perform with Veeam ONE entities, and how to control and sort the data that Veeam ONE REST API returns.