Edge SIM

  1. Edge SIM enables end to end connectivity from the customer’s edge mobile device to the Customer’s designated Cloud or data center.
  • Edge devices can be distributed worldwide and connected to the Cloud via local mobile networks in over 180 countries (note: ~120 countries are offered on the Console Connect portal; other countries are available on request) where there are Service Coverage and grouped into several Pricing Zones.
  • Bypassing the public Internet, the end-to-end connection from the mobile device is secured over a private path direct from the mobile device into the CloudRouter
  • Groups of SIMs called “SIMPools” act as an individual site in Cloud Router, allowing for easy configuration for the customer to build private networks to multiple clouds and data centers.
  • Configuration of Edge SIM is totally automated, allowing customers to build their own networks in minutes.
  1. An ordering service is provided in Console Connect together with a SIM management portal
  • Edge SIM can be ordered by the customer anytime over the console ordering portal, similar to other Console Connect services.

  • The newly ordered Edge SIMs can be added to any of the existing SIMPool or if require, the customer can setup a new SIMPool. SIMPools can be added to the Customer’s existing or newly defined sites on Cloud Router.

Frequently Asked Questions (FAQs)

  • What is Edge SIM?

    • Edge SIM allows you to extend the connectivity of your mobile devices to connect directly with your own CloudRouter network. This allows for the creation of new and novel configurations; and use cases that are more secure, reliable, and scalable as the Internet is bypassed entirely. Edge SIM is entirely automated. Networks can be configured with a few clicks, and working within minutes.
  • What are the major differences between the Console Connect Edge SIM and the Console Connect IoT SIM solution?

    • Existing Console Connect IoT SIMs essentially provide services via simple internet connectivity, whereas Edge SIMs bypass the Internet entirely, allowing for direct connections to Clouds and data centers globally, through CloudRouter. The Edge SIM solution is suitable for more sophisticated IoT applications, as shown in the table below:.

This is aimed at simplifying the ordering, deployment and change management of your entire global IoT network with Console Connect.

  • A SIMPool is a group of SIMs that share the same service gateway and configurations, such as IP addresses, subnets, and DNS servers.
  • SIMs can be added to a SIMPool or moved to another SIMPool
  • A SIMPool has to be added to the Cloud Router before the traffic can be routed to the customer network
  • The SIMPool will also be used to direct traffic to a managed firewall for customers requiring internet access in the future.

Get Edge SIM orders

Retrieves all Edge SIM orders enlisted under provided id field and filtered accordingly based on the Filter parameter

Securityapi-key
Request
path Parameters
id
required
string

This correlates to the current API user's id.

Example: 5f97d3d2d85fbe0014fd1812
query Parameters
filter
string

This field helps us filter, sort, limit and order the returned data.

Example: filter={ fields: simPoolName | ["simPoolName","connectivityType"], include: company | ["company","apn"], limit: 10, order: asc | desc, skip: 10, where: {"companyId":"5f97d3d2d85fbe0014fd1812"}}
Responses
200

OK

404

Error

get/app-user/{id}/iot-order
Response samples
application/json
[
  • {
    }
]

Create Edge SIM order

Creates a new Edge SIM order of this model type and returns it as a response

Securityapi-key
Request
path Parameters
id
required
string

This correlates to the current API user's id.

Example: 5f97d3d2d85fbe0014fd1812
Request Body schema: application/json
object

This object contains all the necessary information required to create a new Edge SIM order.

Responses
200

OK

404

Error

post/app-user/{id}/iot-order
Request samples
application/json
{
  • "name": "test 123456",
  • "orderType": "PAYG",
  • "simPoolName": "test 123456",
  • "companyId": "5f97d3d2d85fbe0014fd1812",
  • "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
  • "connectivityType": "PRIVATE",
  • "simQuantity": 1,
  • "simType": "PHYSICAL-SIM",
  • "dnsAlternate": "100.100.1.0",
  • "dnsPreferred": "100.100.2.0",
  • "useDefaultDNS": "true",
  • "paymentType": "INVOICE"
}
Response samples
application/json
{
  • "id": "0433187-29b2-40d6-97de-69b3cb4f7a0f",
  • "friendlyId": "IOTC38C11E9BD",
  • "simPoolId": null,
  • "simPoolName": "test 123456",
  • "companyId": "5f97d3d2d85fbe0014fd1812",
  • "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
  • "connectivityType": "PRIVATE",
  • "name": "test 123456",
  • "simQuantity": 1,
  • "deliveryAddress": null,
  • "companyAddress": "Lorem , Ipsum Text",
  • "orderType": "PAYG",
  • "dnsPreferred": "10.100.1.1",
  • "dnsAlternate": "10.100.1.2",
  • "useDefaultDNS": true,
  • "status": "ORDERED",
  • "error": null,
  • "userEmail": "user@pccwglobal.com",
  • "deliveryEmail": null,
  • "paymentType": "INVOICE",
  • "offerType": null,
  • "endUser": null,
  • "skipUserEmail": false,
  • "skipAdminEmail": false,
  • "skipSupportEmail": false,
  • "skipCompliance": false,
  • "skipSlack": false,
  • "skipInsightSr": false,
  • "sourceEnterpriseId": null,
  • "simType": "PHYSICAL-SIM",
  • "productId": 1143474,
  • "description": "Lorem , Ipsum Text",
  • "manufacturer": "Thales (MADE IN CHINA)",
  • "purchaseDate": "2020-05-26T00:00:00.000Z",
  • "originalPurchaseOrder": "ZM1124438",
  • "purchaseProject": "IoT",
  • "eccn": "EAR99",
  • "hkHsCode": 85235200,
  • "currency": "USD",
  • "unitPrice": null,
  • "imsiProfileId": null,
  • "createdAt": "2024-07-08T11:09:19.386Z",
  • "updatedAt": "2024-07-15T12:38:48.933Z",
  • "deletedAt": null,
  • "updatedById": null,
  • "company_id": "5f97d3d2d85fbe0014fd1412",
  • "deleted_at": null,
  • "created_at": "2024-07-08T11:09:19.386Z",
  • "updated_at": "2024-07-15T12:38:48.933Z"
}

Get an Edge SIM order by id

Get an Edge SIM order by id

Securityapi-key
Request
path Parameters
id
required
string

This correlates to the current API user's id.

Example: 5f97d3d2d85fbe0014fd1812
orderId
required
string

Edge SIM order id.

Example: 115973a6-f372-4ab5-a171-f3a52d334f48
Responses
200

OK

400

Error

post/app-user/{id}/iot-order/{orderId}
Response samples
application/json
{
  • "id": "0433187-29b2-40d6-97de-69b3cb4f7a0f",
  • "friendlyId": "IOTC38C11E9BD",
  • "simPoolId": null,
  • "simPoolName": "test 123456",
  • "companyId": "5f97d3d2d85fbe0014fd1812",
  • "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
  • "connectivityType": "PRIVATE",
  • "name": "test 123456",
  • "simQuantity": 1,
  • "deliveryAddress": null,
  • "companyAddress": "Lorem , Ipsum Text",
  • "orderType": "PAYG",
  • "dnsPreferred": "10.100.1.1",
  • "dnsAlternate": "10.100.1.2",
  • "useDefaultDNS": true,
  • "status": "ORDERED",
  • "error": null,
  • "userEmail": "user@pccwglobal.com",
  • "deliveryEmail": null,
  • "paymentType": "INVOICE",
  • "offerType": null,
  • "endUser": null,
  • "skipUserEmail": false,
  • "skipAdminEmail": false,
  • "skipSupportEmail": false,
  • "skipCompliance": false,
  • "skipSlack": false,
  • "skipInsightSr": false,
  • "sourceEnterpriseId": null,
  • "simType": "PHYSICAL-SIM",
  • "productId": 1143474,
  • "description": "Lorem , Ipsum Text",
  • "manufacturer": "Thales (MADE IN CHINA)",
  • "purchaseDate": "2020-05-26T00:00:00.000Z",
  • "originalPurchaseOrder": "ZM1124438",
  • "purchaseProject": "IoT",
  • "eccn": "EAR99",
  • "hkHsCode": 85235200,
  • "currency": "USD",
  • "unitPrice": null,
  • "imsiProfileId": null,
  • "createdAt": "2024-07-08T11:09:19.386Z",
  • "updatedAt": "2024-07-15T12:38:48.933Z",
  • "deletedAt": null,
  • "updatedById": null,
  • "company_id": "5f97d3d2d85fbe0014fd1412",
  • "deleted_at": null,
  • "created_at": "2024-07-08T11:09:19.386Z",
  • "updated_at": "2024-07-15T12:38:48.933Z"
}

Lists all Edge SIM SIMPools.

List Edge SIM SIMPools for the logged-in user's company based on the given Company Id.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
query Parameters
filter
string

Filter string object containing keys and properties to filter by.

Example: filter={ fields: asn | ["asn","orderId"], include: asn | ["asn","orderId"], limit: 10, order: asc | desc, skip: 10, where: {"apnId":"238094-4546-2323-5687879-234"}}
Responses
200

Returns a list of all Edge SIM SIMPools.

404

Throws an error for not found Edge SIM SIMPools under Company Id.

get/app-user/{id}/iot-sim-pools
Response samples
application/json
[
  • {
    }
]

Creates a new instance of an Edge SIM SIMPool.

Creates a new instance of an Edge SIM SIMPool under current Company Id.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
Request Body schema: application/json
required

Field contains Information on Edge SIM SIMPool to be created.

id
string
name
required
string
apnId
required
string
subnet
string

Gets assigned to the SIM pool on creation

firewall
string
Default: "DISABLED"

CUSTOM is not supported yet

Enum: "ENABLED" "DISABLED" "CUSTOM"
firewallStatus
string
Default: "SUCCESS"
Enum: "SUCCESS" "PROCESSING" "FAILED"
status
string
Default: "SUCCESS"
Enum: "SUCCESS" "PROCESSING" "FAILED"
error
string
primaryDNS
string
secondaryDNS
string
companyId
required
string
defaultPrimaryDNS
string
defaultSecondaryDNS
string
useDefaultDNS
boolean
customFirewallEnabled
boolean
customFirewallPolicies
string
created_at
string <date-time>

A date time format.

updated_at
string <date-time>

A date time format.

Responses
200

Returns an Edge SIM SIMPools.

400

Throws an error for not found Edge SIM SIMPools under Company Id.

post/app-user/{id}/iot-sim-pools
Request samples
application/json
{
  • "name": "Test SIM Pool",
  • "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
  • "useDefaultDNS": true
}
Response samples
application/json
{
  • "id": "022bbd4d-42ae-4d2f-a563-7c517d50daaa",
  • "name": "Test SIM Pool",
  • "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
  • "companyId": "5f97d3d2d85fbe0014fd1812",
  • "subnet": "10.10.10.10/18",
  • "firewall": "DISABLED",
  • "firewallStatus": "SUCCESS",
  • "status": "CREATED",
  • "error": null,
  • "simCount": 2,
  • "primaryDNS": null,
  • "secondaryDNS": null,
  • "defaultPrimaryDNS": "1.1.1.1",
  • "defaultSecondaryDNS": "2.2.2.2",
  • "useDefaultDNS": true,
  • "customFirewallEnabled": false,
  • "customFirewallPolicies": [ ],
  • "apn": { },
  • "company_id": "5f97d3d2d85fbe0014fd1812",
  • "apn_id": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
  • "created_at": "2024-08-16T08:46:45.476Z",
  • "updated_at": "2024-08-16T08:46:45.476Z"
}

Update a related item by id for Edge SIM SIMPool.

Updates a related item by id on respective Edge SIM SIMPool for the logged-in user's company based on the given Company Id.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
iotSimPoolId
required
string

Edge SIM SimPool Id for the respective Edge SIM SIMPool.

Example: e3408b4b-3d67-4953-3db2-ae3ddd483745
Request Body schema: application/json
required

Field contains Information on Edge SIM SIMPool to be updated.

id
string
name
string
apnId
string
subnet
string

Gets assigned to the sim pool on creation

firewall
string
Default: "DISABLED"

CUSTOM is not supported yet

Enum: "ENABLED" "DISABLED" "CUSTOM"
firewallStatus
string
Default: "SUCCESS"
Enum: "SUCCESS" "PROCESSING" "FAILED"
status
string
Default: "SUCCESS"
Enum: "SUCCESS" "PROCESSING" "FAILED"
error
string
primaryDNS
string
secondaryDNS
string
companyId
string
defaultPrimaryDNS
string
defaultSecondaryDNS
string
useDefaultDNS
boolean
customFirewallEnabled
boolean
customFirewallPolicies
string
created_at
string <date-time>

A date time format.

updated_at
string <date-time>

A date time format.

Responses
200

Returns the respective Edge SIM SIMPool.

404

Throws an error for not found Foreign Key on Edge SIM SIMPool under Company Id. /app-user/{id}/iot-sim-pools/{destSimPoolId}/sims

put/app-user/{id}/iot-sim-pools/{iotSimPoolId}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "apnId": "string",
  • "subnet": "string",
  • "firewall": "ENABLED",
  • "firewallStatus": "SUCCESS",
  • "status": "SUCCESS",
  • "error": "string",
  • "primaryDNS": "string",
  • "secondaryDNS": "string",
  • "companyId": "string",
  • "defaultPrimaryDNS": "string",
  • "defaultSecondaryDNS": "string",
  • "useDefaultDNS": true,
  • "customFirewallEnabled": true,
  • "customFirewallPolicies": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "022bbd4d-42ae-4d2f-a563-7c517d50daaa",
  • "name": "Test SIM Pool",
  • "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
  • "companyId": "5f97d3d2d85fbe0014fd1812",
  • "subnet": "10.10.10.10/18",
  • "firewall": "DISABLED",
  • "firewallStatus": "SUCCESS",
  • "status": "CREATED",
  • "error": null,
  • "simCount": 2,
  • "primaryDNS": null,
  • "secondaryDNS": null,
  • "defaultPrimaryDNS": "1.1.1.1",
  • "defaultSecondaryDNS": "2.2.2.2",
  • "useDefaultDNS": true,
  • "customFirewallEnabled": false,
  • "customFirewallPolicies": [ ],
  • "apn": { },
  • "company_id": "5f97d3d2d85fbe0014fd1812",
  • "apn_id": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
  • "created_at": "2024-08-16T08:46:45.476Z",
  • "updated_at": "2024-08-16T08:46:45.476Z"
}

Deletes a related item from the respective Edge SIM SIMPool by Id.

Deletes a related item from the respective Edge SIM SIMPool by Id from logged-in user's company based on the given Company Id.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
iotSimPoolId
required
string

Iot SimPool Id for the respective Edge SIM SIMPool.

Example: e3408b4b-3d67-4953-3db2-ae3ddd483745
Responses
204

Request was successfully executed.

400

Throws an error for not found Foreign Key on Edge SIM SIMPools under Company Id.

delete/app-user/{id}/iot-sim-pools/{iotSimPoolId}
Response samples
application/json
{
  • "error": {
    }
}

Adds new SIM to an Edge SIM SIMPool.

Updates a related item by id on respective Edge SIM SIMPool for the logged-in user's company based on the given Company Id.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
destinationSimPoolId
required
string

Destination SIMPool Id where to inject the respective Edge SIM SIMs.

Example: 022bbd4d-42ae-4d2f-a563-7c517d50daaa
Request Body schema: application/json
required

SIMs to be moved.

object
Responses
204

Request was successfully executed.

400

Throws an error for not found Foreign Key on Edge SIM SIMPools under Company Id.

put/app-user/{id}/iot-sim-pools/{destinationSimPoolId}/sims
Request samples
application/json
{
  • "sims": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}

Get a list of Edge SIMs for the logged in users company

Get a list of Edge SIM.

Securityapi-key
Request
path Parameters
id
required
string

Company Id of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
query Parameters
filter
string

Filter string object containing keys and properties to filter by.

Example: filter={ fields: asn | ["asn","orderId"], include: asn | ["asn","orderId"], limit: 10, order: asc | desc, skip: 10, where: {"apnId":"238094-4546-2323-5687879-234"}}
Responses
200

Returns an array of Edge SIMs.

401

Throws an error for not found Keys or SIMs.

get/app-user/{id}/iot-sims-cache
Response samples
application/json
[
  • {
    }
]

Get a SIM item of Edge SIM.

Get single Edge SIM.

Securityapi-key
Request
path Parameters
id
required
string

User ID of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
iotSimId
required
string

IoT SIM identifier

Example: 0433187-29b2-40d6-97de-69b3cb4f7a0f
Responses
200

Returns a related item of Edge SIM.

404

Throws an error for not found Keys or SIMs.

get/app-user/{id}/iot-sims-cache/{iotSimId}
Response samples
application/json
{
  • "id": "string",
  • "iotSimPoolId": "string",
  • "iotOrderId": "string",
  • "state": "string",
  • "iccid": "string",
  • "imsi": "string",
  • "msisdn": "string",
  • "detectedImei": "string",
  • "ipAddress": "string",
  • "companyId": "string",
  • "label": "string",
  • "status": "string",
  • "simTransferId": "string",
  • "createdAt": "2024-08-13T09:38:50.268Z",
  • "updatedAt": "2024-08-13T09:38:50.268Z",
  • "simProvider": "string",
  • "company_id": "string",
  • "iot_order_id": "string",
  • "created_at": "2024-08-13T09:38:50.268Z",
  • "updated_at": "2024-08-13T09:38:50.268Z",
  • "iot_sim_pool_id": "string"
}

Update Edge SIM.

Attributes of the SIM can be updated(one or multiple together).

Securityapi-key
Request
path Parameters
id
required
string

User ID of currently logged in user.

Example: 5f97d3d2d85fbe0014fd1812
iotSimId
required
string

IoT SIM identifier

Example: 0433187-29b2-40d6-97de-69b3cb4f7a0f
Request Body schema: application/json
required

Further details for some of the field.

status
string
Enum: "ACTIVE" "PAUSED"
label
string

It is a description for the SIM.

Responses
200

Returns a related item of Edge SIM.

400

Throws an error for not found Keys or SIMs.

put/app-user/{id}/iot-sims-cache/{iotSimId}
Request samples
application/json
{
  • "status": "PAUSED"
}
Response samples
application/json
{
  • "id": "string",
  • "iotSimPoolId": "string",
  • "iotOrderId": "string",
  • "state": "string",
  • "iccid": "string",
  • "imsi": "string",
  • "msisdn": "string",
  • "detectedImei": "string",
  • "ipAddress": "string",
  • "companyId": "string",
  • "label": "string",
  • "status": "string",
  • "simTransferId": "string",
  • "createdAt": "2024-08-13T09:38:50.268Z",
  • "updatedAt": "2024-08-13T09:38:50.268Z",
  • "simProvider": "string",
  • "company_id": "string",
  • "iot_order_id": "string",
  • "created_at": "2024-08-13T09:38:50.268Z",
  • "updated_at": "2024-08-13T09:38:50.268Z",
  • "iot_sim_pool_id": "string"
}