Set Secure Gateway (Optional)

info

You will be using the Alef Mobile Network API to carry out the tasks in this section. This is a basic config, Refer to the API reference documentation to learn more about the API and explore the full schema.

Configure your Secure Gateway

Required information

• name: Name for the Secure Gateway, needs to be unique in your account.
• edgelocation: The (Alef) Edge Location to deploy the Secure Gateway to. (CHI-1, PHI-1).

note

Each eNB provider has its own way of connecting with a Secure Gateway. Alef can support you with the initial setup and provide with the right information for IPSec certificates.

You will use the following POST request body with the /connectivity/v2/networks/secure-gateway endpoint to create and configure your Secure Gateway.

You can use the following GET request body with the /connectivity/v2/networks/secure-gateway:id endpoint to retrieve your Secure Gateway information.

Expand here to see the Secure Gateway POST request body.

{
  "name": "My-First-SecGW",
  "edgelocation": "PHI-1",
  "mobile-core-id": "66c75ae54333dcc27fbce394",
  "ran_id": "66c7553603ffb584d8338c4e",
  "edgepoint_id": "68100e034228c3f6557abca6",
}

Examples

info

All APIs require the user to be authenticated with their username/password. The JWT token needs to be added to the header as Bearer of each call.

Expand here to see examples for Secure Gateway POST and GET requests and responses.

Curl POST

Request

curl -X 'POST' 'https://api.alefedge.com/connectivity/v2/networks/secure-gateway' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d ' {
  "name": "My-First-SecGW",
  "edgelocation": "PHI-1",
  "mobile-core-id": "66c75ae54333dcc27fbce394",
  "ran_id": "66c7553603ffb584d8338c4e",
  "edgepoint_id": "68100e034228c3f6557abca6"
} '

Response

{
  "name": "My-First-SecGW",
  "edgelocation": "PHI-1",
  "mobile-core-id": "66c75ae54333dcc27fbce394",
  "ran_id": "66c7553603ffb584d8338c4e",
  "edgepoint_id": "68100e034228c3f6557abca6",
  "_id": "68100e034228c3f6557abcb1",
  "provision_state": {
    "provision_status": "in-progress"
  }
}

Curl GET

Request

curl -X 'GET' 'https://api.alefedge.com/connectivity/v2/networks/secure-gateway/68100e034228c3f6557abcb1'
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json'

Response

{
    "_id": "68100e034228c3f6557abcb1",
    "account_id": "66992fb6310e8d77a42ed77a",
    "name": "My-First-SecGW",
    "edgelocation": "PHI-1",
    "mobilecore_id": "68100e024228c3f6557abc76",
    "edgepoint_id": "68100e034228c3f6557abca6",
    "ran_id": "68100e024228c3f6557abc82",
    "service-status": {
        "status": "active",
        "start-date": "2025-04-28T23:23:47.094Z"
    },
    "createdAt": "2025-04-28T23:23:47.095Z",
    "updatedAt": "2025-04-28T23:30:53.178Z",
    "__v": 0,
    "provision_state": {
        "provision_status": "provisioned",
        "health": "up",
        "message": "SecGW 68100e034228c3f6557abcb1 is provisioned"
    }
}

tip

Take a note of the returned object ID _id for your Secure Sateway, as you will need it in the following steps. It will be an alphanumeric string, something like 66c7553603ffb584d8338c4e.

secure-gateway