Patch Deployments

Patch deployments are used to install patches to target machines that were identified as missing from a patch scan. You can start a deployment, locate existing deployments and delete deployments.

If you initiate a patch deployment remotely via the REST API, you must initialize a session credential.

Base URL

        https://<consoleFQDN:port>/stconsole/api/v1.0/patch/deployments

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments/{deployment id}

 

Success or failure code

GET

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

 

PatchDeployments[]

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

URL Parameters

PatchDeployments[]

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments/{deployment id}

 

PatchDeployment

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments/{deployment id}/machines

URL Parameters

MachineDeployState

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments/{deployment id}/machines/{machine id}

 

MachineDeployState

POST

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

Request Body

Operation location

Input Models

Example with Sample Response

Find all patch deployments using a deployment template named Sample

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments?name=Sample

Sample Response

{

"count": 1,

"value": [

{

"completedMachineCount": 1,

"creator": "SHAVLIK\\Test.User",

"expectedMachineCount": 1

"isComplete": true

"lastUpdatedOn": "2018-02-12T14:42:27.923Z"

"links": "{"

"self": "{"

"href": "https://YourConsoleName:3121/st/console/api/v1.0/patch/deployments/d7a59ec7-2bdd-4492-9e41-c23ac84c64d6"

}

}

"name": "Sample"

"startedOn": "2018-02-12T14:36:41.707Z"

"id": "d7a59ec7-2bdd-4492-9e41-c23ac84c64d6"

}

]

}

Other Request Examples

Output Models