endpoint

Create an endpoint

<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 + Create <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></div> </Info>

Creates a single endpoint with the specified configuration.

<Note> For bulk operations, use [`POST /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-create-endpoint) instead (supports up to 2,000 endpoints per request). </Note> <Warning> emnify charges for activated SIMs, even if the endpoint status is set to **Disabled**. </Warning>
post/api/v1/endpoint

Request

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

Request body

namestring

Display name for the endpoint.

tagsstring

Comma-separated list of tags (for example, sensor,outdoor). Tags that do not exist yet are created.

<Warning> Deprecated. Use `tag_assignments` instead. </Warning>
tag_assignmentsinteger[]

IDs of existing tags to assign to the endpoint. Unlike tags, tags are not created automatically, so every ID must already exist.

<Info> Mutually exclusive with `tags`. Provide at most one of the two. </Info>
imeistring

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.

ip_addressstring

Private IP address to assign.

<Info> If provided, you must also specify `ip_address_space`. </Info>

Response

Endpoint created successfully.

idinteger required

Unique identifier for the endpoint.

ip_addressstring required

Private IP address assigned to this endpoint.

namestring required

Display name for the endpoint.

tagsstring required

Comma-separated list of tags. Empty when the endpoint has no tags assigned.

<Warning> Deprecated. Use `tag_assignments` instead. </Warning>
imeistring

IMEI with Software Version Number (IMEISV) (16 digits). Omitted when the device hasn't reported an IMEI.

createdstring date-time required

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

last_updatedstring date-time required

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

imei_lockboolean required

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

imei_with_luhnstring

IMEI with Luhn checksum digit, without Software Version Number (15 digits). Omitted when the device hasn't reported an IMEI.

Changes

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