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": true,
"options": {
"severity": [
"warning"
],
"type": [
"required"
],
"skipDeviceBackup": false
}
}
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",
"items": {
"type": "string",
"title": "severity",
"examples": [
"warning"
]
},
"uniqueItems": true
},
"type": {
"type": "array",
"items": {
"type": "string",
"title": "type",
"examples": [
"required"
]
},
"uniqueItems": true
},
"skipDeviceBackup": {
"type": "boolean"
}
}
}
},
"required": [
"complianceReportId",
"removeDisallowedConfig"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
remediationResult |
object |
- |
Copied to Clipboard
{
"response": [
{
"result": false,
"parents": [
"consectetur"
],
"new": "et exercitation ad",
"old": "occaecat minim quis sed adipisicing"
},
{
"result": true,
"parents": [
"sit",
"ad"
],
"new": "officia Excepteur amet pariatur nulla",
"old": "sunt non ea"
},
{
"result": true,
"parents": [
"quis laboris et"
],
"new": "nisi",
"old": "laborum esse cillum"
},
{
"result": false,
"parents": [
"ex qui officia nisi magna",
"Duis sunt culpa",
"Duis minim fugiat",
"esse Duis consectetur"
],
"new": "et anim esse sit",
"old": "id aliquip occaecat"
},
{
"result": true,
"parents": [
"est minim aliqua Lorem ullamco",
"exercitation"
],
"new": "officia est dolor",
"old": "aute"
}
]
}
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"
}
}
}
}
}
}