Endpoint details

GET

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

GET

/api/v1/endpoint/:endpoint_id

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

{
  "status": {
    "id": 0,
    "description": "Enabled"
  },
  "service_profile": {
    "id": 1,
    "name": "Smart Meter"
  },
  "tariff_profile": {
    "id": 3,
    "name": "Domestic only"
  },
  "id": 1,
  "name": "arduino01",
  "tag_assignments": [
    {
      "id": 1,
      "name": "arduino",
      "tag_color": {
        "id": 3
      }
    },
    {
      "id": 2,
      "name": "meter",
      "tag_color": {
        "id": 5
      }
    },
    {
      "id": 3,
      "name": "temp",
      "tag_color": {
        "id": 7
      }
    }
  ],
  "created": "2019-08-01T15:48:34.000+0000",
  "last_updated": "2020-11-23T15:14:27.000+0000",
  "ip_address": "10.203.23.75",
  "ip_address_space": {
    "id": 2,
    "ip_address_space": "10.203.23.0/24",
    "ip_address_version": 4
  },
  "sim": {
    "id": 788,
    "iccid": "7368267364738297362",
    "eid": "89049011803455664400046832584675",
    "msisdn": "88563748761",
    "imsi": "901991234567890",
    "status": {
      "id": 1,
      "description": "Activated"
    },
    "iccid_with_luhn": "73682673647382973621"
  },
  "imei": "8643456788893212",
  "imei_lock": false,
  "runtime_data": {
    "msc": "491790802121",
    "sgsn": "491752345678",
    "sgsn_ip_address": "82.113.96.21"
  },
  "tags": "arduino, meter, temp",
  "imei_with_luhn": "864345678889324"
}

Endpoint + Get

Roles: Administrator User Observer

Retrieves endpoint details for a given ID.

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Endpoint` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Retrieves endpoint details for a given ID.

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

Response

Successfully returned the endpoint details associated with the provided id.

statusobject

service_profileobject

tariff_profileobject

idintegerOptional

namestringOptional

tag_assignmentslist of objectsOptional

Structured tag data with color information.

createdstringOptionalformat: "date-time"

last_updatedstringOptionalformat: "date-time"

ip_addressstringOptional

ip_address_spaceobjectOptional

simobjectOptional

imeistringOptional

imei_lockbooleanOptional

runtime_dataobjectOptional

tagsstring or nullOptionalDeprecated

Comma-separated list of tags.

Deprecated. Use tag_assignments instead.

Errors

403

Forbidden Error