Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

Overview

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

Veeam Backup for Microsoft Office 365 RESTful API is self-hosted as a Veeam.Archiver.RESTful.Service independently from IIS. With RESTful API developers can use HTTPS requests and standard HTTP methods to query information about Veeam Backup for Microsoft Office 365 entities and perform most of the operations available in user interface.

Veeam Backup for Microsoft Office 365 RESTful 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 modelled as an array of objects. Every collection has hyperlinks that end with resource identifiers. Hyperlinks can point at collection's individual resources, related resources or related collections.

Veeam Backup for Microsoft Office 365 RESTful 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.

Overview Important!

To perform any action with Veeam Backup for Microsoft Office 365 RESTful API, you must configure RESTful API service in the Veeam Backup for Microsoft Office 365 console. For more information, see Configuring RESTful API Settings.

In This Section

The following topics will lead you through the process of connecting to Veeam Backup for Microsoft Office 365 RESTful API and authorizing your access. You will learn what operations you can perform with Veeam Backup for Microsoft Office 365 entities and how to explore capabilities of Veeam Backup for Microsoft Office 365 RESTful API.

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference