Skip to main content
POST
/
private_wireless_gateways
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const privateWirelessGateway = await client.privateWirelessGateways.create({
  name: 'My private wireless gateway',
  network_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
});

console.log(privateWirelessGateway.data);
{
  "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",
    "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
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
network_id
string<uuid>
required

The identification of the related network resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

​
name
string
required

The private wireless gateway name.

Example:

"My private wireless gateway"

​
region_code
string

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

Example:

"dc2"

Response

Successful Response

​
data
object