REST Resources

/api/space/device-management/reboot-devices

The following operation is supported on this resource:

  • POST - Execute Reboot Devices
POST /reboot-devicesVersion 3

Execute Reboot Devices.

Sample Usage

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

POST /reboot-devices?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    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:
    <reboot-devices-request>
         <message>Rebooting_Device</message>
         <power-off>false</power-off>
         <lsys-label-toggle>false</lsys-label-toggle>
         <devices>
               <device href="/api/space/device-management/devices/2228241"/>
         </devices>
    </reboot-devices-request>

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

  • Sample Input JSON:
    {
       "reboot-devices-request" : {
         "message" : "Rebooting_Device" ,
         "power-off" : "false" ,
         "lsys-label-toggle" : "false" ,
         "devices" : {
           "device" : {
             "@href" : "/api/space/device-management/devices/2228241"
           }
         }
       }
    }

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

  • Access Control

    The following capabilities are required to access this API: RebootDevice