Get All Objects of Backup Copy Jobs
You can get a collection resource representation of all VM replication job objects.
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 job objects, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/backupCopyJobs/jobObjects collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/backupCopyJobs/jobObjects |
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 BackupServerJobLinkedJobObject schema.
Example 
The following request returns a representation of all objects of backup copy jobs.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/backupCopyJobs/jobObjects
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "jobUid": "ed9b33f2-31a8-4e7b-aa69-495a3e20dd09", "linkedJobUid": "472c90f2-c6fd-4147-81d7-7efe461ecbc4" }, { "jobUid": "89c7705d-339f-4eb8-83eb-7545a76cef77", "linkedJobUid": "041fe885-8575-49f8-b17b-b81d56add9be" } ] } |
