Security Controls REST API

Home 

Patch Deployment Machine Status

Patch deployments status queries are used to interrogate the state of a specific deployment for each machine in the deployment. This query supports pagination on a per machine basis.

Base URL

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

Supported Requests

Method URL Input Return

GET

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

URL Parameters

Patch deployment status for all machines specified in the deployment.

Input Model

URL Parameters

Name Type Description

count

Integer

Provide the count machines with statuses from the given deployment. The maximum value is 50.

onOrAfter

DateTime

Returns the machine deployment status on or after the specified date.

start

Integer

Sets the starting point.

Example

Find the machine and patch statuses associated with patch deployment GUID 01234567-89AB-CDEF-0123-456789ABCDEF with five machine per page, but only including the statuses that occurred on or after 2018-01-27T20:02:33.457Z

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/deployments/01234567-89AB-CDEF-0123-456789ABCDEF/machines?count=5&OnOrAfter=2018-01-27T20:02:33.457Z

Sample Response

{

"count": 1,

"value": [

{

"completedPatches": 2,

"dnsName": "device-name.fakedomain.com",

"domain": "SHAVLIK",

"id": 1002,

"lastUpdated": "2018-07-10T19:19:19.79Z",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/deployments/02934c25-b04a-4781-aa55-f1c881e10757/machines/1002"

}

},

"name": "device-name",

"overallState": "Complete",

"patchStates": [

{

"bulletinId": "GIMP-014",

"finishedOn": "2018-07-10T19:18:49.417",

"hasExecuted": true,

"kb": "QGIMP2104",

"lastUpdated": "2018-07-10T19:18:49.417",

"nativeCode": 0,

"overallState": "Complete",

"overallStateDescription": "Complete",

"patchId": "0001e72e-0000-0000-0000-000000000000",

"scheduledOn": "2018-07-10T14:14:52.597",

"startedOn": "2018-07-10T19:16:34.92",

"status": "VerifiedFixed",

"statusDescription": "Successfully installed"

},

{

"bulletinId": "NPPP-082",

"finishedOn": "2018-07-10T19:16:34.9",

"hasExecuted": true,

"kb": "QNPPP757",

"lastUpdated": "2018-07-10T19:16:34.9",

"nativeCode": 0,

"overallState": "Complete",

"overallStateDescription": "Complete",

"patchId": "0001e5da-0000-0000-0000-000000000000",

"scheduledOn": "2018-07-10T14:14:52.597",

"startedOn": "2018-07-10T19:16:31.923",

"status": "VerifiedFixed",

"statusDescription": "Successfully installed"

}

],

"statusDescription": "Finished"

}

]

}

 

Output Model

PatchDeployState

Name Type Description

bulletinId

String

The bulletin ID or product being applied.

finishedOn

DateTime

Date and time that the deployment finished installing patches.

hasExecuted

Boolean

Has the patch deployment been executed?

kb

String

The KB number of the patch or service pack level.

lastUpdated

DateTime

Date and time that the patch deployment status was last updated.

nativeCode

Integer

The native error code if the patch deployment failed.

overallState

DeploymentState

The overall state of the patch deployment (in progress, complete or failed).

overallStateDescription

String

A localized description of the overall deployment state.

patchId

Guid

The patch ID.

scheduledOn

DateTime

The date and time the patch was scheduled for deployment.

startedOn

DateTime

The date and time that the patch deployment started.

status

DeploymentResult

The deployment result status.

statusDescription

String

A localized description of the status.


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other