This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Backup Agents
You can get a collection resource representation of all Veeam backup agents.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all Veeam backup agents, send the GET HTTP request to the URL of the /infrastructure/backupAgents collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupAgents |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
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 collection resource representation based on the BackupAgent schema.
Example 
The following request returns a representation of all Veeam backup agents.
Request: GET https://localhost:1280/api/v3/infrastructure/backupAgents
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "3a773b42-89fb-7227-9c6a-95e6908f25de", "agentPlatform": "windows", "managementAgentUid": "72eb35dd-28d9-4923-826a-843e634248ff", "organizationUid": "20c8486b-8c20-4b24-86a5-7cf20901c504", "name": "vba2", "operationMode": "unLicensed", "guiMode": "readOnly", "platform": "cloud", "version": "4.0.0.1811", "activationTime": null, "managementMode": "unManaged", "installationType": "full", "totalJobsCount": 2, "runningJobsCount": 1, "successJobsCount": 1 }, { "instanceUid": "d48c3b42-873d-bfe9-d0c7-f1c364943fd3", "agentPlatform": "windows", "managementAgentUid": "6b87018a-0595-4be0-ac44-3ecc58cc1c06", "organizationUid": "20c8486b-9220-4b24-86a5-7cf20751c504", "name": "bckp3", "operationMode": "server", "guiMode": "full", "platform": "cloud", "version": "4.0.0.1811", "activationTime": "2020-03-08T04:32:00.4099229+03:00", "managementMode": "managedByConsole", "installationType": "full", "totalJobsCount": 0, "runningJobsCount": 0, "successJobsCount": 0 } ] } |