Summary:
List available incident filters, and create new filters. Note, from Entuity v21.0 upwards, you can manage incident filters within config sets (see Config Sets - Incident Filters). This 'Incident Filters' call will only apply to managing filters on servers that are not part of a config set.
URL:
http(s)://{server hostname}/api/incidentFilters
Methods summary
- GET Method - lists available incident filters.
- POST Method - creates new incident filter.
GET Method detail
Lists available incident filters.
Response:
Response includes a list of incident filters. Each incident filter has the following attributes:
| Name | Description |
|---|---|
| serverId |
Entuity Server Id on which resource resides. |
| Id | incident filter id unique to the server. |
| name | incident filter name. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/incidentFilters?media=json
OUTPUT
{
"items" : [ {
"serverId" : "821c3e87-bcdf-4fef-a5e8-7d2524928d96",
"id" : "1",
}, {
"serverId" : "821c3e87-bcdf-4fef-a5e8-7d2524928d96",
"id" : "2",
"name" : "TestIncidents"
} ],
"count" : 2
}
INPUT
curl -u admin:admin https://localhost/api/incidentFilters?media=xml
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
<item xsi:type="namedItem" name="All Incidents" id="1" serverId="821c3e87-bcdf-4fef-a5e8-7d2524928d96" />
<item xsi:type="namedItem" name="TestIncidents" id="2" serverId="821c3e87-bcdf-4fef-a5e8-7d2524928d96" />
</items>
POST Method detail
Creates new incident filter.
Request:
| Name | Description |
|---|---|
| name |
filter name. |
| selectedNames | array of filter names. |
| passIP | whether the filter should include devices that are not under management. |
Response:
| Name | Description |
|---|---|
| name |
filter name. |
| selectedNames | array of filter names. |
| systemFilter | whether the filter is a system filter. |
| passIP | whether the filter should include devices that are not under management. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/incidentFilters?media=json -X POST -H "content-type:application/json" -d \
'{
"name" : "A",
"selectedNames" : [
"AP Antenna Host Count Abnormality",
"AP Not Associated With Controller"
],
"passIP" : false
}'
OUTPUT
{
"name" : "A",
"selectedNames" : [
"AP Antenna Host Count Abnormality",
"AP Not Associated With Controller"
],
"systemFilter" : false,
"passIP" : false
}
INPUT
curl -u admin:admin https://localhost/api/incidentFilters?media=xml -X POST -H "content-type:application/xml" -d \
'<eventFilterInfo systemFilter="false" passIP="true" name="A">
<selectedNames>
<filterName>AvailMonitor High Latency</filterName>
<filterName>AvailMonitor Application Problem</filterName>
</selectedNames>
</eventFilterInfo>'
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventFilterInfo systemFilter="false" passIP="true" name="A">
<selectedNames>
<filterName>AvailMonitor High Latency</filterName>
<filterName>AvailMonitor Application Problem</filterName>
</selectedNames>
</eventFilterInfo>
Comments
0 comments
Please sign in to leave a comment.