Overview

In this article

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

    The Veeam Backup & Replication REST API is defined and described in a single document that uses and conforms to the OpenAPI Specification (OAS) of version 3.0. The Veeam Backup & Replication REST API document is a JSON file swagger.json . You can find the file in the installation folder of Veeam Backup & Replication.

    The Veeam Backup & Replication 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. Requests can contain parameters in their path, query and header. POST and PUT requests can include a request body with resource payload. In response, the client receives a conventional HTTP response code, HTTP response header and an optional response body schema that contains a result model.

    Parameters, request bodies, and response bodies are defined inline or refer to schemas defined globally. Some schemas are polymorphic. It reduces the REST API document size and allows you to use the same operation for different types of resources. For example, you can use the same operation to retrieve Microsoft Windows and Linux servers.

    The Veeam Backup & Replication 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 REST API and authorize your access. To learn what method-implemented operations you can perform with Veeam Backup & Replication entities, and how to control and sort the data that the REST API returns, see the REST API Reference.