Summary
Auto remediate with additional options.
Description
Patch device configuration automatically from compliance report.
Route
No Northbound API Available
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
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": false,
"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
DetailsExampleSchema
Name |
Type |
Description |
remediationResult |
object |
- |
Copied to Clipboard
{
"response": [
{
"result": true,
"parents": [
"enim velit Lorem",
"tempor",
"occaecat sunt eiusmod voluptate sed",
"quis laborum",
"elit"
],
"new": "do sed est",
"old": "mollit"
},
{
"result": false,
"parents": [
"nostrud commodo proident enim",
"aute in mollit"
],
"new": "in",
"old": "incididunt ad irure"
},
{
"result": false,
"parents": [
"amet esse",
"esse eu tempor culpa",
"aliqua qui quis"
],
"new": "Excepteur aliquip minim ipsum",
"old": "sunt"
},
{
"result": true,
"parents": [
"tempor",
"qui quis",
"do consequat",
"ex"
],
"new": "cillum",
"old": "amet sit velit culpa elit"
},
{
"result": false,
"parents": [
"Excepteur in",
"sunt dolor sed do velit",
"dolore do adipisicing",
"ea exercitation veniam aliqua"
],
"new": "consequat magna incididunt amet in",
"old": "aute qui in enim"
}
]
}
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"
}
}
}
}
}
}