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

The following operation is supported on this resource:

  • POST - Stage Image on Devices
POST /packages/{id}/exec-stageVersion 1

This API stages the software package on the real device (from Junos Space to 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-stage?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-stage>
      <devices>
        <device href= "/api/space/device-management/devices/458753" />
      </devices>
      <stageOptions>
        <cleanUpExistingOnDevice>false</cleanUpExistingOnDevice>
      </stageOptions>
    </exec-stage>

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

  • Sample Input JSON:
    {
      "exec-stage": {
        "devices": [
          {
            "device":{
              "@href":"/api/space/device-management/devices/458753"
            }
          },
        ]
        "stageOptions":
        {
          "cleanUpExistingOnDevice":"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: StageImageCap