This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Immediate Backup Copy Jobs Configured on Backup Server
You can get a collection resource representation of all immediate backup copy 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 immediate backup copy jobs configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs/immediatelyBackupCopyJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/jobs/immediatelyBackupCopyJobs |
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 BackupServerImmediatelyBackupCopyJob schema.
Example 
The following request returns a representation of all immediate backup copy jobs configured on a Veeam Backup & Replication server with UID 21086fb9-d65e-4549-b956-967c38b28794.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/21086fb9-d65e-4549-b956-967c38b28794/jobs/immediatelyBackupCopyJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "d5425bc1-d623-419a-8911-4c6a379e79a6", "targetRepositoryUid": "24d76184-275e-4e54-92c4-c8fefe442547", "targetWanAcceleratorUid": "231a61d9-78f3-4068-8ddb-b7a9b25d6aec", "sourceWanAcceleratorUid": "18f3e033-2df8-4789-ac12-9ea3b6179463", "retentionPolicyType": "gfs", "isRpoOptionsEnabled": false, "rpoOptionsValue": 1, "rpoOptionsUnit": "hours" }, { "instanceUid": "a4e3e026-a845-4d88-83a1-427f12784bc6", "targetRepositoryUid": "5db23aba-24cb-44f8-ad76-1a904ec88a4b", "targetWanAcceleratorUid": "2ce089cd-c9cb-4ea4-bdad-a635ea96f44b", "sourceWanAcceleratorUid": "8addf463-946e-433b-bf76-aae8ae3f16ee", "retentionPolicyType": "gfs", "isRpoOptionsEnabled": false, "rpoOptionsValue": 1, "rpoOptionsUnit": "hours" } ] } |