Overview

Veeam Backup for Microsoft 365 exposes its API methods through the Web Service API based on the REST (Representational State Transfer) framework and Open Data Protocol (OData).

The Veeam Backup for Microsoft 365 REST API is self-hosted as a Veeam.Archiver.REST.Service (display name — Veeam Backup for Microsoft 365 REST API Service) independently from IIS. With REST API developers can use HTTP requests and standard HTTP methods to query information about Veeam Backup for Microsoft 365 methods and perform most of the operations available in the user interface.

The Veeam Backup for Microsoft 365 REST API is resource-based and 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. Collections are modeled as an array of objects. Every collection has hyperlinks that end with resource identifiers. Hyperlinks can point at collection individual resources, related resources or related collections.

The Veeam Backup for Microsoft 365 REST API relies on the client-server model:

• The client sends requests to the server.
• The server processes requests and returns responses which include conventional HTTP response codes. All responses returned from the server are in JSON format.

The Veeam Backup for Microsoft 365 REST API works over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

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