Skip to main content

PUT /events/exclusionfilters

Use this method to modify event exclusion filters after they are configured without requiring that they be deleted and re-added. When editing an exclusion filter, the ID of the updated exclusion filter is included in the response.

All attributes in the exclusion filter can be changed. For example, a monitor could be temporarily disabled and then enabled again at a later time.

Authentication​

Authentication with username and password is required.

Request URL​

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

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDefinition
descriptionOptionalStringOptional description for the exclusion filter
eventFilterRequiredArrayEvent filter information
 fieldsOptionalObjectFields to filter on and the associated REGEX string to filter. The event field must match one of the supported fields in the event class (see Filtering events).
 filterTypeOptionalStringType 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.
idRequiredStringUnique ID assigned to the exclusion filter when it is configured
nameRequiredStringUser-defined name for the exclusion filter. This must be unique for all monitors.
stateOptionalStringCurrent state of the exclusion filter. This can be one of the following values.
  • disabled
  • enabled
typeRequiredStringEvent type. This can be one of the following values.
  • activeAlert
  • event

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​

If successful, response includes a JSON object that contains the ID for the exclusion filter along with other optional attributes.