Security Controls REST API

Home 

Patch Downloads

The Patch Downloads method enables you to find patch download information, download patches and delete patches by their download ID.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

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

URL Parameters

ErrorPolicy (optional)

 

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}

 

 

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}/InvariantCulture

 

 

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}/{culture of patch}

 

 

     

GET

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}

 

An array of patch downloads

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}/{culture of patch}

 

PatchDownload

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

URL Parameters

An array of PatchDownload

     

POST

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/scans/{ID}

 

The operation location URI.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID}

 

 

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

 

The operation location URI.

Input Model

URL Parameters

Name Type Description

count

Integer

Provide the count of items to return. The maximum value is 50.

culture

String

Specifies the language culture name.

ids

String

Specifies the patch IDs.

start

Guid

Sets the starting point.

Example

Find patch download information for the first 2 patches for culture en-US

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/?count=2&culture=en-US

Sample Response

{

"count": 2,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/downloads?count=2&start=000000ba-0000-0000-0000-000000000000"

}

},

"value": [

{

"cultureName": "en-US",

"downloaded": false,

"downloadMethod": "Unavailable",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/downloads/00000042-0000-0000-0000-000000000000?culture=en-US"

}

},

"patchId": "00000042-0000-0000-0000-000000000000"

},

{

"cultureName": "en-US",

"downloaded": false,

"downloadMethod": "Automatic",

"fileName": "Q274303 _WMP70_Gold_x86_ENU.exe",

"filePath": "C:\\ProgramData\\LANDESK\\Shavlik Protect\\Console\\Patches\\Q274303 _WMP70_Gold_x86_ENU.exe",

"fileSize": 267792,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/downloads/00000093-0000-0000-0000-000000000000?culture=en-US"

}

},

"patchId": "00000093-0000-0000-0000-000000000000"

}

]

}

Other Request Examples

Find patch download information for patch with ID 000000ba-0000-0000-0000-000000000000 for culture en-US

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/000000ba-0000-0000-0000-000000000000?culture=en-US

Delete patch download ID 000000ba-0000-0000-0000-000000000000 for culture en-US

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/000000ba-0000-0000-0000-000000000000?culture=en-US

Download all missing patches identified by a scan with ID 01234567-89AB-CDEF-0123-456789ABCDEF

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/scans/01234567-89AB-CDEF-0123-456789ABCDEF

 

Output Model

PatchDownload

Name Type Description

cultureName

String

The language culture name.

downloaded

Boolean

Specifies if the patch has been downloaded.

downloadMethod

 

The method used to download the patch.

fileName

String

The base file name.

filePath

String

The location of the patch file on the console machine.

fileSize

Int64

The file size.

links

Links

Shows the related URL for the patch.

patchId

Guid

The unique identifier that was automatically assigned to the patch.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other