Events and alerts
The following resources are available for performing monitoring and event functions, such as getting events, getting event status, and setting up event monitors.
Note
When retrieving events from Lenovo XClarity Administrator, use the sequence numbers to verify that no events are missing. If the sequence number of an event is not sequential with that last event that you retrieved for the target device, perform another GET /events to request the events that are associated with all the sequence numbers that you missed.
- /bulletinService
Use this REST API to return a list of bulletins from the last 30 days or modify bulletins options. - Filtering events
You can use the parameter filterWith to return a subset of all active events based on Java REGEX expressions or based on comparison operators. - /events
Use this REST API to retrieve information about events, and delete all events in the events log. - /events?translations={JSON_filter}
Use this REST API to retrieve translated events based on the criteria that is specified using encoded JSON format. - /events/actions
Use this REST API to retrieve information about all event action or to post an event action entry to the registry for filtering on incoming events. Event actions are actions or functions that are called based on an incoming event. - /events/actions/{action_name}
Use this REST API to retrieve information about or delete a specific event action. Event actions are actions or functions that are performed based on an incoming event. - /events/acknowledgeAlerts
Use this REST API to retrieve a list of active alerts that were acknowledged, to acknowledge an active alert, or to remove the acknowledge status for an active alert. - /events/activeAlerts
Use this REST API to retrieve information about active alerts or the number of active alerts per resource group. Alerts are hardware or management conditions that need investigation and user action. - /events/activeAlerts/{uuid}
Use this REST API to retrieve information about active alerts that are associated with a specific managed device. Alerts are hardware or management conditions that need investigation and user action. - /events/activeAlerts/helptext/{alert_id}
Use this REST API to retrieve the description and recovery action for a specific alert. - /events/activeAlerts/status
Use this REST API to retrieve the alert status, as defined by highest severity of active alerts, for all managed devices. Alerts are hardware or management conditions that need investigation and user action. - /events/activeAlerts/status/{uuid}
Use this REST API to retrieve the alert status, as defined by highest severity of active alerts, for a specific managed device. Alerts are hardware or management conditions that need investigation and user action. - /events/activeAlerts/summary
Use this REST API to retrieve a summary of all active alerts. - /events/activeAlerts/summary/{uuid}
Use this REST API to retrieve a summary of all active alerts that are associated with a specific managed device. - /events/audit
Use this REST API to retrieve events in the Lenovo XClarity Administrator audit log. - /events/config
Use this REST API to retrieve information about configuration settings for the Lenovo XClarity Administrator event log, modify the event configuration settings, and clear the event and audit logs. - /events/csv/auditLog
Use this REST API to retrieve the Lenovo XClarity Administrator audit log in a .CSV format. - /events/csv/eventLog
Use this REST API to return the Lenovo XClarity Administrator event log in a .CSV format. - /events/csv/eventsLogs
Use this REST API to retrieve the Lenovo XClarity Administrator event log and audit log in a .CSV format. - /events/exclusionfilters
Use this REST API to retrieve information about, create, and modify event exclusion filters. Exclusion filters are used to exclude events or alerts on the Lenovo XClarity Administrator user interface and not have any actions taken on them when received, if those events are of no interest for managing remote systems. - /events/exclusionfilters/{filter_id}
Use this REST API to remove a specific exclusion filter. Exclusion filters are used to exclude events or alerts on the Lenovo XClarity Administrator user interface and not have any actions taken on them when received, if those events are of no interest for managing remote systems. - /events/helptext/{event_id}
Use this REST API to return the description and recovery action for a specific event. - /events/monitors
Use this REST API to retrieve information about, create, and modify event forwarders. - /events/monitors?format=currentFormat&id={monitor_id}
Use this REST API to retrieve the current format of the output for a specific event forwarder. - /events/monitors?format=currentSubjectFormat&id={monitor_id}
Use this REST API to retrieve the current format of the email subject for a specific event forwarder for an email service. - /events/monitors?format=defaultFormat
Use this REST API to retrieve the default output format for each type of event forwarder. - /events/monitors?format=defaultSubjectFormat
Use this REST API to retrieve the default format of the email subject for a specific event forwarder. - /events/monitors?format=formatKeys
Use this REST API to retrieve a description of the fields (format keys) in a forwarded event for each type of event forwarder. - /events/monitors/{monitor_id}
Use this REST API to modify or delete a specific event forwarder. - /events/monitors/certificate
Use this REST API to trust the certificate for a event forwarder. - /events/notifications
Use this REST API to retrieve configuration and subscription information for all push notification services or generate a test event that pushes to a specific push notification service or subscription. - /events/notifications/{pusher_type}
Use this REST API to retrieve information about a specific push notification service. - /events/notifications/{pusher_type}/subscriptions
Use this REST API to retrieve information about all subscriptions for a specific push notification service, modify a subscription that is used to forward events to mobile devices or WebSocket service, or delete all subscriptions for a specific push notification service. - /events/notifications/{pusher_type}/subscriptions/{subscription_ID}
Use this REST API to retrieve information about a specific subscription for a specific push notification service or delete a specific subscription. - /events/notifications/{pusher_type}/subscriptions/{subscription_id}/filters
Use this REST API to retrieve information about all event filters that are associated with a specific push notification service, to create an event filter for a specific subscription, or to delete all event filters for a specific subscription. - /events/notifications/{pusher_type}/subscriptions/{subscription_id}/filters/{filter_name}
Use this REST API to retrieve information about a specific event filter that is associated with a specific subscription or to delete one or more event filters from a specific subscription. - /events/notifications/subscriptions
Use this REST API to retrieve information about all subscriptions or delete all subscriptions for all push notification services. - /events/notifications/subscriptions/{subscription_id}
Use this REST API to retrieve information about or delete a specific subscription. - /events/notifications/subscriptions/{subscription_id}/filters
Use this REST API to retrieve information about all event filters that are associated with a specific subscription or to delete all event filters for a specific subscription. - /events/notifications/subscriptions/{subscription_id}/filters/{filter_name}
Use this REST API to retrieve information about a specific event filter that is associated with a specific subscription or to delete one or more event filters from a specific subscription. - /events/predefinedFilters
Use this REST API to retrieve, create, modify predefined event filters or to delete all predefined event filters. - /events/predefinedFilters/{filters_id}
Use this REST API to delete one or more predefined event filters. - /events/snmp/mib
Use this REST API to download the management information base (MIB) file, which describes the SNMP traps that Lenovo XClarity Administrator generates.
Give documentation feedback