/api/space/software-management/packages/{id}/exec-undeploy

The following operation is supported on this resource:

  • POST - Undeploys the JAM Package from the Devices
POST /packages/{id}/exec-undeployVersion 1

Undeploys the JAM Package from the Devices ( JAM supported Devices - MX240, MX480, MX960, MX2010 and MX2020 ).

Sample Usage

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

POST /packages/{id}/exec-undeploy?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-image-idIntegerPathThe ID for the software package under operation. 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:
    <exec-undeploy>
         <devices>
               <device href="/api/space/device-management/devices/25755665"/>
         </devices>
    </exec-undeploy>

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

  • Sample Input JSON:
    {
       "exec-undeploy" : {
         "devices" : [
          {
             "device" : {
               "@href" : "/api/space/device-management/devices/25755665"
             }
           }
         ]
       }
    }

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

  • Access Control

    The following capabilities are required to access this API: UnDeployJAMCap