Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Get a Backup Agent

You can get a representation of a Veeam backup agent with the specified ID.

Request

To get a representation of a Veeam backup agent, send the GET HTTPS request to the URL of its resource.

HTTPS Request

GET https://<Availability-Console>:1281/v2/backupAgents/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a representation of the /backupAgents/{ID} resource.

Example Get a Backup Agent

The following request returns a representation of a Veeam backup agent with ID 41149d13-eb49-4895-9053-27f227584e4f.

Request:

GET https://localhost:1281/v2/backupAgents/41149d13-eb49-4895-9053-27f227584e4f

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

{

 "id": "41149d13-eb49-4895-9053-27f227584e4f",

 "scheduleDisabled": false,

 "companyId": 5,

 "locationId": 5,

 "name": "ac-m21",

 "successJobsCount": 7,

 "totalJobsCount": 7,

 "successfulPercentage": 100,

 "isReadOnlyMode": false,

 "guiMode": "Full",

 "isViewModeChanging": false,

 "isSettingsChanging": false,

 "vawPlatform": "Cloud",

 "cloudCopy": false,

 "lastModified": "2018-11-24T07:50:42.2423906+03:00",

 "lastModificationDoneBy": "-",

 "backupMode": [],

 "operationMode": "Workstation",

 "multijobSupport": false,

 "version": "3.0.0.748",

 "_links": [

  {

   "rel": "self",

   "method": "GET",

   "href": "https://vac:1281/v2/backupAgents/41149d13-eb49-4895-9053-27f227584e4f"

  },

  {

   "rel": "related",

   "method": "GET",

   "href": "https://vac:1281/v2/backupAgents/41149d13-eb49-4895-9053-27f227584e4f/jobs"

  }

 ]

}

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference