REST Resources

/api/space/device-management/delete-devices

The following operation is supported on this resource:

  • POST - Execute Delete Devices
POST /delete-devicesVersion 3

Execute Delete Devices.

Sample Usage

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

POST /delete-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:
    <delete-devices-request>
         <devices>
               <device href="/api/space/device-management/devices/327680"/>
         </devices>
    </delete-devices-request>

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

  • Sample Input JSON:
    {
       "delete-devices-request" : {
         "devices" : [
           {
             "device" : {
               "@href" : "/api/space/device-management/devices/327680"
             }
           }
         ]
       }
    }

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

  • Access Control

    The following capabilities are required to access this API: DeleteDevice