POST /events/notifications/{pusher_type}/subscriptions/{subscription_ID}/filters
Use this method to create an event filter for a specific subscription.
If you are logged in as a user with one of the following roles, information that is associated with all subscriptions is returned; otherwise, information associated with subscriptions for only the logged-in user is returned.
- lxc-admin
- lxc-supervisor
- lxc-security-admin
- lxc-sysmgr
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/events/notifications/{pusher_type}/subscriptions/{subscription_ID}/filters
where
{pusher_type} is the type of push notification service. This can be one of the following values.
- AndroidPusher. Google device push service
- iOSPusher. Apple device push service
- WebSocketPusher. WebSocket servic
TipBecause the subscription ID is unique, specifying the type of push notification service is optional{subscription_ID} is the UID of the subscription to be retrieved. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.
Query parameters
None
Request body
Attributes | Required / Optional | Type | Definition | |||
---|---|---|---|---|---|---|
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 | Required | Array of strings | List of component IDs. If empty, all components are accepted. | |||
sourceIDs | Required | 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 | Required | String | Event severity. This can be one of the following values.
| |||
type | Required | String | Event type. This can be one of the following values.
| |||
eventFilterDescription | Required | String | Event filter description | |||
eventFilterName | Required | 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 |
The following example creates an event filter for a specific subscription.
{
"eventFilterName": "example2",
"eventFilterDescription": "Description",
"eventFilter": {
"filter": {
"componentIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"500C0FF286F98000"],
"sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"500C0FF286F98000"],
"typeSeverity": [{
"severity": "fatal",
"type": "all"
},
...,
{
"severity": "informational",
"type": "audit"
}],
"categories": ["WARRANTY",
"GENERAL"]
}
},
"matchEverySystem": false,
"matchEveryCoreEvent": false
}
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