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

const client = new Telnyx({
  apiKey: 'My API Key',
});

const privateWirelessGateways = await client.privateWirelessGateways.list();

console.log(privateWirelessGateways.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": "provisioned",
        "error_description": null,
        "error_code": null
      },
      "ip_range": "100.64.1.0/24",
      "assigned_resources": [
        {
          "record_type": "sim_card_group",
          "count": 1
        }
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page[number]
integer
default:1

The page number to load.

Required range: x >= 1
page[size]
integer
default:20

The size of the page.

Required range: 1 <= x <= 250
filter[name]
string

The name of the Private Wireless Gateway.

filter[ip_range]
string

The IP address range of the Private Wireless Gateway.

filter[region_code]
string

The name of the region where the Private Wireless Gateway is deployed.

filter[created_at]
string

Private Wireless Gateway resource creation date.

filter[updated_at]
string

When the Private Wireless Gateway was last updated.

Response

Successful Response

data
object[]
meta
object