Get All Objects of Backup Agent Job
You can get a collection resource representation of all objects of a backup agent job 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 objects of a backup agent job, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/agentJobs/{jobUid}/objects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/agentJobs/{jobUid}/objects |
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 |
|---|---|---|---|---|---|
jobUid | Path | String (uuid) | Yes | — | Backup agent job 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 BackupServerAgentJobObject schema.
Example 
The following request returns a representation of all objects of a backup agent job with UID 35014f93-902d-4b46-9c60-7b18dede74a7.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/agentJobs/35014f93-902d-4b46-9c60-7b18dede74a7/objects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "77255254-f96a-401e-b684-b338040a2d68", "backupServerUid": "85499c03-a306-4754-8f72-95f0e4e91637", "agentUid": "c9b6ee13-499c-46ab-80b3-cfb61501568c", "jobUid": "35014f93-902d-4b46-9c60-7b18dede74a7", "computer": "wrk01.tech.local", "backupStatus": "success", "lastRun": "2020-03-14T20:10:00.0000000+00:00", "lastEndTime": "2020-03-14T20:22:51.0000000+00:00", "lastDuration": 771, "restorePointsCount": 0, "osType": "windows", "failureMessage": "" }, { "instanceUid": "03560948-6cf3-40c1-ba8f-4e220f6422c3", "backupServerUid": "85499c03-a306-4754-8f72-95f0e4e91637", "agentUid": "b262ca9f-2899-4972-bc88-533cd862676e", "jobUid": "35014f93-902d-4b46-9c60-7b18dede74a7", "computer": "desktop03.tech.local", "backupStatus": "success", "lastRun": "2020-03-29T19:10:01.0000000+00:00", "lastEndTime": "2020-03-29T19:15:20.0000000+00:00", "lastDuration": 319, "restorePointsCount": 8, "osType": "windows", "failureMessage": "" } ] } |
