Configuration Template Management API

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

The following operations are supported on this resource:

  • POST - Deploys a configuration template to a device or a list of devices

POST /api/space/config-template-management/config-templates/{id}/exec-deploy (v1)


This API deploys a configuration template to a device or a list of devices.

Access Control

The following capabilities are required to access this API:
"DeployTemplate"


Example Usage

Since this API makes an asynchronous method call, the user must specify a queue parameter with this API.

POST /api/space/config-template-management/config-templates/{id}/exec-deploy?queue-url=<queue-url>&schedule-time=<schedule-time>

Note: It is assumed that the queue denoted by <queue-url> has, already, been created.



Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathThe ID of the configuration template to deploy. Y
queue-urlURLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)Y
schedule-timecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N

Content Types