Skip to main content

POST /events/exclusionfilters

Use this method to exclude events or alerts that are of no interest for managing devices and no actions need to be taken when the events or alerts are received.

Authentication​

Authentication with username and password is required.

Request URL​

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

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
descriptionRequiredStringUser-defined description
eventFilterRequiredArray of objectsEvent filters. Each object that contain the following attributes.
{
   "filterType": "{filter_type}",
   "fields": [{
      "field": "{filter}",
      "operation": "{operation}",
      "value": "{value}"
   }]
}

For more information, see Filtering events.

nameRequiredStringUser defined name for the exclusion filter
Note
This name must be unique.
typeRequiredStringType of exclusion filter. This can be one of the following values.
  • event
  • activeAlert
The following example ignores all FQXHMCP5810I events on all devices in two specific groups.
{
   "description": "Ignore all FIELDREGEXAND events from devices in specific groups",>, 
   "eventFilter": { 
      "filterType": "FIELDREGEXAND",
      "fields": [{ 
         "field": "eventID", 
         "value": "FQXHMCP5810I",  
      }, 
      { 
         "field"  "groupUUID", 
         "value": ["FFB657408BEB4161950704AB0ED3A84A","FFB657408BEB4161950704AB0ED3A84B"] 
      }] 
   },
   "name": "group events", 
   "type": "event"
}

The following example ignores all alerts from server 65AEDE9C03B311E18A2AC4C1BD6B35B2.

{
   "description": "Ignore all events from server 65AEDE9C03B311E18A2AC4C1BD6B35B2",
   "eventFilter": {
      "filterType": "FIELDREGEXAND", 
      "fields": [{
         "field": "sourceID",
         "value": "65AEDE9C03B311E18A2AC4C1BD6B35B2"
      }]
   },
   "name": "65AEDE9C03B311E18A2AC4C1BD6B35B2 alerts",
   "type": "activeAlert"
}

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​

AttributesTypeDescription
idStringUnique ID of the exclusion-filter
The following example is returned if the request is successful.
{
   "id": "AUG:XFT:0"
}