All URIs are relative to https://cdn.emnify.net
Method | HTTP request | Description |
---|---|---|
event_type_get | GET /api/v1/event/type | List Event Types |
get_events | GET /api/v1/event | List Events |
Veccrate::models::RetrieveEventTypesresponse event_type_get() List Event Types
Provides the list of event_types (lookup).
This endpoint does not need any parameter.
Veccrate::models::RetrieveEventTypesresponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Veccrate::models::Event get_events(page, per_page, sort, q) List Events
Returns the list of events, filtered, sorted and paged according to query parameters.
Name | Type | Description | Required | Notes |
---|---|---|---|---|
page | Option<i32> | Current page number | ||
per_page | Option<i32> | Paging parameters defining the number of items per page | ||
sort | Option<String> | Sort properties according to a comma separated list of accepted fields. Valid fields are: * id - (event id) * timestamp - (event timestamp) * source - (event source) * severity - (event severity) * alert - (alert status) * organisation - (organisation name) * user - (user id) * endpoint - (endpoint name) * tags - (endpoint tags) * ip_address - (endpoint ip_address) * iccid - (sim iccid) * imsi - (sim imsi) * type - (event type) |
||
q | Option<String> | Filter parameter in <filter>:<value> format. Multiple filters must be in the format of a comma separated list of the following fields: * type (event_type, numerical) * source (event_type, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API) * severity (event_severity, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical) * alert (boolean, e.g. true, false) * description (event description, string) * organisation (organisation name, string) * user (user name, string) * endpoint (endpoint name, string) * tags (endpoint tags, string) * ip_address (endpoint IP address, valid IPv4/IPv6 address) * imei (endpoint imei, numerical string) * iccid (sim iccid, numerical string) * imsi (sim imsi, numerical string) * from (date, format YYYY-MM-DDTHH:mm:ssZ , only valid with until!) * until (date, format YYYY-MM-DDTHH:mm:ssZ , only valid with from!) * timestamp (date, format YYYY-MM-DDTHH:mm:ssZ , for querying events of 1 day, deprecated in future) |
Veccrate::models::Event
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]