endpoint

List endpoints

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

<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 all endpoints for your organization. Use the query parameters to filter, sort, and paginate results.

get/api/v1/endpoint

Request

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

Query parameters

qstring

Filters endpoints by field value. Use <field>:<criteria> format. Combine multiple filters with commas (for example, status:0,tags:sensor).

connectivity_status accepts only the value BLOCKED, which returns the endpoints that are currently denied service (for example, after exceeding a traffic limit). It takes a single value, so wildcards and || lists aren't supported.

sortstring

Sorts endpoints by field value. Use <operator><field> format. Combine multiple sort fields with commas (for example, -status,id).

Operators:

  • - descending (Z-A for text, highest number first)
  • + ascending (A-Z for text, lowest number first)

Defaults to ascending order if no operator is specified. Defaults to id if no sort field is specified. Endpoints with identical values are sorted by ascending id.

pageinteger

Page number to retrieve. Starts at 1.

per_pageinteger

Number of endpoints to return per page.

Response

Returns an array of endpoint objects. Pagination metadata is included in the response headers.

idinteger

Unique identifier for the endpoint.

createdstring date-time

Date and time when the endpoint was created (ISO 8601 format).

last_updatedstring date-time

Date and time when the endpoint was last modified (ISO 8601 format).

namestring

Display name for the endpoint.

tagsstring nullable

Comma-separated list of tags. Use tag_assignments for structured tag data.

ip_addressstring

Private IP address assigned to this endpoint within the IP address space.

imeistring nullable

International Mobile Equipment Identity with Software Version Number (IMEISV) (16 digits).

imei_lockboolean

If true, this endpoint only allows connections from the device with the specified IMEI.

imei_with_luhnstring nullable

International Mobile Equipment Identity with Luhn check digit, without Software Version Number (SVN) (15 digits).

Changes

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