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

The following operation is supported on this resource:

  • POST - Deploy a configuration template to a device or a list of devices
POST /config-templates/{id}/exec-deployVersion 2

This API deploys a configuration template to 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-deploy?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-deploy-request>
         <devices>
               <device href="/api/space/device-management/devices/{id}">
                   <name>String</name>
               </device>
         </devices>
         <resolved-variables>
               <device>
                   <device-id>Integer</device-id>
                   <variables total="Integer">
                         <variable>
                             <values total="Integer">
                                   <value>String</value>
                             </values>
                             <name>String</name>
                         </variable>
                   </variables>
               </device>
         </resolved-variables>
    </exec-deploy-request>

  • Sample Input JSON:
    {
       "exec-deploy-request" : {
         "devices" : {
           "device" : {
             "@href" : "/api/space/device-management/devices/{id}" ,
             "name" : "String"
           }
         } ,
         "resolved-variables" : {
           "device" : {
             "device-id" : "Integer" ,
             "variables" : {
               "@total" : "Integer" ,
               "variable" : {
                 "values" : {
                   "@total" : "Integer" ,
                   "value" : "String"
                 } ,
                 "name" : "String"
               }
             }
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: DeployTemplate