Get all Private Wireless Gateways

GET 
/private_wireless_gateways

Get all Private Wireless Gateways belonging to the user.

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

filter[name] string
The name of the Private Wireless Gateway.
Example: my private gateway
filter[ip_range] string
The IP address range of the Private Wireless Gateway.
Example: 192.168.0.0/24
filter[region_code] string
The name of the region where the Private Wireless Gateway is deployed.
Example: ashburn-va
filter[created_at] string
Private Wireless Gateway resource creation date.
Example: 2018-02-02T22:25:27.521Z
filter[updated_at] string
When the Private Wireless Gateway was last updated.
Example: 2018-02-02T22:25:27.521Z

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Identifies the resource.

network_id uuid

The identification of the related network resource.

record_type string

created_at string

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

updated_at string

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

name string

The private wireless gateway name.

region_code string

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

status

object

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

value string

Possible values: [provisioning, provisioned, failed, decommissioning]

Default value: provisioning

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

• provisioning - the Private Wireless Gateway is being provisioned.
• provisioned - the Private Wireless Gateway was provisioned and able to receive connections.
• failed - the provisioning had failed for a reason and it requires an intervention.
• decommissioning - the Private Wireless Gateway is being removed from the network.

Transitioning between the provisioning and provisioned states may take some time.

error_description string

This attribute provides a human-readable explanation of why a failure happened.

error_code string

This attribute is an error code related to the failure reason.

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

ip_range string

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

assigned_resources

object[]

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

Array [

record_type string

The type of the resource assigned to the Private Wireless Gateway.

count integer

The current count of a resource type assigned to the Private Wireless Gateway.

]

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

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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": "ashburn-va",
      "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

401: Unauthorized

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/private_wireless_gateways' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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": "ashburn-va",
      "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}