REST Resources

/api/space/config-template-management/config-templates/{id}/exec-undeploy

The following operation is supported on this resource:

  • POST - Undeploy a configuration template from a device or a list of devices
POST /config-templates/{id}/exec-undeployVersion 1

This API undeploys a configuration template from a device or a list of devices.

Sample Usage

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

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


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathThe ID of the configuration template. 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-request>
         <devices>
               <device href="/api/space/device-management/devices/{id}"/>
         </devices>
    </exec-undeploy-request>

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

  • Sample Input JSON:
    {
       "exec-undeploy-request" : {
         "devices" : {
           "device" : {
             "@href" : "/api/space/device-management/devices/{id}"
           }
         }
       }
    }

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

    • Access Control

    The following capabilities are required to access this API: UndeployTemplate