About Veeam Service Provider Console REST API

In this article

    Veeam Service Provider Console exposes its entities through the Web Service API based on the REST (Representational State Transfer) framework. The Veeam Service Provider Console REST 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 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 Service Provider Console 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 Service Provider Console 5.0, two versions of REST API are available:

    About Veeam Service Provider Console REST API Note:

    Before you start working with REST API, we recommend you to get familiar with Veeam Service Provider Console functionality. For details on Veeam Service Provider Console features available in the Administrator Portal, see Veeam Service Provider Console Guide for Service Providers. For details on Veeam Service Provider Console features available in the Client Portal, see Veeam Service Provider Console Guide for End Users. For details on Veeam Service Provider Console features available in the Reseller Portal, see Veeam Service Provider Console Guide for Resellers.

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.