Get Backup Agent
You can get a resource representation of a Veeam backup agent with the specified UID.
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 a Veeam backup agent, send the GET HTTP request to the URL of the /infrastructure/backupAgents/{backupAgentUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupAgents/{backupAgentUid} |
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 | Constraints | Description |
|---|---|---|---|---|---|---|
backupAgentUid | Path | String (uuid) | Yes | — | — | Veeam backup agent UID |
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 resource representation based on the BackupAgent schema.
Example 
The following request returns a representation of a Veeam backup agent with UID 3a773b42-89fb-7227-9c6a-95e6908f25de.
Request: GET https://localhost:1280/api/v3/infrastructure/backupAgents/3a773b42-89fb-7227-9c6a-95e6908f25de
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "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 } } |
