Endpoint [APIs]

Endpoint

Endpoints represent SIM-based assets in the SFT platform. Endpoint APIs are used to create, manage, activate, and assign services, plans, and SIMs.

POST Endpoint – Create

Endpoint

CODE

POST /api/createEndpoint

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: endpointInfo

Field	Mandatory	Description
endpointName	Yes	Endpoint name
planId	Yes	Plan id
serviceProfileId	Yes	Service profile id
apnGroupId	No	APN group id
simProductId	Yes	SIM product id

Notes

Create Endpoint is one of the APIs with extended timeout (180 seconds) (see Response Time & Timeout).

GET Endpoint

Endpoint

CODE

GET /api/GetEndpoint

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Query parameters

Parameter	Mandatory	Description
endpointId	No	Fetch a specific endpoint

POST Endpoint – Modify

Endpoint

CODE

POST /api/modifyEndpoint

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: endpointInfo

Field	Mandatory	Description
endpointId	Yes	Endpoint id
endpointName	No	Updated endpoint name
planId	No	Updated plan
apnGroupId	No	Updated APN group

POST Endpoint – Delete

Endpoint

CODE

POST /api/deleteEndpoint

Headers

CODE

Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Request body

Top-level object: endpointInfo

Field	Mandatory	Description
endpointId	Yes	Endpoint id

SIM operations

POST Link SIM

CODE

POST /api/linkSim

POST De-Link SIM

CODE

POST /api/delinkSim

Notes

Link/De-Link SIM are APIs with extended timeout (180 seconds).

Lifecycle operations

POST Endpoint Activation

CODE

POST /api/activateEndpoint

POST Endpoint Lifecycle Change

CODE

POST /api/changeEndpointLifecycle

Notes

Activation and lifecycle change are APIs with extended timeout (180 seconds).

Cross-API parameter sourcing

planId: via GET Query Rate Plan
serviceProfileId: via GET Service Profile
apnGroupId: via GET APN Group
simProductId: via SIM Product IDs section
endpointId: via GET Endpoint or Create response