Bulk create endpoints

POST

https://smartsim.telecom.li/api/v2/endpoint/multi

POST

/api/v2/endpoint/multi

curl -X POST https://smartsim.telecom.li/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",
      "tag_assignments": [
        1,
        2
      ],
      "imei": "123456789012345",
      "imei_lock": false,
      "sim": {
        "id": 3595575,
        "activate": true
      },
      "ip_address": "127.0.0.1"
    },
    {
      "name": "Test 2",
      "tag_assignments": [
        1,
        2
      ],
      "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",
    "tag_assignments": [
      {
        "id": 1,
        "name": "test1",
        "tag_color": {
          "id": 3
        }
      },
      {
        "id": 2,
        "name": "test2",
        "tag_color": {
          "id": 5
        }
      }
    ],
    "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
    },
    "ip_address_space": {
      "id": 16740
    },
    "tags": "test1,test2",
    "imei": "3561234567890123",
    "sim": {
      "iccid": "8988303000005751718",
      "iccid_with_luhn": "89883030000057517184",
      "id": 3595575,
      "imsi": "295050901198207",
      "msisdn": "423663921003632",
      "sim_profile_type_id": 1
    },
    "imei_with_luhn": "356123456789015"
  },
  {
    "id": 31332700,
    "ip_address": "10.189.227.225",
    "status": {
      "description": "Disabled",
      "id": 1
    },
    "name": "Test 2",
    "tag_assignments": [
      {
        "id": 1,
        "name": "test1",
        "tag_color": {
          "id": 3
        }
      },
      {
        "id": 2,
        "name": "test2",
        "tag_color": {
          "id": 5
        }
      }
    ],
    "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
    },
    "ip_address_space": {
      "id": 16741
    },
    "tags": "test1,test2",
    "imei": "3561234567890123",
    "sim": {
      "iccid": "8988303000005751719",
      "iccid_with_luhn": "89883030000057517185",
      "id": 12345,
      "imsi": "295050901198208",
      "msisdn": "423663921003633",
      "sim_profile_type_id": 1
    },
    "imei_with_luhn": "356123456789015"
  }
]

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 and is activated by default. To assign the SIM without activating it, explicitly set the activate property to false; omitting it activates the SIM.

When the SIM is activated:

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.

Telecom Liechtenstein 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 and is activated by default. To assign the SIM without activating it, explicitly set the `activate` property to `false`; omitting it activates the SIM. When the SIM is activated: - 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> Telecom Liechtenstein 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

tag_assignmentslist of objects

Structured tag data with color information.

createdstringformat: "date-time"

last_updatedstringformat: "date-time"

imei_lockboolean

service_profileobject

tariff_profileobject

ip_address_spaceobject

tagsstringDeprecated

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

Deprecated. Use tag_assignments instead.

imeistringOptional

simobjectOptional

imei_with_luhnstringOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error