Summary:
List available event filters, and create new filters. Note, from Entuity v21.0 upwards, you can manage event filters within config sets (see Config Sets - Event Filters). This 'Event Filters' call will only apply to managing filters on servers that are not part of a config set.
URL:
http(s)://{server hostname}/api/eventFilters
Methods summary
- GET Method - lists available event filters.
- POST Method - creates a new event filter.
GET Method detail
Lists available event filters.
Response:
Response includes a list of event filters. Each event filter has the following attributes:
| Name | Description |
|---|---|
| serverId |
Entuity Server Id on which resource resides. |
| Id | event filter id unique to the server. |
| name | event filter name. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/eventFilters?media=json
OUTPUT
{
"items": [
{
"serverId": "98eb1254-0d30-4c7d-8910-ac610cd5e351",
"id": "1001",
"name": "A"
},
{
"serverId": "98eb1254-0d30-4c7d-8910-ac610cd5e351",
"id": "1",
"name": "All Events"
}
],
}
INPUT
curl -u admin:admin https://localhost/api/eventFilters?media=xml
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
<item xsi:type="namedItem" name="A" id="1001" serverId="98eb1254-0d30-4c7d-8910-ac610cd5e351" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
<item xsi:type="namedItem" name="All Events" id="1" serverId="98eb1254-0d30-4c7d-8910-ac610cd5e351" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
</items>
POST Method detail
Creates a new event filter.
Request:
Event filter parameters:
| 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/eventFilters?media=json -X POST -H "content-type:application/json" -d \
'{
"name" : "A",
"selectedNames" : [
"AvailMonitor Application Unavailable",
"AvailMonitor High Latency Reaching Application Cleared"
],
"passIP" : true
}'
OUTPUT
{
"name" : "A",
"selectedNames" : [
"AvailMonitor Application Unavailable",
"AvailMonitor High Latency Reaching Application Cleared"
],
"systemFilter" : false,
"passIP" : true
}
INPUT
curl -u admin:admin https://localhost/api/eventFilters?media=xml -X POST -H "content-type:application/xml" -d \
'<eventFilterInfo systemFilter="false" passIP="true" name="A">
<selectedNames>
<filterName>AvailMonitor Application Unavailable</filterName>
<filterName>AvailMonitor High Latency Reaching Application Cleared</filterName>
</selectedNames>
</eventFilterInfo>
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventFilterInfo systemFilter="false" passIP="true" name="A">
<selectedNames>
<filterName>AvailMonitor Application Unavailable</filterName>
<filterName>AvailMonitor High Latency Reaching Application Cleared</filterName>
</selectedNames>
</eventFilterInfo>
Comments
0 comments
Please sign in to leave a comment.