This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Objects of VM Backup Jobs Configured on Backup Server
You can get a collection resource representation of all objects of VM backup 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 objects of VM backup jobs configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/objects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/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 |
|---|---|---|---|---|---|
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 BackupServerVmJobObject schema.
Example 
The following request returns a representation of all objects of VM backup jobs configured on a Veeam Backup & Replication server with UID 32ead214-e225-49bf-8fb8-f16340729b7b.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/32ead214-e225-49bf-8fb8-f16340729b7b/jobs/backupVmJobs/objects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "jobUid": "c538106b-64bc-4940-aa5b-fab47353bf73", "instanceUid": "98d2c770-f455-42ee-b0dc-3b3986ca3882", "name": "srv04", "platform": "vSphere", "hierarchyRef": "vm-2268", "isExcluded": false, "lastSession": { "backupStatus": "success", "totalBackedSize": 1287046487, "sourceSize": 17179869184, "duration": 3025, "messages": [] } }, { "jobUid": "afe6c243-9f38-4082-a864-f57ef885ac3f", "instanceUid": "91787ee2-f729-40d0-9b45-ca9b37068896", "name": "srv21", "platform": "vSphere", "hierarchyRef": "vm-2268", "isExcluded": false, "lastSession": { "backupStatus": "success", "totalBackedSize": 32226161181, "sourceSize": 45727350784, "duration": 1167, "messages": [] } } ] } |