Get Backup Agents

In this article

    You can get a representation of a collection of backup agents managed by Veeam Service Provider Console.

    Request

    To get a representation of all Veeam backup agents, send the GET HTTPS request to the URL of the /backupAgents collection.

    HTTPS Request

    GET https://<hostname>:1281/v2/backupAgents

    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 OK.

    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 Service Provider Console returns a representation of the /backupAgents collection resource.

    Example Get Backup Agents

    The following request returns a list of all managed computers in Veeam Service Provider Console.

    Request:

    GET https://localhost:1281/v2/backupAgents

     

    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"

         }

       ]

     },

     {

       "id": "cc52ec30-a1b0-41dd-8b24-553dab48b43f",

       "scheduleDisabled": false,

       "companyId": 11,

       "locationId": 11,

       "name": "ac-m19",

       "successJobsCount": 2,

       "totalJobsCount": 2,

       "successfulPercentage": 100,

       "isReadOnlyMode": true,

       "guiMode": "ReadOnly",

       "isViewModeChanging": false,

       "isSettingsChanging": false,

       "vawPlatform": "Cloud",

       "vawPlatformId": "Cloud",

       "cloudCopy": false,

       "lastModified": "2018-10-12T01:37:05.2423906+03:00",

       "lastModificationDoneBy": "ac-m2\\Administrator",

       "backupMode": [

         "Folder"

       ],

       "operationModeId": "Server",

       "multijobSupport": true,

       "version": "3.0.0.748",

       "_links": [

         {

           "rel": "self",

           "method": "GET",

           "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f"

         },

         {

           "rel": "related",

           "method": "GET",

           "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs"

         }

       ]

     }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.