List endpoints | emnify Documentation

1 import requests 2 3 url = "https://cdn.emnify.net/api/v1/endpoint" 4 5 querystring = {"q":"","sort":""} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 [ 2 { 3 "status": { 4 "id": 1, 5 "description": "Disabled" 6 }, 7 "service_profile": { 8 "id": 1, 9 "name": "Smart Meter" 10 }, 11 "tariff_profile": { 12 "id": 3, 13 "name": "Domestic only" 14 }, 15 "id": 1, 16 "name": "arduino01", 17 "tags": "arduino, meter, temp", 18 "created": "1970-01-01T00:00:00.000+0000", 19 "last_updated": "1970-01-01T00:00:00.000+0000", 20 "ip_address": "10.203.23.75", 21 "ip_address_space": { 22 "id": 2 23 }, 24 "sim": { 25 "id": 788, 26 "iccid": "7368267364738977362", 27 "msisdn": "88563748761", 28 "imsi": "901991234567890", 29 "status": { 30 "id": 2, 31 "description": "Suspended" 32 }, 33 "iccid_with_luhn": "73682673647389773621" 34 }, 35 "imei": "8643456788893212", 36 "imei_lock": true, 37 "imei_with_luhn": "864345678889324" 38 }, 39 { 40 "status": { 41 "id": 1, 42 "description": "Disabled" 43 }, 44 "service_profile": { 45 "id": 1, 46 "name": "Smart Meter" 47 }, 48 "tariff_profile": { 49 "id": 3, 50 "name": "Domestic only" 51 }, 52 "id": 2, 53 "name": "arduino02", 54 "tags": "arduino, meter, temp", 55 "created": "1970-01-01T00:00:00.000+0000", 56 "last_updated": "1970-01-01T00:00:00.000+0000", 57 "ip_address": "10.203.23.76", 58 "ip_address_space": { 59 "id": 2 60 }, 61 "sim": { 62 "id": 789, 63 "iccid": "7368267364738297362", 64 "eid": "89049011803455664400026832111175", 65 "msisdn": "88563748762", 66 "imsi": "901991234567891", 67 "status": { 68 "id": 2, 69 "description": "Suspended" 70 }, 71 "iccid_with_luhn": "73682673647382973622" 72 }, 73 "imei": "8643456788978291", 74 "imei_lock": false, 75 "imei_with_luhn": "864345678897822" 76 } 77 ]

Returns a list of endpoints filtered, sorted, and paged according to query parameters.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Query parameters

qstringOptional

format: "(status|service_profile|tariff_profile|id|name|created|last_updated|tags|ip_address|imei|iccid|iccid_with_luhn|eid|sim_status):.+"

Filter parameter in <field>:<criteria> format. Expects a comma-separated list from the allowed fields:

status
service_profile
tariff_profile
id
name
created
last_updated
tags
ip_address
imei
imei_with_luhn
iccid
iccid_with_luhn
eid
sim_status

Filter parameter in `<field>:<criteria>` format. Expects a comma-separated list from the allowed fields: * `status` * `service_profile` * `tariff_profile` * `id` * `name` * `created` * `last_updated` * `tags` * `ip_address` * `imei` * `imei_with_luhn` * `iccid` * `iccid_with_luhn` * `eid` * `sim_status`

Sort parameter in <operator><field> format. Sort properties according to a comma-separated list from the following fields:

id
name
status
last_updated
created
tags
ip_address
imei
eid
service_profile
tariff_profile

If no sorting options are specified, the response will be sorted by id.

Supported operators:

-: Descending order
+: Ascending order

The response will be shown in ascending order if no operator is specified.

Sort parameter in `<operator><field>` format. Sort properties according to a comma-separated list from the following fields: * `id` * `name` * `status` * `last_updated` * `created` * `tags` * `ip_address` * `imei` * `eid` * `service_profile` * `tariff_profile` If no sorting options are specified, the response will be sorted by `id`. Supported operators: * `-`: Descending order * `+`: Ascending order The response will be shown in ascending order if no operator is specified.

pageintegerOptional

Current page number

per_pageintegerOptional1-1000Defaults to 1000

Defines the number of items per page (max. 1000)

Response

Successfully returned a list of endpoints.

statusobject

service_profileobject

tariff_profileobject

idinteger or null

namestring or null

tagsstring or null

createdstring or nullformat: "date-time"

last_updatedstring or nullformat: "date-time"

ip_addressstring or null

ip_address_spaceobject or null

simobject or null

imeistring or null

imei_lockboolean or null

runtime_dataobject or null