List endpoint events

GET

https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/event

GET

/api/v1/endpoint/:endpoint_id/event

$ curl https://cdn.emnify.net/api/v1/endpoint/12345/event \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "timestamp": "2020-07-20T12:07:09.000Z",
4     "alert": true,
5     "description": "PDP Context deleted.",
6     "id": 69535,
7     "event_type": {
8       "description": "Delete PDP Context",
9       "id": 4
10     },
11     "event_source": {
12       "name": "Network",
13       "id": 0
14     },
15     "event_severity": {
16       "description": "INFO",
17       "id": 0
18     },
19     "organisation": {
20       "name": "Organisation_Name",
21       "id": 2
22     },
23     "endpoint": {
24       "name": "Monitoring201",
25       "tags": "Monitoring",
26       "ip_address": "10.199.6.39",
27       "imei": null,
28       "id": 1
29     },
30     "sim": {
31       "iccid": "8988317000000000000",
32       "iccid_with_luhn": "89883170000000000001",
33       "production_date": "2019-12-17T13:26:13.000Z",
34       "id": 110
35     },
36     "imsi": {
37       "imsi": "901430000000114",
38       "import_date": "2019-12-17T13:26:08.000Z",
39       "id": 110
40     }
41   }
42 ]

Returns the list of events, filtered, sorted and paged according to query parameters. <Info> A full list of events is found in section "Retrieve Event Types" (`/api/v1/event/type`). </Info> <Error> This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/endpoint/{endpoint_id}`). In case the requested `{endpoint_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{endpoint_id}` is a number and all parameters are valid. Please take that into consideration when building automation on top of the error behaviour of this endpoint. </Error>

curl https://cdn.emnify.net/api/v1/endpoint/12345/event \
     -H "Authorization: Bearer <token>"

[
  {
    "timestamp": "2020-07-20T12:07:09.000Z",
    "alert": true,
    "description": "PDP Context deleted.",
    "id": 69535,
    "event_type": {
      "description": "Delete PDP Context",
      "id": 4
    },
    "event_source": {
      "name": "Network",
      "id": 0
    },
    "event_severity": {
      "description": "INFO",
      "id": 0
    },
    "organisation": {
      "name": "Organisation_Name",
      "id": 2
    },
    "endpoint": {
      "name": "Monitoring201",
      "tags": "Monitoring",
      "ip_address": "10.199.6.39",
      "imei": null,
      "id": 1
    },
    "sim": {
      "iccid": "8988317000000000000",
      "iccid_with_luhn": "89883170000000000001",
      "production_date": "2019-12-17T13:26:13.000Z",
      "id": 110
    },
    "imsi": {
      "imsi": "901430000000114",
      "import_date": "2019-12-17T13:26:08.000Z",
      "id": 110
    }
  }
]

Returns the list of events, filtered, sorted and paged according to query parameters.

A full list of events is found in section “Retrieve Event Types” (/api/v1/event/type).

This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (/api/v1/endpoint/{endpoint_id}). In case the requested {endpoint_id} doesn’t exist or is not accessible for the user, HTTP 200 will be returned with empty [] as long as the provided {endpoint_id} is a number and all parameters are valid.

Please take that into consideration when building automation on top of the error behaviour of this endpoint.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

endpoint_idintegerRequired

Numeric ID of an endpoint

Query parameters

pageintegerOptional

Current page number

per_pageintegerOptional

Defines the number of items per page

sortstringOptional

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**)

qstringOptional

format: "(from|until|type|source|severity|alert|description|organisation|user|endpoint|tags|ip_address|imei|iccid|iccid_with_luhn|imsi|timestamp|network|rat|country):.+"

Filter parameter in `<filter>:<value>` format. Multiple filters must be a comma-separated list of the following fields: * `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**) * `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**) * `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) * `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future) * `iccid_with_luhn` (**sim iccid with Luhn**, numerical string) * `network` (**endpoint network**, string, e.g. Telekom) * `rat` (**event pdp context rat type**, numerical string, e.g. 6) * `country` (**endpoint country**, string, e.g. Germany) Some filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`): * `iccid` (q: iccid:1234567890123456789|8988303000123456789) * `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891) * `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name) * `type` (q: type:example_event_type|another_event_type) * `network` (q: network:example_network|another_network) * `rat` (q: rat:example_rat|another_rat) * `country` (q: country:example_country|another_country)

Response headers

x-count-per-pageinteger

The requested per_page parameter

x-current-pageinteger

The current page number within the current data set

x-total-countinteger

The total element count in the current data set

x-total-pagesinteger

The total page count in the current data set

x-filterstring

If filtering is applied using ?q=field:criteria URL query parameters, the filter criteria is returned here

x-sortstring

If sorting is applied using ?sort=sort_criteria URL query parameters, the sort criteria is returned here

Response

Successfully returned a list of events

timestampstring

alertboolean

descriptionstring

idinteger

event_typeobject

event_sourceobject

event_severityobject

organisationobject

endpointobject

simobject

imsiobject

Errors

400

Bad Request Error

422

Unprocessable Entity Error

$	curl https://cdn.emnify.net/api/v1/endpoint/12345/event \
>	-H "Authorization: Bearer <token>"

1	[
2	{
3	"timestamp": "2020-07-20T12:07:09.000Z",
4	"alert": true,
5	"description": "PDP Context deleted.",
6	"id": 69535,
7	"event_type": {
8	"description": "Delete PDP Context",
9	"id": 4
10	},
11	"event_source": {
12	"name": "Network",
13	"id": 0
14	},
15	"event_severity": {
16	"description": "INFO",
17	"id": 0
18	},
19	"organisation": {
20	"name": "Organisation_Name",
21	"id": 2
22	},
23	"endpoint": {
24	"name": "Monitoring201",
25	"tags": "Monitoring",
26	"ip_address": "10.199.6.39",
27	"imei": null,
28	"id": 1
29	},
30	"sim": {
31	"iccid": "8988317000000000000",
32	"iccid_with_luhn": "89883170000000000001",
33	"production_date": "2019-12-17T13:26:13.000Z",
34	"id": 110
35	},
36	"imsi": {
37	"imsi": "901430000000114",
38	"import_date": "2019-12-17T13:26:08.000Z",
39	"id": 110
40	}
41	}
42	]