endpoint

Endpoint connectivity status

<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.Connectivity + Get <span className="permission-callout__also">+1 endpoint</span>

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

Retrieve details about current connectivity status of endpoint. The following is a list of possible statuses:

  • ATTACHED: The Endpoint has succesfully attached to the Home Core network in the past. The device will be shown as ATTACHED until the visited network has signaled that the device is inactive/offline. Usually the visited network informs the Core Network within 1-2 days after a device went offline.

  • ONLINE: The Endpoint has an active data connection

  • OFFLINE: The Endpoint has not attached to the core network yet or the device was previously attached but the visited network signaled that the device had no activity for the last 1-2 days. Note: The device is not reachable for external services (e.g. SMS, MSRN lookup).

  • BLOCKED: The device is not granted service. Endpoints are assigned this status when they have exceeded traffic limits.

get/api/v1/endpoint/{endpoint_id}/connectivity

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}/connectivity
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

Response

Success

statusApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaStatus
locationApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaLocation
pdp_contextApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaPdpContext
servicesstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.