Summary
Auto remediate with additional options.
Description
Patch device configuration automatically from compliance report.
Route
No Northbound API Available
Roles
admin
apiwrite
Parameters
Details Example Schema
Name
Type
Required
Description
complianceReportId
string
yes
-
removeDisallowedConfig
boolean
yes
-
options
object
no
Additional options to specify which items to remediate.
Copied to Clipboard
{
"complianceReportId": "5c35355dbebaa82eaf8113f0",
"removeDisallowedConfig": true,
"options": {
"severity": "['warning']",
"type": "['required']"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"complianceReportId": {
"title": "complianceReportId",
"$ref": "common#/definitions/mongoObjectId"
},
"removeDisallowedConfig": {
"title": "removeDisallowedConfig",
"type": "boolean"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"severity": {
"type": "array",
"examples": [
"['warning']"
]
},
"type": {
"type": "array",
"examples": [
"['required']"
]
}
}
}
},
"required": [
"complianceReportId",
"removeDisallowedConfig"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
remediationResult
object
-
Copied to Clipboard
{
"response": [
{
"result": true,
"parents": [
"dolor velit qui culpa",
"minim non ad laborum dolore",
"adipisicing sint ea sed sunt"
],
"new": "nostrud labore in consequat",
"old": "velit"
}
]
}
Copied to Clipboard
{
"title": "remediationResult",
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
},
"parents": {
"type": "array",
"items": {
"type": "string"
}
},
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
}
}
}
}
