Get All Backup Copy Jobs
You can get a collection resource representation of all backup copy jobs.
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 backup copy jobs, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/backupCopyJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/backupCopyJobs |
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 BackupServerBackupCopyJob schema.
Example 
The following request returns a representation of all backup copy jobs.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/backupCopyJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "ed9b33f2-31a8-4e7b-aa69-495afe20dd09", "targetRepositoryUid": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec", "targetWanAcceleratorUid": "a2b489bb-4aa5-4527-b9e4-f6a0f493a1bb", "sourceWanAcceleratorUid": "af43d000-52f1-4874-8df3-62dbb8676f25", "retentionPolicyType": "simple", "isRpoOptionsEnabled": false, "rpoOptionsValue": 0, "rpoOptionsUnit": "minutes" }, { "instanceUid": "89c7705d-339f-4eb8-83eb-7545176cef77", "targetRepositoryUid": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec", "targetWanAcceleratorUid": "929d9d75-a2c1-403f-be0b-88226e31c1c4", "sourceWanAcceleratorUid": "0fc1f23b-0bf7-40fd-877c-b75b986fd1d7", "retentionPolicyType": "gfs", "isRpoOptionsEnabled": false, "rpoOptionsValue": 0, "rpoOptionsUnit": "minutes" } ] } |
