This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Veeam Agents for Microsoft Windows Jobs
You can get a collection resource representation of all Veeam backup agent jobs protecting Windows computers.
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 agent jobs protecting Windows computers, send the GET HTTP request to the URL of the /infrastructure/backupAgents/windows/jobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupAgents/windows/jobs |
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 BackupAgentJob schema.
Example 
The following request returns a representation of all Veeam backup agent jobs protecting Windows computers.
Request: GET https://localhost:1280/api/v3/infrastructure/backupAgents/windows/jobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "724111ac-15f5-bf02-604d-20862fbafece", "backupAgentUid": "07673b42-89fb-7227-9c6a-95e6908f25de", "organizationUid": "20c8486b-8c20-4b24-86a5-7cf31751c504", "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule._restv3em", "configUid": "4610eb17-b41c-4cc5-81d1-938e57d89b7a", "backupPolicyUid": "7d953629-677a-408f-88ed-9b61031b8151", "backupPolicyFailureMessage": null, "status": "success", "operationMode": "workstation", "destination": "C:\VeeamBackup", "restorePoints": 4, "lastRun": "2020-03-01T11:35:00+03:00", "lastEndTime": "2020-03-01T11:45:13+03:00", "lastDuration": 613, "nextRun": "2020-03-02T11:30:00+03:00", "avgDuration": 575, "backupMode": "file", "targetType": "local", "isEnabled": true, "scheduleType": "daily", "scheduleEvents": [], "lastModifiedDate": "2020-02-28T04:17:34.507218+03:00", "lastModifiedBy": "vspc\administrator", "failureMessage": null, "backedUpSize": 12550788 }, { "instanceUid": "3d29a667-2026-2f74-1143-18e04ba3c8e2", "backupAgentUid": "19873b42-32ea-bbc5-e764-74d8f6ebd698", "organizationUid": "20c8486b-8c20-4b24-86a5-7cf31751c504", "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule._restv3vawServ1", "configUid": "7416ea5c-1773-4e3e-86d8-71de3b54418f", "backupPolicyUid": "d598ae5a-eb96-42f0-9168-66d5d0ab2de0", "backupPolicyFailureMessage": null, "status": "success", "operationMode": "workstation", "destination": "C:\VeeamBackup", "restorePoints": 4, "lastRun": "2020-03-01T10:00:00+02:00", "lastEndTime": "2020-03-01T10:13:22+02:00", "lastDuration": 802, "nextRun": "2020-03-30T10:00:00+02:00", "avgDuration": 795, "backupMode": "file", "targetType": "local", "isEnabled": true, "scheduleType": "daily", "scheduleEvents": [], "lastModifiedDate": "2020-02-28T04:10:30.0325436+03:00", "lastModifiedBy": "vspc\administrator", "failureMessage": null, "backedUpSize": 16354212 } ] } |