List endpoints | emnify Documentation

curl -G https://cdn.emnify.net/api/v1/endpoint \
     -H "Authorization: Bearer <token>" \
     -d q= \
     -d sort=

[
  {
    "status": {
      "id": 1,
      "description": "Disabled"
    },
    "service_profile": {
      "id": 1,
      "name": "Smart Meter"
    },
    "tariff_profile": {
      "id": 3,
      "name": "Domestic only"
    },
    "id": 1,
    "name": "arduino01",
    "tags": "arduino, meter, temp",
    "created": "1970-01-01T00:00:00.000+0000",
    "last_updated": "1970-01-01T00:00:00.000+0000",
    "ip_address": "10.203.23.75",
    "ip_address_space": {
      "id": 2
    },
    "sim": {
      "id": 788,
      "iccid": "7368267364738977362",
      "msisdn": "88563748761",
      "imsi": "901991234567890",
      "status": {
        "id": 2,
        "description": "Suspended"
      }
    },
    "imei": "8643456788893212",
    "imei_lock": true
  },
  {
    "status": {
      "id": 1,
      "description": "Disabled"
    },
    "service_profile": {
      "id": 1,
      "name": "Smart Meter"
    },
    "tariff_profile": {
      "id": 3,
      "name": "Domestic only"
    },
    "id": 2,
    "name": "arduino02",
    "tags": "arduino, meter, temp",
    "created": "1970-01-01T00:00:00.000+0000",
    "last_updated": "1970-01-01T00:00:00.000+0000",
    "ip_address": "10.203.23.76",
    "ip_address_space": {
      "id": 2
    },
    "sim": {
      "id": 789,
      "iccid": "7368267364738297362",
      "eid": "89049011803455664400026832111175",
      "msisdn": "88563748762",
      "imsi": "901991234567891",
      "status": {
        "id": 2,
        "description": "Suspended"
      }
    },
    "imei": "8643456788978291",
    "imei_lock": false
  }
]

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 headers

Linkstring or null

Navigational links to retrieve the first, previous, next, and last page in a data set.

X-Count-Per-Pageinteger

Number of items to show per page as specified by the per_page parameter.

X-Current-Pageinteger

Current page number within the current data set.

X-Total-Countinteger

Total element count in the current data set.

X-Total-Pagesinteger

Total page count in the current data set.

X-Filterstring or null

Returns the relevant values if filtering is applied using a ?q=field:criteria query parameter.

X-Sortstring or null

Returns the sorted data set if sorting is applied using a ?sort=field query parameter.

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