This is an archive version of the document. To get the most up-to-date information, see the current version.

Overview

Veeam Backup Enterprise Manager exposes its objects via the Web Service API based on the REST (Representational State Transfer) framework. Veeam Backup Enterprise Manager RESTful API lets developers communicate with Veeam Backup Enterprise Manager to query information about Veeam Backup Enterprise Manager objects and perform basic operations with them using the HTTPS protocol and the principles of REST. Since the HTTPS protocol is very popular and widespread, REST API is platform-agnostic and can be used with practically any programming language.

This document will help you get familiar with the Veeam Backup Enterprise Manager RESTful API. The document includes the following sections:

  • Concepts and Principles highlights key features of REST API as applicable to Veeam Backup Enterprise Manager.
  • Getting Started describes Veeam Backup Enterprise Manager RESTful API specifications, provides a generalized RESTful workflow to help you quickly start with Veeam Backup Enterprise Manager RESTful API and an example of Veeam Backup Enterprise Manager RESTful API use.
  • Veeam Backup Enterprise Manager RESTful API Reference provides a complete reference for Veeam Backup Enterprise Manager RESTful API resources and operations you can perform with them.
  • Sample Scenarios offers a set of examples of use for Veeam Backup Enterprise Manager RESTful API.