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.

Required Privileges

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.

REST API Reference Map

For visual representation of all operations available in REST API, see Veeam ONE REST API Reference Map.