/api/space/config-template-management/config-templates/{id}/exec-undeploy
The following operations are supported on this resource:
- POST - Undeploys a configuration template from a device or a list of devices
POST /api/space/config-template-management/config-templates/{id}/exec-undeploy (v1)
This API undeploys a configuration template from a device or a list of devices.
Access Control
The following capabilities are required to access this API:
"UndeployTemplate"
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-undeploy?queue-url=<queue-url>&schedule-time=<schedule-time>Note: It is assumed that the queue denoted by <queue-url> has, already, been created.
Parameters
| Name | Type | URI Type | Description | Required |
| id | Integer | Path | The ID of the configuration template to undeploy. | Y |
| queue-url | URL | Query | A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) | Y |
| schedule-time | cron-like-expression | Query | Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) | N |
Content Types
-
Consumes content types:
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 -
Produces content types:
application/vnd.net.juniper.space.job-management.task+xml;version=1;q=0.01
application/vnd.net.juniper.space.job-management.task+json;version=1;q=0.01 -
Sample Input XML:
<exec-undeploy-request>
<devices>
<device href="/api/space/device-management/devices/{id}"/>
</devices>
</exec-undeploy-request> -
Sample Input JSON:
{
"exec-undeploy-request" : {
"devices" : {
"device" : {
"@href" : "/api/space/device-management/devices/{id}"
}
}
}
}