Veeam Availability Console exposes its entities via the Web Service API based on the REST (Representational State Transfer) framework and Open Data Protocol (OData). Veeam Availability Console RESTful API allows developers communicate with Veeam Availability Console to query information about Veeam Availability Console entities and perform basic operations with them using HTTPS requests and standard HTTP methods. You can perform most of the operations that are available with Web UI using Veeam Availability Console RESTful API.
Veeam Availability Console RESTful API is a resource-based application programming interface that uses Hypertext Application Language (HAL). HAL expresses the resources and relationships between them as hyperlinks and enables navigation through the API. 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. Every collection has hyperlinks that end with resource identifiers and point at its individual resources, related resources and collections.
Veeam Availability 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 This Section:
The following topics will help you learn how to connect to Veeam Availability Console RESTful API and authorize your access. You will also learn what method-implemented operations you can perform with Veeam Availability Console entities, and how to control and sort the data that Veeam Availability Console RESTful API returns.