Create an endpoint

POST

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

POST

/api/v1/endpoint

$ curl -X POST https://cdn.emnify.net/api/v1/endpoint \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "service_profile": {
>     "id": 123
>   },
>   "tariff_profile": {
>     "id": 123
>   },
>   "status": {
>     "id": 0
>   },
>   "name": "test",
>   "tag_assignments": [
>     1,
>     2
>   ],
>   "imei": "123456789012345",
>   "imei_lock": false,
>   "sim": {
>     "id": 3595575,
>     "activate": true
>   },
>   "ip_address": "127.0.0.1",
>   "organisation": {
>     "id": 123
>   },
>   "ip_address_space": {
>     "id": 123
>   }
> }'

1 {
2   "id": 1001,
3   "ip_address": "10.0.0.1",
4   "status": {
5     "id": 1,
6     "description": "Disabled"
7   },
8   "name": "Weather Station 01",
9   "imei": null,
10   "created": "2024-01-15T14:44:27.622+0000",
11   "last_updated": "2024-01-15T14:44:27.622+0000",
12   "imei_lock": false,
13   "service_profile": {
14     "id": 200,
15     "name": "Standard IoT"
16   },
17   "tariff_profile": {
18     "id": 100,
19     "name": "Global IoT Plan",
20     "satellite_capable": false
21   },
22   "sim": {
23     "id": 500,
24     "iccid": "8988303000001234567",
25     "iccid_with_luhn": "89883030000012345671",
26     "sim_profile_type_id": 1,
27     "imsi": "901430001234567",
28     "msisdn": "882850001234567",
29     "status": {
30       "id": 2,
31       "description": "Suspended"
32     }
33   },
34   "ip_address_space": {
35     "id": 1
36   },
37   "imei_with_luhn": null,
38   "tags": "sensor,outdoor",
39   "tag_assignments": [
40     {
41       "id": 1,
42       "name": "sensor",
43       "tag_color": {
44         "id": 3
45       }
46     },
47     {
48       "id": 2,
49       "name": "outdoor",
50       "tag_color": {
51         "id": 5
52       }
53     }
54   ]
55 }

Endpoint + Create

Roles: Administrator User

Creates a single endpoint with the specified configuration.

For bulk operations, use POST /api/v2/endpoint/multi instead (supports up to 2,000 endpoints per request).

emnify charges for activated SIMs, even if the endpoint status is set to Disabled.

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

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.

service_profileobjectRequired

Service profile that determines network access settings. Must belong to your organization.

tariff_profileobjectRequired

Tariff profile that determines pricing and data limits. Must belong to your organization.

statusobjectRequired

Initial endpoint status.

namestringOptional

Display name for the endpoint.

tag_assignmentslist of integersOptional

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

Mutually exclusive with tags. Provide at most one of the two.

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>

imeistringOptional

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

imei_lockbooleanOptionalDefaults to false

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

simobjectOptional

SIM card to assign to this endpoint. If omitted, no SIM is assigned.

ip_addressstringOptional

Private IP address to assign.

If provided, you must also specify ip_address_space.

Private IP address to assign. <Info> If provided, you must also specify `ip_address_space`. </Info>

organisationobjectOptional

Organization to create the endpoint in. Required only for reseller accounts creating endpoints in sub-organizations.

ip_address_spaceobjectOptional

IP address space for the endpoint.

Required if ip_address is provided.

IP address space for the endpoint. <Info> Required if `ip_address` is provided. </Info>

tagsstringOptionalDeprecated

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

Deprecated. Use tag_assignments instead.

Comma-separated list of tags (for example, `sensor,outdoor`). Tags that do not exist yet are created. <Warning> Deprecated. Use `tag_assignments` instead. </Warning>

Response

Endpoint created successfully.

idinteger

Unique identifier for the endpoint.

ip_addressstring

Private IP address assigned to this endpoint.

statusobject

Endpoint connectivity status.

namestring

Display name for the endpoint.

imeistring or null

IMEI with Software Version Number (IMEISV) (16 digits).

createdstringformat: "date-time"

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

last_updatedstringformat: "date-time"

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

imei_lockboolean

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

service_profileobject

Service profile assigned to this endpoint.

tariff_profileobject

Tariff profile assigned to this endpoint.

simobject or null

SIM card assigned to this endpoint. null if no SIM is assigned.

ip_address_spaceobject

IP address space containing this endpoint's private IP address.

imei_with_luhnstring or null

IMEI with Luhn checksum digit, without Software Version Number (15 digits).

tagsstring or nullDeprecated

Comma-separated list of tags.

Deprecated. Use tag_assignments instead.

tag_assignmentslist of objectsOptional

Structured tag data with color information.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error