This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Jobs Configured on Backup Server
You can get a collection resource representation of all 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 jobs configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/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 |
|---|---|---|---|---|---|
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 BackupServerJob schema.
Example 
The following request returns a representation of all jobs configured on a Veeam Backup & Replication server with UID debd00bc-2e3a-4706-a246-2a94fc3054de.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/debd00bc-2e3a-4706-a246-2a94fc3054de/jobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "f7f0e031-6d52-42d0-94aa-4f4c04c9514c", "name": "Backup Job 2 - 2 VMs", "backupServerUid": "debd00bc-2e3a-4706-a246-2a94fc3054de", "organizationUid": "c647bff1-7faf-4672-9e31-e37c3a0c2fd0", "status": "success", "type": "backupVm", "lastRun": "2019-02-20T10:45:52.3600000+00:00", "lastEndTime": "2019-02-20T11:05:01.3500000+00:00", "lastDuration": 1148, "processingRate": 0, "avgDuration": 0, "transferredData": 0, "bottleneck": "none", "isEnabled": true, "scheduleType": "continuously", "failureMessage": null, "targetType": "local", "destination": "Backup Repository 2 disk D" }, { "instanceUid": "980f525a-c850-4ab6-a428-f0d7a1e81086", "name": "Backup Copy Job 1", "backupServerUid": "debd00bc-2e3a-4706-a246-2a94fc3054de", "organizationUid": "8af5caa4-2af6-4de3-8eaf-88d28b23dfc9", "status": "none", "type": "backupCopy", "lastRun": null, "lastEndTime": null, "lastDuration": null, "processingRate": null, "avgDuration": 0, "transferredData": null, "bottleneck": "none", "isEnabled": false, "scheduleType": "continuously", "failureMessage": null, "targetType": "local", "destination": "Default Backup Repository" } ] } |