About Veeam Service Provider Console RESTful API

Veeam Service Provider Console exposes its entities via the Web Service API based on the REST (Representational State Transfer) framework. Veeam Service Provider Console RESTful API allows developers to communicate with Veeam Service Provider Console to query information about Veeam Service Provider Console entities and perform basic operations with them using HTTPS 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 Service Provider Console RESTful 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 Service Provider Console 4.0, two versions of RESTful API are available:

• RESTful API v2 is a main production version.
• RESTful API v3 is an experimental version. You can use it to evaluate its capabilities and build test integrations.