Get All VM Replication Jobs Configured on Backup Server
You can get a collection resource representation of all VM replication 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 VM replication jobs configured on a Veeam Backup & Replication server with the specified UID, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs |
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 BackupServerReplicationVmJob schema.
Example 
The following request returns a representation of all VM replication jobs configured on a Veeam Backup & Replication server with UID ad6132a6-0dd7-4ab5-9c1c-95a559788dae.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/ad6132a6-0dd7-4ab5-9c1c-95a559788dae/jobs/replicationVmJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "fad5d6d4-20c1-4ad3-9827-d3c0075fc65b", "protectedVmCount": 5, "isCloudJob": false, "cloudHostUid": "1bfb5b3b-eedc-407d-b672-8927af54014c", "targetHostUid": "e4cbfa3e-7704-4143-979b-56961e124cee", "sourceWanAcceleratorUid": "ee3a71aa-7103-4d35-975e-c84de8ed65ba", "targetWanAcceleratorUid": "2dac72a0-aabf-41ae-be27-cd697eb3c865", "throughWanAccelerators": false }, { "instanceUid": "324d1241-7860-4edd-b1b4-33386ae5a0d7", "protectedVmCount": 7, "isCloudJob": false, "cloudHostUid": "14155e69-4fa8-4959-a8eb-447eb7503e13", "targetHostUid": "0a17d16e-dca0-4b7a-9fdc-dd4c6f4ac372", "sourceWanAcceleratorUid": "7e27d0a3-95b1-4b03-8272-f14c162f39cd", "targetWanAcceleratorUid": "287edd26-ade1-489a-b8d0-5c3a1db1b10e", "throughWanAccelerators": false } ] } |
