Private Wireless Gateways

Create a Private Wireless Gateway

Changed on

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.

post/private_wireless_gateways

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/private_wireless_gateways
  • Auth: HTTP bearer

Request body

network_idstring uuid required

The identification of the related network resource.

namestring required

The private wireless gateway name.

region_codestring

The code of the region where the private wireless gateway will be assigned. A list of available regions can be found at the regions endpoint

address_mode'static' | 'dynamic'

Determines how IP addresses are assigned to SIM cards using this gateway. With static, each SIM card gets a fixed IP address from the gateway's IP range that is preserved across sessions. With dynamic, an IP address is assigned by the network at attach time and may change between sessions. If omitted, the gateway is created with the default address mode, dynamic.

Example request

{
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "name": "My private wireless gateway",
  "region_code": "dc2",
  "address_mode": "static"
}

Response

Creation request accepted. Provisioning is asynchronous; poll GET /private_wireless_gateways/{id} with the returned id to check status.

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "private_wireless_gateway",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "name": "My private wireless gateway",
    "address_mode": "dynamic",
    "region_code": "dc2",
    "status": {
      "value": "provisioning",
      "error_description": null,
      "error_code": null
    },
    "ip_range": "100.64.1.0/24",
    "assigned_resources": [
      {
        "record_type": "sim_card_group",
        "count": 1
      }
    ]
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • f6e9ed754d05Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status