Veeam Availability Orchestrator (VAO) exposes its entities via the Web Service API based on the REST (Representational State Transfer) framework and Open Data Protocol (OData). VAO RESTful API allows developers to communicate with VAO to query information about VAO entities and perform basic operations with these entities using HTTPS requests and standard HTTP methods.
Only OData Version 3.0 is supported.
VAO 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 to help you 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 includes hyperlinks that end with resource identifiers and point at its individual resources, related resources and collections.
VAO 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 the JSON format.
The following topics will help you know how to connect to VAO RESTful API and authorize your access. You will also learn what method-implemented operations you can perform with VAO entities, and how to control and sort the data that RESTful API returns.
In This Section