Use this method to return information about all event filters that are associated with a specific push notification service.
Authentication with user name and password is required.
GET https://{management_server_IP}/events/notifications/{pusher_type}/subscriptions/{subscription_ID}/filters
{pusher_type} is the type of push notification service. This can be one of the following values.
{subscription_ID} is the UID of the subscription is retrieved. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.
None
None
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A 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. |
401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Attributes | Type | Definition | |||
---|---|---|---|---|---|
eventFilter | Array of objects | Information about the types of events to filter. | |||
filter | Object | Information about each event filter. | |||
categories | Array of strings | Event categories. This can be one of the following values.
|
|||
componentIDs | Array of strings | List of component IDs. If empty, all components are accepted. | |||
sourceIDs | Array of strings | List of source IDs. If empty, all sources are accepted. | |||
typeSeverity | Array of objects | Event severity and type. If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter is forwarded. |
|||
severity | String | Event severity. This can be one of the following values.
|
|||
type | String | Event type. This can be one of the following values.
|
|||
eventFilterDescription | String | Event filter description | |||
eventFilterName | String | Event filter name | |||
isDeletable | Boolean | Indicates whether the event filter can be deleted | |||
isEditable | Boolean | Indicates whether this event filter can be modified | |||
isUsed | Boolean | Indicates whether this event filter is used by at least one subscription | |||
lockedPredefinedFilter | Boolean | Indicates whether this is a predefined event filter that is provided by default by XClarity Administrator | |||
matchEveryCoreEvent | Boolean | Indicates whether this event filter accepts all core events | |||
matchEverySystem | Boolean | Indicates whether this event filter must match every event from every managed device | |||
matchEverything | Boolean | Indicates whether this event filter matches all events | |||
name | String | User-defined name of the event filter. This must be unique for all filters. |
[{
"eventFilter": {
"filter": {
"categories": ["GENERAL"],
"componentIDs": [],
"sourceIDs": [],
"typeSeverity": [{
"severity": "MAJOR",
"type": "UNKNOWN"
},
...,
{
"severity": "FATAL",
"type": "SWITCH"
}]
}
},
"eventFilterDescription": "This filter will match all critical event generated in any
of the managed endpoints or the manage server itself.",
"eventFilterName": "Match All Critical",
"isDeletable": false,
"isEditable": false,
"isUsed": true,
"lockedPredefinedFilter": true,
"matchEveryCoreEvent": false,
"matchEverySystem": true,
"matchEverything": false
},
{
"eventFilter": {
"filter": {
"categories": ["GENERAL"],
"componentIDs": [],
"sourceIDs": [],
"typeSeverity": [{
"severity": "WARNING",
"type": "UNKNOWN"
},
...,
{
"severity": "MINOR",
"type": "SWITCH"
}]
}
},
"eventFilterDescription": "This filter will match all warning event generated in any of the
managed endpoints or the manage server itself.",
"eventFilterName": "Match All Warning",
"isDeletable": false,
"isEditable": false,
"isUsed": true,
"lockedPredefinedFilter": true,
"matchEveryCoreEvent": false,
"matchEverySystem": true,
"matchEverything": false
}]