Veeam Recovery Orchestrator (Orchestrator) exposes its entities through an application programming interface (API) based on the Representational State Transfer (REST) architecture style. The Orchestrator REST API allows developers to query information about Orchestrator entities and perform basic operations with these entities using HTTP requests and standard HTTP methods.

The Orchestrator REST 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.

The Orchestrator 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 the JSON format (by default).

The Orchestrator REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The following topics will help you know how to connect to the Orchestrator REST API and authorize your access, how to control and sort the data that the REST API returns. To learn what method-implemented operations you can perform with Orchestrator entities, see the REST API Reference.

In This Section