Create an endpoint | emnify Documentation

import requests
url = "https://cdn.emnify.net/api/v1/endpoint"
payload = {
    "service_profile": { "id": 123 },
    "tariff_profile": { "id": 123 },
    "status": { "id": 0 },
    "name": "test",
    "tags": "test1,test2",
    "imei": "123456789012345",
    "imei_lock": False,
    "sim": {
        "id": 3595575,
        "activate": True
    },
    "ip_address": "127.0.0.1",
    "organisation": { "id": 123 },
    "ip_address_space": { "id": 123 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": 31332699,
  "ip_address": "10.189.227.225",
  "status": {
    "description": "Disabled",
    "id": 1
  },
  "name": "test",
  "tags": "test1,test2",
  "imei": "",
  "created": "2025-01-15T14:44:27.622+0000",
  "last_updated": "2025-01-15T14:44:27.622+0000",
  "imei_lock": false,
  "service_profile": {
    "id": 123,
    "name": "Smart meter"
  },
  "tariff_profile": {
    "id": 1.1,
    "name": "string",
    "satellite_capable": true
  },
  "sim": {
    "id": 3595575,
    "iccid": "8988303000005751718",
    "iccid_with_luhn": "89883030000057517184",
    "sim_profile_type_id": 1,
    "imsi": "295050901198207",
    "msisdn": "423663921003632",
    "status": {
      "id": 2,
      "description": "Suspended"
    }
  },
  "ip_address_space": {
    "id": 16740
  },
  "imei_with_luhn": ""
}

Creates one endpoint.

Execute this operation sequentially - wait for each request to complete before starting the next.

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

If a sim object is provided, the specified SIM is assigned to the endpoint. The activate property defaults to false and can be omitted unless the SIM should be activated during this call.

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

Creates one endpoint. <Note> Execute this operation sequentially - wait for each request to complete before starting the next. For bulk operations, use [`POST /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-create-endpoint) instead (supports up to 2,000 endpoints). </Note> If a `sim` object is provided, the specified SIM is assigned to the endpoint. The `activate` property defaults to `false` and can be omitted unless the SIM should be activated during this call. <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

tariff_profileobjectRequired

statusobjectRequired

namestringOptional

tagsstringOptional

imeistringOptional

imei_lockbooleanOptional

simobjectOptional

If you provided, it must include a valid id (cannot be empty).

ip_addressstringOptional

If provided, you must also provide the corresponding ip_address_space.

organisationobjectOptional

If you provided, it must include a valid id (cannot be empty).

ip_address_spaceobjectOptional

Response

iddouble

ip_addressstring

statusobject

namestring

tagsstring

imeistring

createdstringformat: "date-time"

last_updatedstringformat: "date-time"

imei_lockboolean

service_profileobject

tariff_profileobject

simobject

ip_address_spaceobject

imei_with_luhnobject

Authentication

Request

Response

Errors