REST Resources
-
/ -
/config-template-definitions -
/config-template-definitions /{def-id} /config-templates /{template-id} -
/config-template-definitions /{id} -
/config-template-definitions /{id} /config-templates -
/config-template-definitions /{id} /configuration -
/config-templates -
/config-templates /config-templates-by-ids2 -
/config-templates /deleteTemplateWithVersions -
/config-templates /{from-template-id} /clone -
/config-templates /{id} -
/config-templates /{id} /exec-audit -
/config-templates /{id} /exec-deploy -
/config-templates /{id} /exec-publish -
/config-templates /{id} /exec-undeploy -
/config-templates /{id} /versions -
/config-templates /{id} /versions /{template-version} /exec-auditTemplate -
/config-templates /{id} /versions /{template-version} /exec-compareConfig -
/config-templates /{id} /versions /{template-ver} /exec-deploy -
/config-templates /{id} /versions /{template-ver} /exec-publish -
/config-templates /{id} /versions /{version-num} -
/config-templates /{id} /versions /{version} /configuration -
/config-templates /{template-id} /configuration -
/config-templates /{template-id} /device-associations -
/config-templates /{template-id} /versions /{version-num} /device-associations -
/export-compare-template-job-results -
/jobs /{job-id} /compare-template-job-results -
/templates /{template-id} /devicesAll -
/templates /{template-id} /template-versions
/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-undeploy | Version 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:
Name Type URI Type Description Required id Integer Path The ID of the configuration template. Y queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
-
Content-Type Headers:
application/vnd.net.juniper.space.config-template-management.exec-undeploy-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.config-template-management.exec-undeploy-request+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<exec-undeploy-request>
<devices>
<device href="/api/space/device-management/devices/{id}"/>
</devices>
</exec-undeploy-request>
<task href="/api/space/job-management/jobs/3997704">
<id>3997704</id>
</task>
{
"exec-undeploy-request" : {
"devices" : {
"device" : {
"@href" : "/api/space/device-management/devices/{id}"
}
}
}
}
{
"task": {
"@href":"/api/space/job-management/jobs/3997704",
"id":3997704
}
}
Access Control
The following capabilities are required to access this API: UndeployTemplate