REST Resources

/api/space/device-management/devices/{device-id}/clone

The following operation is supported on this resource:

  • POST - Clone a device
POST /devices/{device-id}/cloneVersion 1

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /devices/{device-id}/clone?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPath   Y
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <clone-request>
         <cloned-device-name>Cloned_Device</cloned-device-name>
         <device-count>1</device-count>
         <image-upgrade-validation>true</image-upgrade-validation>
         <device-image href="/api/space/software-management/packages/655360">
               <name>Image_Name</name>
         </device-image>
    </clone-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/1081352">
      <id>1081352</id>
    </task>

  • Sample Input JSON:
    {
       "clone-request" : {
         "cloned-device-name" : "Cloned_Device" ,
         "device-count" : "1" ,
         "image-upgrade-validation" : "true" ,
         "device-image" : {
           "@href" : "/api/space/software-management/packages/655360" ,
           "name" : "Image_Name"
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/1081352",
        "id":1081352
      }
    }

  • Access Control

    The following capabilities are required to access this API: CloneDevice