Summary:
List the incident filters in a config set, and add or update incident filters.
URL:
http(s)://{server hostname}/api/cfg/serverGroupsConfig/{serverGroupId}/incidentFilters
Methods summary
- GET Method - lists the incident filters applied to a specified config set.
- POST Method - add or update incident filters in a specified config set.
GET Method detail
Lists the incident filters applied to a specified config set.
Response:
| Name | Description |
|---|---|
|
filterUUID |
unique filter identifier. |
|
name |
name of the filter. |
|
selectedNames |
array of incidents permitted by the filter. |
|
passIP |
if the filter should include devices not under management, either 'true' or 'false'. |
|
count |
number of filters. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/82e7c418-cd48-4fbf-857b-cddb475841a2/incidentFilters
OUTPUT
{
"items" : [ {
"filterUUID" : "--AllEventsFilter--",
"name" : "All Incidents",
"passIP" : true
}, {
"filterUUID" : "4d76a68e-d960-438f-95b3-1cc395d2ac16",
"name" : "Test Incident Filter",
"selectedNames" : [ "ACI Event" ],
"passIP" : false
} ],
"filterUUID" : "1a6cc6aa-f56a-4978-a16f-f239257373bd",
"name" : "Test Incident Filter",
"selectedNames" : [ "ACI Event" ],
"passIP" : false
} ],
"count" : 3
}
POST Method detail
Add or update incident filters in a specified config set.
Request:
| Name | Description |
|---|---|
| name | name of the filter. |
|
selectedNames |
array of incidents permitted by the filter |
|
flags |
whether IP filters are passed. |
Response:
| Name | Description |
|---|---|
| errorCode | code for the change outcome, e.g. 'Success'. |
| errorDetails | details of an error, if applicable. |
| configurationChangeId | ID of the current configuration change, referred to in the table under the Sync History tab on the Multi-Server Configuration page. Each time a config set is updated, the set gains a new configuration change ID. This ID is an auto-incrementing number. |
| serverGroupId | ID of the config set. |
| timestampSec | timestamp of the change. |
| modifiedBy | user who made the change. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/82e7c418-cd48-4fbf-857b-cddb475841a2/incidentFilters -X POST -H "content-type:application/json" -d '
{
"name" : "Test Incident Filter",
"selectedNames" : [ "ACI Event" ],
"flags" : 1
}'
OUTPUT
{
"errorCode" : "SUCCESS",
"errorDetails" : null,
"data" : {
"configurationChangeId" : 96,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"timestampSec" : 1677586487,
"modifiedBy" : "admin"
}
}
Comments
0 comments
Please sign in to leave a comment.