For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Request featuresContact support
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
  • Authentication
    • POSTRetrieve authentication token
    • POSTCreate an MFA key
    • PATCHActivate MFA key
    • DELDelete an MFA key
    • GETList MFA key statuses
    • GETList MFA key types
    • GETList trusted devices
    • DELDelete a trusted device
  • Password Management and Activation
    • POSTInvite a user
    • POSTActivate user
    • POSTResend user activation email
    • PATCHChange password
  • Endpoint
    • GETList endpoints
    • POSTCreate an endpoint
    • POSTBulk create endpoints
    • DELBulk delete endpoints
    • PATCHBulk update endpoints
    • GETList endpoint statuses
    • GETEndpoint details
    • DELDelete an endpoint
    • PATCHUpdate an endpoint
    • GETEndpoint connectivity status
    • PATCHReset endpoint connectivity
    • GETList endpoint events
    • GETEndpoint usage and cost statistics
    • GETRetrieve daily usage statistics for an endpoint
    • GETList sent and received SMS
    • POSTSend SMS to an endpoint
    • GETSMS details
    • DELCancel SMS
    • GETRetrieve connectivity information for an endpoint
    • GETList active traffic limit extensions
    • POSTCreate traffic limit extension
    • DELDelete all traffic limit extensions for an endpoint
    • GETList operator blacklist for endpoint
    • PUTAdd an operator to the blacklist
    • DELRemove an operator from the blacklist
    • GETRetrieve data quota details
    • POSTSet data quota
    • DELRemove data quota
    • GETShow SMS quota details
    • POSTSet SMS quota
    • DELRemove SMS quota
  • Organization
    • GETOrganization usage and costs statistics per day for the current month
    • GETMy organization details
    • GETList organization statuses
    • GETMonthly organization traffic and cost statistics
    • GETDaily organization traffic and cost statistics
    • GETHourly organization traffic statistics
    • PATCHUpdate assigned tariff
    • PUTAssign a ratezone inclusive volume to an organization
    • GETGet list of active organization inclusive volumes
  • Sim
    • GETList SIMs
    • GETList SIM statuses
    • GETSIM details
    • DELDelete a SIM
    • PATCHUpdate a SIM
    • GETSIM usage and cost statistics
    • GETDaily SIM usage statistics
    • GETList SIM events
    • GETValidate SIM batch by BIC
    • PATCHRegister a given batch by BIC
    • DELBulk delete SIMs
    • POSTMigrate SIMs between Workspaces
  • Events
    • GETList events
    • GETList event types
  • Lookups
    • GETList country codes
    • GETList currencies
    • GETList data blocksizes
    • GETList data throttles
    • GETList breakout regions
    • GETList ESME interface types
    • GETList RAT types
    • GETGet list of service levels
  • Operator
    • GETList operators
  • Application Tokens
    • GETList application tokens
    • POSTCreate application token
    • PATCHUpdate application token
  • Tariff Profiles
    • GETList tariff profiles
    • POSTCreate tariff profile
    • GETTariff profile details
    • DELDelete tariff profile
    • PATCHUpdate tariff profile
    • PUTAssign ratezone to tarriff profile
    • DELDelete ratezone from tariff profile
    • GETGet the operator blocklist for a specific tariff profile
    • GETGet operator blocklist for a specific tariff profile
    • PUTBlock the operator completely for a given tariff profile
    • DELRemove an operator from the blocklist
    • POSTBlock specific RAT types
    • DELUnblock a specific RAT type
    • GETList tariff profile coverage
    • PUTAssign inclusive volume to tarriff profile
    • DELUnassign inclusive volume from tariff profile
  • Service Profiles
    • GETList service profiles
    • POSTCreate service profile
    • GETRetrieve a service profile
    • DELDelete a service profile
    • PATCHUpdate service profile
    • DELRemove all quotas of assigned endpoints
    • PUTAdd a service to a service profile
    • DELRemove a service from a service profile
    • PUTAdd SMS limit to service profile
    • DELRemove SMS limit from a service profile
    • GETList data limits of service profile
    • POSTAdd data limit to service profile
    • DELDelete all data limits of a service profile
    • DELRemove data limit from a service profile
  • Service Lookups and Configuration
    • GETList services
    • GETGet service SMS limit
    • GETList traffic limits
    • GETList DNS configs
    • POSTCreate DNS config
    • DELDelete DNS config
  • User Management
    • GETList user accounts
    • POSTCreate user
    • GETList user statuses
    • GETList user roles
    • GETGet user by ID or username
    • DELDelete user by ID
    • PATCHUpdate user by ID
    • GETList user events
    • GETList user role permissions
    • PUTAssign role to user
    • DELDelete user role
    • DELDelete user by ID
    • POSTCreate support access token for given user
  • IP Address Spaces
    • GETList IP address spaces
    • POSTCreate an IP address space
    • GETGet random address spaces
    • PUTAssign an IP address space to an organization
    • DELRelease an IP address space from an organization
  • Integrations
    • GETList data stream configurations of your organization
    • POSTCreate data stream
    • GETGet data stream statuses
    • GETGet data stream types
    • GETGet data stream filter fields
    • GETGet details on existing data stream
    • DELDelete existing data stream
    • PATCHModify existing data stream
    • POSTRestart existing data stream
    • GETRetrieve list of API callback URLs
    • POSTCreate a callback URL
    • GETGet a callback URL by ID
    • DELDelete a callback URL
    • GETList API callback secrets
    • POSTCreate a callback secret
    • GETGet a callback secret by ID
    • DELDelete a callback secret
  • Cloud Connect
    • GETList all Cloud Connect attachments of an organization
    • GETList Cloud Connect breakout types
    • GETView details of a Cloud Connect attachment
    • DELDelete a specific Cloud Connect attachment
    • PATCHRetry creation of an expired TGW breakout
    • POSTCreate a Cloud Connect attachment via Transit Gateway
    • POSTCreate a Cloud Connect attachment via IPSec VPN
    • GETList Cloud Connect prices
    • GETGet list of available Cloud Connect regions by breakout type
  • Tariff Plans
    • GETList organization tariff plans
    • GETRetrieve your organization's active tariff plan
    • GETGet the active tariff plan for the given organization
  • Workspaces
    • POSTSwitch to an assigned Workspace
    • POSTAccept user invitation
    • PUTAssign a role to a Workspace user
    • DELRemove a role from a Workspace user
    • PUTUpdate a user's default Workspace
    • GETList assigned Workspaces
    • DELUnassign a Workspace
    • PATCHUpdate user status in a Workspace
    • GETRetrieve Workspace daily stats
  • Tag Management
    • GETReturns the list of available tag colors
    • GETList tags
    • POSTCreate a tag
    • DELDelete a tag
    • PATCHUpdate a tag
    • GETList endpoint tags
    • POSTAssign a tag to an endpoint
    • DELUnassign a tag from an endpoint
    • POSTBulk assign tags
    • POSTBulk unassign tags
    • POSTBulk delete tags
  • Automations
    • GETList action logs
    • GETList available actions
    • GETGet an action by ID
    • GETList configured automations
    • POSTCreate an automation
    • GETGet configured automation by ID
    • DELDelete a configured automation
    • PATCHUpdate an automation
    • POSTVerify an automation recipient's email address
  • System Events
    • GETList system events
    • GETGet a system event by ID
  • Custom Events
    • GETList custom event templates
    • GETGet a custom event template by ID
    • GETList custom events
    • POSTDeploy custom event
    • GETGet a custom event by ID
    • DELDelete custom event
  • euicc
    • GETList eUICCs
    • GETList eUICC status
    • GETList eUICC Profile status
    • GETGet eUICC
    • POSTUnlinked eUICC validation
  • Euicc Operation
    • GETList operation action for eUICC
    • GETList operation status for eUICC
    • GETList operation for eUICC
    • POSTSchedule eUICC operations
    • GETGet operation details
    • DELCancel operation
  • Sim Unlinked Product Statistics
    • GETGet product statistics on unlinked eSIMs
  • Sim Operation
    • GETList SIM operation actions
    • GETList SIM operation status
    • GETList SIM operations for organization
    • POSTTrigger SIM operation
    • GETGet SIM operation details
LogoLogo
Request featuresContact support
Sim

List SIM events

GET
https://cdn.emnify.net/api/v1/sim/:sim_id/event
GET
/api/v1/sim/:sim_id/event
$curl -G https://cdn.emnify.net/api/v1/sim/1/event \
> -H "Authorization: Bearer <token>" \
> -d sort= \
> -d q=
1[
2 {
3 "timestamp": "2019-07-16T12: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": 6
29 },
30 "sim": {
31 "iccid": "8988317000000000100",
32 "iccid_with_luhn": "89883170000000001001",
33 "production_date": "2018-12-17T13:26:13.000Z",
34 "id": 2
35 },
36 "imsi": {
37 "imsi": 901430000000114,
38 "import_date": "2018-12-17T13:26:08.000Z",
39 "id": 110
40 }
41 }
42]
Returns the list of events, filtered, sorted and paged according to query parameters. <Error> This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/sim/{sim_id}`). In case the requested `{sim_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{sim_id}` is a number and all parameters are valid. Please take that into consideration when building automation on top of the error behavior of this endpoint. </Error>
Was this page helpful?
Previous

Daily SIM usage statistics

Next

Validate SIM batch by BIC

Built with

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

This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (/api/v1/sim/{sim_id}).

In case the requested {sim_id} doesn’t exist or is not accessible for the user, HTTP 200 will be returned with empty [] as long as the provided {sim_id} is a number and all parameters are valid.

Please take that into consideration when building automation on top of the error behavior 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

sim_idintegerRequired
Numeric ID of a SIM

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**)
qstringOptionalformat: "(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: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 SIM events
timestampstring
alertboolean
descriptionstring
idinteger
event_typeobject
event_sourceobject
event_severityobject
organisationobject
endpointobject
simobject
imsiobject

Errors

400
Bad Request Error
422
Unprocessable Entity Error

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)

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