Patch Deployment Templates

When deploying patches to machines, patch deployment templates allow you to specify a number of different options. For example, you can specify whether the deployment target should be restarted after the deployment, how fast the patches should be copied to the remote machines, whether reports should be sent, and much more.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates/{patch deploy template id}

 

Success or failure code.

You cannot delete a predefined template.

GET

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates

URL Parameters

PatchDeploymentTemplates[]

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates/{patch deploy template guid}

 

PatchDeployTemplate

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates/{patch deploy template id}/customactions

 

CustomActions[]

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates/{patch deploy template id}/customactions/{custom action id}

 

CustomAction

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates/{patch deploy template id}/usedby

 

Usedby[]

POST

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates

Request Body

 

Input Models

Example with Sample Response

Create a patch deployment template named "Sample"

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deploytemplates

Request Body

{"Name":"Sample","Description":"A sample deployment template created using the REST API"}

Sample Response

{

"creator": "SHAVLIK\\joe.coder",

"description": "A sample deployment template created using the REST API",

"generalOptions": {

"removeTempFiles": false,

"sendTrackerMessages": true,

"shutdownIis": false,

"shutdownSql": false

},

"id": "9b5d4668-48fa-41ed-b424-094e6922a11b",

"isSystem": false,

"isTemporary": false,

"links": {

"customactions": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/deploytemplates/9b5d4668-48fa-41ed-b424-094e6922a11b/customactions"

},

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/deploytemplates/9b5d4668-48fa-41ed-b424-094e6922a11b"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/deploytemplates/9b5d4668-48fa-41ed-b424-094e6922a11b/usedby"

}

},

"name": "Sample",

"postDeploymentReboot": {

"options": {

"powerState": "Restart",

"countdownMinutes": 5,

"extendMinutes": 1,

"forceActionAfterMinutes": 10,

"loggedOnUserAction": "ForceActionAfterMinutes",

"systemDialogSeconds": 60,

"userOptions": "AllowExtension"

},

"when": "Immediate"

},

"preDeploymentReboot": {

"when": "NoReboot"

},

"virtualOptions": {

"takePostDeploymentSnapshots": false,

"takePreDeploymentSnapshots": false

}

}

Other Request Examples

Output Models