Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(POST) /jobs/{ID}?action=clone

Creates a copy of the job having the specified ID. The cloned job is registered on the same Veeam backup server where the initial job is created.

Request

To clone a job, you need to 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. To learn more, see Authentication and Security.

Content-Type

True

Identifies the format of the request body message. Possible values:

  • application/xml
  • application/json

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can sent this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

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 RESTful API.

The request body differs depending on the type of the cloned job:

Backup Job Clone Options

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.

Yes

1/1

FolderName

String

Name of the backup file that will be created by the cloned job.

Yes

1/1

RepositoryUid

URN

ID 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"?>
<JobCloneSpec xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.veeam.com/ent/v1.0">
 <BackupJobCloneInfo>
   <JobName>Cloned job (2/1/2020 6:07:07 PM)</JobName>
   <FolderName>Cloned job _2_1_2020 6_07_07 PM_</FolderName>
   <RepositoryUid>urn:veeam:Repository:6ee14c9a-4bc1-4783-8da1-a67e05da5218</RepositoryUid>
   <Description>This job was created by cloning CRM Backup job</Description>
 </BackupJobCloneInfo>
</JobCloneSpec>

Replication Job Clone Options

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.

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"?>
<JobCloneSpec xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.veeam.com/ent/v1.0">
 <ReplicaJobCloneInfo>
   <JobName>Cloned job (2/11/2020 6:13:50 PM)</JobName>
   <VmSuffix>_replica</VmSuffix>
   <Description>This job was created by cloning Appserver Replication job</Description>
 </ReplicaJobCloneInfo>
</JobCloneSpec>

Backup Copy Job Clone Options

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.

Yes

1/1

JobFileName

String

Name of the backup file that will be created by the cloned job.

Yes

1/1

RepositoryUid

URN

ID 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"?>
<JobCloneSpec xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.veeam.com/ent/v1.0">
 <BackupCopyJobCloneInfo>
   <JobName>Cloned job (2/11/2020 6:15:44 PM)</JobName>
   <JobFileName>Cloned job _2_11_2020 6_15_44 PM_</JobFileName>
   <RepositoryUid>urn:veeam:Repository:8a511e84-067a-4f0c-a30d-ad79092691be</RepositoryUid>
   <Description>This job was created by cloning CRM Backup Copy job</Description>
 </BackupCopyJobCloneInfo>
</JobCloneSpec>

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.

Yes

1/1

JobFileName

String

Name of the backup file that will be created by the cloned job.

Yes

1/1

RepositoryUid

URN

ID 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"?>
<JobCloneSpec xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.veeam.com/ent/v1.0">
 <ImmediateBackupCopyJobCloneInfo>
   <JobName>Cloned job (2/11/2020 6:17:41 PM)</JobName>
   <Description>This job was created by cloning Backup Copy job</Description>
   <RepositoryUid>urn:veeam:Repository:cf99cfbb-e097-432c-bafb-6558d3957f5b</RepositoryUid>
   <JobFileName>Cloned job _2_11_2020 6_17_41 PM_</JobFileName>
 </ImmediateBackupCopyJobCloneInfo>
</JobCloneSpec>

Query Parameters

None.

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:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.

Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the GET HTTP request to the URL in the link to stop the task execution.

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
Content-Type         application/xml

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<JobCloneSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <BackupJobCloneInfo>
   <JobName>Oracle Backup 01</JobName>
   <FolderName>Oracle Backup 01</FolderName>
   <RepositoryUid>urn:veeam:Repository:cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55</RepositoryUid>
   <Description>Cloned Oracle backup job</Description>
 </BackupJobCloneInfo>
</JobCloneSpec>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>CloneJob</Operation>
</Task>

To trace 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 Success

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
   <Link Rel="Related" Type="Job" Href="https://localhost:9398/api/jobs/1ef18e6a-531a-4dbd-bb96-827478a25965?format=Entity" Name="Oracle Backup cloned at 10/18/2014 6:13:11 AM" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>CloneJob</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.