Custom Products
Custom Products allows to manage custom patch products.
Base URL
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products
Supported Requests
| Method | URL | Input | Return |
|---|---|---|---|
|
DELETE |
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId} |
|
Success or failure code |
|
GET |
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products |
CustomProducts[] |
|
|
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId} |
|
CustomProduct |
|
|
PUT |
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId} |
Success or failure code |
|
|
POST |
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products |
CustomProduct with Success or failure code |
Input Models
URL Parameters
| Name | Type | Description |
|---|---|---|
| productUId | String | The unique identifier of the product. |
Request Body
| Name |
Required? |
Type | Description |
|---|---|---|---|
| Name |
Yes |
String | The Product name. |
| Registry Checks |
Conditional |
Registry Check | The registry detection rules. |
Registry Check
| Name | Required? | Type | Description |
|---|---|---|---|
|
ComparisonOperator |
Yes |
enum |
Comparison operator (e.g., EqualTo) •EqualTo •NotEqual •LessThan •LessThanOrEqual •GreaterThan •GreaterThanOrEqual •Exists •NotExists |
|
DataType |
Yes |
enum |
Registry data type (e.g., String) •String •DWord •QWord •Binary •MultiString •ExpandString |
|
Key |
Yes |
String |
Registry key path |
|
ValueData |
Yes |
String |
Value data to match |
|
ValueName |
Yes |
String |
Registry value name |
|
Use64 |
Yes |
Boolean |
Use 64-bit registry view |
Example with Sample Response
To retrieve a list of all custom patch products
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products
Sample Response
{
"count": 2,
"value": [
{
"isCustom": true,
"links": {
"self": {
"href": "https://desktop-tu4cqgs:3121/st/console/api/v1.0/custompatch/products/87e116a7-f2b5-4166-9809-bc0685572a04"
}
},
"name": "6gFEQIsecCp",
"registryChecks": [
{
"comparisonOperator": "GreaterThanOrEqual",
"dataType": "String",
"key": "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{83029376-5827-47D3-A82C-DA771434EFBE}",
"use64": true,
"valueData": "DisplayVersion",
"valueName": "9.8.119.0"
}
],
"spId": "ceb8852c-d05c-4574-af71-6ebe707035a2",
"uid": "87e116a7-f2b5-4166-9809-bc0685572a04"
},
{
"isCustom": true,
"links": {
"self": {
"href": "https://desktop-tu4cqgs:3121/st/console/api/v1.0/custompatch/products/c1671ea0-479e-4e16-a346-9939e8481c1d"
}
},
"name": "6gFEQIsecCdp",
"registryChecks": [
{
"comparisonOperator": "GreaterThanOrEqual",
"dataType": "String",
"key": "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{83029376-5827-47D3-A82C-DA771434EFBE}",
"use64": true,
"valueData": "DisplayVersion",
"valueName": "9.8.119.0"
}
],
"spId": "3e28100c-bd78-4c53-bce9-49125bc92643",
"uid": "c1671ea0-479e-4e16-a346-9939e8481c1d"
}
]
}
Other Request Examples
Get single custom patch product by its unique ID
Get Request
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId}
Create new custom patch product
POST Request
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products
{
"Name": "CustomProduct",
"registryChecks": [
{
"key": "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{83029376-5827-47D3-A82C-DA771434EFBE}",
"valueName": "DisplayVersion",
"dataType": "String",
"valueData": "9.8.119.0",
"use64": true,
"comparisonOperator": "GreaterThanOrEqual"
}
]
}
PUT Request
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId}
{
"name" : "CustomProduct Updated"
}DELETE Request
https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/products/{productUId}
Get a list of all system target custom patch products.
GET Request
https://<consoleFQDN:port>//st/console/api/v1.0/custompatch/targetproducts