Event filters REST API

Use this REST API to manage event filters.

Get all event filters

Resource	Value
URI	`/admin/resources/event_filters`
Method	GET
Returns	200	Returns a list of all event filters.
	404	The event filters list was not found.
	500	Platform System Manager encountered an internal error while processing the request.

Returns a list of all event filters.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
 {
  "created_time_raw": 1418352051449, 
  "text": "<msg_text>", 
  "isas_rn": 1, 
  "state": "<state>", 
  "severity": "<severity>", 
  "instances": 0, 
  "type": "<type>", 
  "updated_time": "Fri 12 Dec 2014 02:40:51.466 UTC", 
  "version": "2.1.0.0", "id": "/admin/resources/event_filters/e33f4efe-586d-40fe-a6dd-2c18f2a5db26", 
  "username": "admin", 
  "category": "<category>", 
  "updated_time_raw": 1418352051466, 
  "end_time": 1418346092700, 
  "hidden": 0, 
  "name": "filter 1", 
  "start_time": 1418346092737, 
  "created_time": "Fri 12 Dec 2014 02:40:51.449UTC" 
 } 
]

Get a specific event filter

Resource	Value
URI	`/admin/resources/event_filters/{id}`
Method	GET
Returns	200	The event filter was returned.
	404	The event filter was not found.
	500	Platform System Manager encountered an internal error while processing the request.

Returns a single event filter identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Create event filter

Resource	Value
URI	`/admin/resources/event_filters`
Method	POST
Request body Content-type	application/json
Returns	202	The event filter is created.
	4xx	There are problems creating the event filter. The returned error message contains details about the cause of the failure.
	500	The system encountered an internal error while processing the request.

Creates an event filter.

Note: If you do not require a specific filter, you can pass the request with the mandatory two properties, name and text. Ensure the name that you assign is unique. Therefore, all the events that contain the given text are returned. See the following example:

{"text":"disks","type":["Compute Node"],"severity":["Critical"],"category":"Security","hidden":"0","state":"active","name":"auto"}

If you want to include an additional filter, you can use the other properties accordingly. See the following properties:

name

The name of the filter to be created.

text

The event text to be filtered.

type

The type of the component for which the events need to be filtered. Possible values are as follows:

"Block Storage Replication",
"Chassis Network Switch",
"Cloud Pak System",
"Compute Node",
"Flex Chassis",
"Integrated Management Module",
"Internal Management Switch",
"LDAP",
"Logoff",
"Logon",
"Management Endpoint Module",
"Management Node",
"Platform System Manager",
"PureApplication Systems Manager",
"SAN Switch",
"Security Monitoring",
"Storage Subsystem",
"Switch",
"Systemlogs",
"Top of Rack Switch",
"Unknown Chassis Management Module",
"Unknown Chassis Power Module",
"Unknown SAN Switch",
"Unknown Storage Subsystem",
"Unknown Virtual Systems Manager",
"VLAN","Virtual Machine Instance",
"Virtual Management Instance",
"Workload",
"Workload Core",
"Workload Monitoring"

severity

The severity of the event to be filtered. Possible values are as follows:

"Critical",
"Warning",
"Informational",
"Unknown"

category

The category of the event to be filtered. Possible values are as follows:

"Alert",
"Resolution",
"CallService",
"CallSupport",
"CallHome",
"Security",
"CustomerServiceable"

hidden

"0" or "1" (0 implies unhidden, and 1 implies hidden).

trap_time

The time frame when the event occurred. Possible values are "1" or "24" (1 implies last one hour and 24 implies last 24 hours).

state

The state of the event raised. Possible values are "active" or "closed".

instances

If the event to be filtered in the order of occurrence. Possible values are "true" or "false" (Chronological on or off).

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Update event filter

Resource	Value
URI	`/admin/resources/event_filters/{id}`
Method	PUT
Request body Content-type	application/json
Returns	200	The event filter is updated.
	404	There are problems updating the event filter. The returned error message contains details about the cause of the failure.
	500	The system encountered an internal error while processing the request.

Updates a single event filter identified by {id}. See the following request body sample:

{"text":"disks","type":["Compute Node"],"severity":["Critical"],"category":"Security","hidden":"0","state":"active","name":"auto"}

If you want to update a filter, you can use the other properties accordingly. For more information about the other properties, see Create event filter properties.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Delete event filter

Resource	Value
URI	`/admin/resources/event_filters/{id}`
Method	DELETE
Returns	202	Accepted.
	400	The event was not deleted successfully.
	500	The system encountered an internal error while processing the request.

Deletes a single event filter identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.