REST Resources

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

The following operations are supported on this resource:

  • POST - Deploy image on devices
  • POST - Deploys the JAM Package on the Devices
POST /packages/{id}/exec-deployVersion 1

This API deploys the software package on the real device (that is, on the physical device).

Sample Usage

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

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


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    software-package-idintPathThe 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-deploy>
      <devices>
        <device href= "/api/space/device-management/devices/458753" />
      </devices>
      <deployOptions>
        <useAlreadyDownloaded>true</useAlreadyDownloaded>
        <snapShotRequired>false</snapShotRequired>
        <validate>false</validate>
        <bestEffortLoad>false</bestEffortLoad>
        <removePkgAfterInstallation>false</removePkgAfterInstallation>
        <rebootDevice>false</rebootDevice>
        <rebootAfterXMinutes>0</rebootAfterXMinutes>
        <upgradePrimaryPartition>false</upgradePrimaryPartition>
        <cleanUpExistingOnDevice>false</cleanUpExistingOnDevice>
        <forceHostUpgrade>false</forceHostUpgrade>
      </deployOptions>
    </exec-deploy>

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

  • Sample Input JSON:
    {
      "exec-deploy": {
        "devices": [
          {
           "device":
           {
            "@href":"/api/space/device-management/devices/458753"
           }
          }
        ],
        "deployOptions":
        {
           "useAlreadyDownloaded":"true",
           "snapShotRequired":"false",
           "validate":"false",
           "bestEffortLoad":"false",
           "removePkgAfterInstallation":"false",
           "rebootDevice":"false",
           "rebootAfterXMinutes":"0",
           "upgradePrimaryPartition":"false",
           "cleanUpExistingOnDevice":"false",
           "forceHostUpgrade":"false"
        }
      }
    }

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

    • Access Control

    The following capabilities are required to access this API: DeployImageCap

    POST /packages/{id}/exec-deployVersion 1

    Deploys the JAM Package on 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-deploy?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-deploy-jam-request>
         <devices>
               <device href="/api/space/device-management/devices/25755665"/>
         </devices>
         <deployOptions>
               <use-already-downloaded-jam>true</use-already-downloaded-jam>
         </deployOptions>
    </exec-deploy-jam-request>

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

  • Sample Input JSON:
    {
       "exec-deploy-jam-request" : {
         "devices" : [
           {
             "device" : {
               "@href" : "/api/space/device-management/devices/25755665"
             }
           }
         ],
         "deployOptions" : {
           "use-already-downloaded-jam" : "true"
         }
       }
    }

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

    • Access Control

    The following capabilities are required to access this API: DeployImageCap