Private Wireless Gateways API

Private Wireless Gateways operations API

Get all Private Wireless Gateways

Get all Private Wireless Gateways belonging to the user.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[name]
string

The name of the Private Wireless Gateway.

Example: filter[name]=my private gateway
filter[ip_range]
string

The IP address range of the Private Wireless Gateway.

Example: filter[ip_range]=192.168.0.0/24
filter[region_code]
string

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

Example: filter[region_code]=ashburn-va
filter[created_at]
string

Private Wireless Gateway resource creation date.

Example: filter[created_at]=2018-02-02T22:25:27.521Z
filter[updated_at]
string

When the Private Wireless Gateway was last updated.

Example: filter[updated_at]=2018-02-02T22:25:27.521Z
Responses
200

Successful response

Response Schema: application/json
Array of objects (PrivateWirelessGateway)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/private_wireless_gateways
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.PrivateWirelessGateway.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "assigned_resources": [
        • {
          • "count": 1,
          • "record_type": "sim_card_group"
          }
        ],
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "ip_range": "100.64.1.0/24",
      • "name": "My private wireless gateway",
      • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "private_wireless_gateway",
      • "region_code": "ashburn-va",
      • "status": {
        • "error_code": null,
        • "error_description": null,
        • "value": "provisioned"
        },
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create a Private Wireless Gateway

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network.

SecuritybearerAuth
Request
Request Body schema: application/json
required
name
required
string

The private wireless gateway name.

network_id
required
string <uuid>

The identification of the related network resource.

Responses
202

Successful response

Response Schema: application/json
object (PrivateWirelessGateway)
Array of objects (PWGAssignedResourcesSummary)

A list of the resources that have been assigned to the Private Wireless Gateway

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

id
string <uuid>

Identifies the resource.

ip_range
string
Default: null

IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.

name
string

The private wireless gateway name.

network_id
string <uuid>

The identification of the related network resource.

record_type
string
region_code
string
Default: "ashburn-va"

The geographical region where the Private Wireless Gateway is deployed to.

object (PrivateWirelessGatewayStatus)

The current status or failure details of the Private Wireless Gateway.

updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

422

Unprocessable entity. Check the 'detail' field in response for details.

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/private_wireless_gateways
Request samples
application/json
{
  • "name": "My private wireless gateway",
  • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}
Response samples
application/json
{
  • "data": {
    • "assigned_resources": [
      • {
        • "count": 1,
        • "record_type": "sim_card_group"
        }
      ],
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "ip_range": "100.64.1.0/24",
    • "name": "My private wireless gateway",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "private_wireless_gateway",
    • "region_code": "ashburn-va",
    • "status": {
      • "error_code": null,
      • "error_description": null,
      • "value": "provisioned"
      },
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Delete a Private Wireless Gateway

Deletes the Private Wireless Gateway.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (PrivateWirelessGateway)
Array of objects (PWGAssignedResourcesSummary)

A list of the resources that have been assigned to the Private Wireless Gateway

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

id
string <uuid>

Identifies the resource.

ip_range
string
Default: null

IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.

name
string

The private wireless gateway name.

network_id
string <uuid>

The identification of the related network resource.

record_type
string
region_code
string
Default: "ashburn-va"

The geographical region where the Private Wireless Gateway is deployed to.

object (PrivateWirelessGatewayStatus)

The current status or failure details of the Private Wireless Gateway.

updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

404

Resource not found

Response Schema: application/json
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
delete/private_wireless_gateways/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.PrivateWirelessGateway.retrieve('id')
res.delete()
Response samples
application/json
{
  • "data": {
    • "assigned_resources": [
      • {
        • "count": 1,
        • "record_type": "sim_card_group"
        }
      ],
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "ip_range": "100.64.1.0/24",
    • "name": "My private wireless gateway",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "private_wireless_gateway",
    • "region_code": "ashburn-va",
    • "status": {
      • "error_code": null,
      • "error_description": null,
      • "value": "provisioned"
      },
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Get a Private Wireless Gateway

Retrieve information about a Private Wireless Gateway.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (PrivateWirelessGateway)
Array of objects (PWGAssignedResourcesSummary)

A list of the resources that have been assigned to the Private Wireless Gateway

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

id
string <uuid>

Identifies the resource.

ip_range
string
Default: null

IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.

name
string

The private wireless gateway name.

network_id
string <uuid>

The identification of the related network resource.

record_type
string
region_code
string
Default: "ashburn-va"

The geographical region where the Private Wireless Gateway is deployed to.

object (PrivateWirelessGatewayStatus)

The current status or failure details of the Private Wireless Gateway.

updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

404

Resource not found

Response Schema: application/json
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/private_wireless_gateways/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.PrivateWirelessGateway.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "assigned_resources": [
      • {
        • "count": 1,
        • "record_type": "sim_card_group"
        }
      ],
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "ip_range": "100.64.1.0/24",
    • "name": "My private wireless gateway",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "private_wireless_gateway",
    • "region_code": "ashburn-va",
    • "status": {
      • "error_code": null,
      • "error_description": null,
      • "value": "provisioned"
      },
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}