Events & Alarms
Query, acknowledge, and manage events and alarms. Configure event detectors on data points.
See also: Events & Alarms documentation | Full API Reference for interactive testing and complete schemas.
Endpoints
| Method | Path | Description | Reference |
|---|---|---|---|
| GET | /event-detectors | Gets a list of event detectors for bulk import via CSV | API Reference → |
| POST | /event-detectors | Create an Event Detector | API Reference → |
| DELETE | /event-detectors/{xid} | Delete an Event Detector | API Reference → |
| GET | /event-detectors/{xid} | Get an Event Detector by xid | API Reference → |
| PATCH | /event-detectors/{xid} | Partially update an Event Detector | API Reference → |
| PUT | /event-detectors/{xid} | Update an Event Detector | API Reference → |
| GET | /event-detectors/bulk | Get a list of current bulk event detector operations | API Reference → |
| POST | /event-detectors/bulk | Bulk get/create/update/delete event detectors | API Reference → |
| DELETE | /event-detectors/bulk/{id} | Remove a bulk event detector operation using its id | API Reference → |
| GET | /event-detectors/bulk/{id} | Get the status of a bulk event detector operation using its id | API Reference → |
| PUT | /event-detectors/bulk/{id} | Update a bulk event detector operation using its id | API Reference → |
| GET | /event-detectors/by-id/{id} | Get an Event Detector by id | API Reference → |
| GET | /event-detectors/export | Export formatted for Configuration Import by supplying an RQL query | API Reference → |
| POST | /event-detectors/query | Gets a list of event detectors for bulk import via CSV | API Reference → |
| GET | /event-detectors/query-data-point-rql | Gets a list of event detectors for bulk import via CSV using RQL against data points | API Reference → |
| GET | /event-detectors/runtime/{xid} | Get Event Detector's internal state | API Reference → |
| GET | /event-types | Query all available event types | API Reference → |
| GET | /event-types/{type} | Query event types from one eventType to get all subtypes for an event type | API Reference → |
| GET | /event-types/{type}/{subtype} | Query event types from one eventType | API Reference → |
| GET | /event-types/{type}/{subtype}/{referenceId1} | Query event types from one eventType | API Reference → |
| POST | /event-types/query-data-point-event-types | Query event types for data points | API Reference → |
| GET | /events | Query Events | API Reference → |
| GET | /events/{id} | Get event by ID | API Reference → |
| POST | /events/acknowledge | Acknowledge many existing events | API Reference → |
| PUT | /events/acknowledge/{id} | Acknowledge an existing event | API Reference → |
| GET | /events/active | Get the active events for a user | API Reference → |
| GET | /events/active-summary | Get the active events summary | API Reference → |
| POST | /events/counts | Query for event counts using RQL | API Reference → |
| POST | /events/data-point-event-counts | Query for event counts using RQL | API Reference → |
| POST | /events/data-point-summaries | Get summary of data point events | API Reference → |
| POST | /events/query/events-by-source-type | Find Events for a set of sources found by the supplied sourceType RQL query, then query for events with these sources using eventsRql | API Reference → |
| GET | /events/reduced | Query Events Reduced Format | API Reference → |
| GET | /events/unacknowledged-summary | Get the unacknowledged events summary | API Reference → |
| GET | /user-events | Query User Events | API Reference → |