Skip to main content

GET /events/exclusionfilters

Use this method to return information about all event exclusion filters, regardless of whether they are currently enabled or disabled.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/events/exclusionfilters

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDefinition
descriptionStringOptional description for the exclusion filter
eventFilterArrayEvent filter information
 fieldsObjectFields to filter on and the associated REGEX string to filter. The event fields must match one of the supported fields in the event class (see Filtering events).
 filterTypeStringType of filter. This can be one of the following values.
  • FIELDREGEXAND. Event filter matches only if all fields find a match with the given field REGEX.
  • FIELDREGEXOR. Event filter matches if any field finds a match with the given field REGEX.
  • FIELDREGEXNOT. Event filter matches only if all fields do not find a match with the given field REGEX.
idStringUnique ID assigned to the exclusion filter when it is configured
nameStringUser-defined name for the exclusion filter. This must be unique for all monitors.
stateStringCurrent state of the exclusion filter. This can be one of the following values.
  • disabled
  • enabled
typeStringEvent type. This can be one of the following values.
  • activeAlert
  • event
The following example is returned if the request is successful.
[{
   "description": "A DHCP issued IP address was changed on eth0",
   "eventFilter": {
      "fields": [{
         "field": "eventID",
         "value": "FQXHMCR0001W"
      }],
      "filterType": "FIELDREGEXOR"
   },
   "id": "XFT:1",
   "name": " z543oy0",
   "state": "enabled",
   "type": "event"
},
{
   "description": "Connectivity to chassis 4p3cmm has been restored. UUID is 
                   FFB657408BEB4161950704AB0ED3A84A.",
   "eventFilter": {
      "fields": [{
         "field": "eventID",
         "value": "FQXHMDM0004I"
      },
      {
         "field": "sourceID",
         "value": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
      }]
      "filterType": "FIELDREGEXAND",
   },   "id": "XFT:2",
   "name": " 53sr900",
   "state": "enabled",
   "type": "event"
}]