Bulk create endpoints | emnify Documentation

curl -X POST https://cdn.emnify.net/api/v2/endpoint/multi \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "service_profile": {
    "id": 123
  },
  "tariff_profile": {
    "id": 123
  },
  "status": {
    "id": 0
  },
  "endpoints": [
    {
      "name": "Test 1",
      "tags": "test1,test2",
      "imei": "123456789012345",
      "imei_lock": false,
      "sim": {
        "id": 3595575,
        "activate": true
      },
      "ip_address": "127.0.0.1"
    },
    {
      "name": "Test 2",
      "tags": "test1,test2",
      "imei": "987654321",
      "imei_lock": false,
      "sim": {
        "id": 12345,
        "activate": true
      },
      "ip_address": "127.0.0.2"
    }
  ],
  "organisation": {
    "id": 123
  },
  "ip_address_space": {
    "id": 123
  }
}'

[
  {
    "id": 31332699,
    "ip_address": "10.189.227.225",
    "status": {
      "description": "Disabled",
      "id": 1
    },
    "name": "Test 1",
    "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": 3,
      "name": "Domestic only",
      "satellite_capable": true
    },
    "sim": {
      "id": 3595575,
      "iccid": "8988303000005751718",
      "iccid_with_luhn": "89883030000057517184",
      "sim_profile_type_id": 1,
      "imsi": "295050901198207",
      "msisdn": "423663921003632"
    },
    "ip_address_space": {
      "id": 16740
    },
    "imei_with_luhn": ""
  },
  {
    "id": 31332700,
    "ip_address": "10.189.227.225",
    "status": {
      "description": "Disabled",
      "id": 1
    },
    "name": "Test 2",
    "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": 3,
      "name": "Domestic only",
      "satellite_capable": true
    },
    "sim": {
      "id": 12345,
      "iccid": "8988303000005751719",
      "iccid_with_luhn": "89883030000057517185",
      "sim_profile_type_id": 1,
      "imsi": "295050901198208",
      "msisdn": "423663921003633"
    },
    "ip_address_space": {
      "id": 16741
    },
    "imei_with_luhn": ""
  }
]

Create up to 2,000 endpoints in one request.

Unlike POST /api/v1/endpoint, this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.

Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.

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.

If activate is set to true:

The SIM enters Factory Test Mode (FTM) if FTM is enabled for the organization.
Otherwise, it goes directly to Activated.

To override this behavior and explicitly set the SIM’s status (for example, skip FTM even if it’s enabled for your organization), include a status object within the sim object.

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

Create up to 2,000 endpoints in one request. Unlike [`POST /api/v1/endpoint`](/developers/api/endpoint/create-endpoint), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints. <Note> Execute bulk operations sequentially - wait for each bulk request to complete before starting the next. </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. If `activate` is set to `true`: - The SIM enters Factory Test Mode (FTM) if FTM is enabled for the organization. - Otherwise, it goes directly to **Activated**. To override this behavior and explicitly set the SIM's status (for example, skip FTM even if it's enabled for your organization), include a `status` object within the `sim` object. <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

Applies to all endpoints.

tariff_profileobjectRequired

Applies to all endpoints.

statusobjectRequired

Applies to all endpoints.

endpointslist of objectsRequired

organisationobjectOptional

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

ip_address_spaceobjectOptional

Required if any endpoint in the endpoints array has an ip_address.

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

Errors

Create up to 2,000 endpoints in one request.

Unlike POST /api/v1/endpoint, this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.

Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.

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.

If activate is set to true:

The SIM enters Factory Test Mode (FTM) if FTM is enabled for the organization.
Otherwise, it goes directly to Activated.

To override this behavior and explicitly set the SIM’s status (for example, skip FTM even if it’s enabled for your organization), include a status object within the sim object.

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