POST /jobs/{ID}/linkedBackupRepositories
Adds a backup repository to a backup copy job with the specified ID.
Note |
If a backup copy job contains linked backups, these linked backups will be removed after any edit operation (such as adding or removing a linked job or repository). |
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To add a backup repository to a backup copy job, send the POST HTTP request to the /jobs/{ID}/linkedBackupRepositories resource.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/jobs/{ID}/linkedBackupRepositories |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
In the request body, the client must send the ID of the repository to be linked. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.
The request body must contain the following element:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
LinkedBackupRepositoryUid | String | ID of a backup repository that you want to link to the backup copy job. | Yes | 1/1 |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 202 Accepted.
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. Possible values:
|
Response Body
In the response body, the REST API returns a task that has been created to perform the requested operation. To track the status of the operation, send the GET /tasks/{ID} request.
The task resource also contains a link to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL in the link.
Example
The example below adds a backup repository to a backup copy job having ID d1b85018-2769-45be-89bc-03f66b60e6cb.
Request: POST https://localhost:9398/api/jobs/d1b85018-2769-45be-89bc-03f66b60e6cb/linkedBackupRepositories
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the status of the operation, send the GET HTTP request to the received task resource:
Request: GET https://localhost:9398/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |