POST /jobs/{ID}?action=clone
Creates a copy of the job having the specified ID. The cloned job is registered on the same backup server where the initial job is created.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To clone a job, send the POST HTTP request to the /jobs/{ID}?action=clone URL.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/jobs/{ID}?action=clone |
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. |
Content-Type | True | Identifies the format of the request body message. Possible values:
|
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 parameters for the cloned job. The body of the request must conform to the XML Schema Definitionem_rest_ of Veeam Backup Enterprise Manager REST API.
The request body differs depending on the type of the cloned job:
For a backup job, the request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
JobName | String | Name of the new cloned job. The name must be up to 50 characters long. | Yes | 1/1 |
FolderName | String | Name of the backup file that will be created by the cloned job. | Yes | 1/1 |
RepositoryUid | UidType | UID of the backup repository in which the backup file will be created. | No | 1/1 |
Description | String | Description for the cloned job. | Yes | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
For a replication job, the request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
JobName | String | Name of the new cloned job. The name must be up to 50 characters long. | Yes | 1/1 |
VmSuffix | String | Suffix for the name of a VM replica created by the cloned job. | Yes | 1/1 |
Description | String | Description for the cloned job. | Yes | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
For a backup copy job, the request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
JobName | String | Name of the new cloned job. The name must be up to 50 characters long. | Yes | 1/1 |
JobFileName | String | Name of the backup file that will be created by the cloned job. | Yes | 1/1 |
RepositoryUid | UidType | UID of the backup repository in which the backup file will be created. | No | 1/1 |
Description | String | Description for the cloned job. | Yes | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
Immediate Backup Copy Job Clone Options
For an immediate backup copy job, the request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
JobName | String | Name of the new cloned job. The name must be up to 50 characters long. | Yes | 1/1 |
JobFileName | String | Name of the backup file that will be created by the cloned job. | Yes | 1/1 |
RepositoryUid | UidType | UID of the backup repository in which the backup file will be created. | No | 1/1 |
Description | String | Description for the cloned job. | Yes | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
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 clones a job having ID 78c3919c-54d7-43fe-b047-485d3566f11f.
Request: POST https://localhost:9398/api/jobs/78c3919c-54d7-43fe-b047-485d3566f11f?action=clone
Request Headers: 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 URL of 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"> |