Get All Backup Agent Jobs Configured on Backup Server
You can get a collection resource representation of all backup agent jobs configured on a Veeam Backup & Replication server 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 all backup agent jobs configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs/agentJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/jobs/agentJobs |
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 |
|---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Backup server UID |
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 BackupServerAgentJob schema.
Example 
The following request returns a representation of all backup agent jobs.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/agentJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "5c608308-e49d-4b54-ba16-8ab8c465cbd6", "totalJobsCount": 2, "successJobsCount": 2, "destination": "Cloud repository 1", "source": { "backupMode": "volume", "backupUserFolders": false, "backupOperatingSystem": true, "fileSystemItems": { "volumes": [], "filesAndFolders": null } }, "jobMode": "managedByBackupServer", "osType": "windows", "licenseType": "workstation" }, { "instanceUid": "5a80912e-5f62-4c71-9ff3-f61d48d61609", "totalJobsCount": 1, "successJobsCount": 1, "destination": "Default Backup Repository", "source": { "backupMode": "entireComputer", "backupUserFolders": false, "backupOperatingSystem": false, "fileSystemItems": null }, "jobMode": "managedByBackupServer", "osType": "linux", "licenseType": "server" } ] } |
