Filters - Event Filter Details - RESTful API

Summary:

Return details of, modify, or delete a specified event filter. Note, from Entuity v21.0 upwards, you can manage event filters within config sets (see 'Config Sets - Event Filters'). This 'Event Filter Details' call will only apply to managing filters on servers that are not part of a config set.

URL:

http(s)://{server hostname}/api/eventFilters{filterId}

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Methods summary

• GET Method - shows detailed information about the event filter.
• PUT Method - modifies the parameter of the event filter.
• DELETE Method - deletes the event filter.

GET Method detail

Shows detailed information about the selected event filter.

Examples:

INPUT
curl -u admin:admin https://localhost/api/eventFilters/1001?media=json

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/1001?media=xml

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>

PUT Method detail

Modifies the parameters of the selected event filter.

Request:

Examples:

INPUT
curl -u admin:admin https://localhost/api/eventFilters/1001?media=json -X PUT -H "content-type:application/json" -d \
'{
  "name" : "B",
  "selectedNames" : [
    "AvailMonitor Application Unavailable",
    "WAN Port Low Outbound Utilization Cleared",
    "AvailMonitor High Latency Reaching Application Cleared"
  ],
  "passIP" : false
}'

OUTPUT
{
  "name" : "B",
  "selectedNames" : [
    "WAN Port Low Outbound Utilization Cleared",
    "AvailMonitor Application Unavailable",
    "AvailMonitor High Latency Reaching Application Cleared"
  ],
  "systemFilter" : false,
  "passIP" : false
}

INPUT
curl -u admin:admin https://localhost/api/eventFilters/1001?media=xml -X PUT -H "content-type:application/xml" -d \
'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventFilterInfo systemFilter="false" passIP="false" name="B">
  <selectedNames>
    <filterName>WAN Port Low Outbound Utilization Cleared</filterName>
    <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="false" name="B">
  <selectedNames>
    <filterName>WAN Port Low Outbound Utilization Cleared</filterName>
    <filterName>AvailMonitor Application Unavailable</filterName>
    <filterName>AvailMonitor High Latency Reaching Application Cleared</filterName>
  </selectedNames>
</eventFilterInfo>

DELETE Method detail

Deletes the selected event filter.

Response:

Gives the message “OK” if operation was successful. Otherwise, gives an error description.

Examples:

INPUT
curl -u admin:admin https://localhost/api/eventFilters/1001?media=json -X DELETE

OUTPUT
{
  "message" : "OK"
}

INPUT
curl -u admin:admin https://localhost/api/eventFilters/1001?media=xml -X DELETE

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<statusInfo>
    <message>OK</message>
</statusInfo>