Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Resource URLs

Each Veeam Availability Console RESTful API-exposed entity has a resource representing it. To get a resource representation, request its URL. All Veeam Availability Console RESTful API URLs have the following base:

https://<Availability-Console>:<port>/<version>

where:

  • <Availability-Console> is the DNS name or IP address of the machine on which Veeam Availability Console Web UI is installed.
  • <port> is the RESTful API port number you specified during Veeam Availability Console Web UI installation.

The default port number is 1281.

  • <version> is an API version.

Current version is v2.

To get a collection of Veeam Availability Console RESTful API resources, request a base URL followed by resource collection path. For example:

https://vac:1281/v2/BackupServers

To get a representation of an individual resource, enter a resource identifier after a resource collection path. For example:

https://vac:1281/v2/BackupServers/2

The resource identifier is represented by the id and instanceUid properties of the resource from the collection.

[

 {

   "id": 2,

   "name": "BACKUP02",

   "_links": {

     "self": {

       "href": "https://vac:1281/v2/backupServers/2"

     },

   },

 {

   "id": 3,

   "name": "BACKUP01",

   "_links": {

     "self": {

       "href": "https://vac:1281/v2/backupServers/3"

   },

 }

]

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference