PUT /events/notifications/subscriptions/{subscription_id}/filters
Use this method to modify an event filter.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/events/notifications/subscriptions/{subscription_id}/filters
Query parameters
None
Request body
Attributes | Required / Optional | Type | Definition | ||||
---|---|---|---|---|---|---|---|
action | Required | String | Action to perform. This can be one of the following values.
| ||||
filter | Required | Object | List of event filters | ||||
eventFilter | Required | Array of objects | Information about the types of events to filter | ||||
filter | Required | Object | Information about each event filter | ||||
categories | Required | Array of strings | Event categories. This can be one of the following values.
| ||||
componentIDs | Optional | Array of strings | List of component IDs. If empty, all components are accepted. | ||||
sourceIDs | Optional | Array of strings | List of source IDs. If empty, all sources are accepted. | ||||
typeSeverity | Required | Array of objects | Event severity and type. If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter is forwarded. | ||||
severity | Optional | String | Event severity. This can be one of the following values.
| ||||
type | Optional | String | Event type. This can be one of the following values.
| ||||
eventFilterDescription | Optional | String | Event filter description | ||||
eventFilterName | Optional | String | Event filter name | ||||
matchEveryCoreEvent | Optional | Boolean | Indicates whether this event filter accepts all core events. | ||||
matchEverySystem | Optional | Boolean | Indicates whether this event filter must match every event from every managed device | ||||
matchEverything | Optional | Boolean | Indicates whether this event filter matches all events | ||||
uid | Required | String | Subscription ID |
The following example modifies an event filter.
{
"action": "edit",
"filter": {
"eventFilter": {
"filter": {
"categories": ["WARRANTY", "GENERAL"],
"componentIDs": [],
"sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"],
"typeSeverity": [{
"severity": "fatal",
"type": "all"
},
...,
{
"severity": "informational",
"type": "audit"
}]
}
},
"eventFilterDescription": "sadfasdf",
"eventFilterName": "asdfasdf",
"matchEveryCoreEvent": false,
"matchEverySystem": false
},
"uid": "1"
}
Response codes
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. |
Response body
None
Give documentation feedback