List network coverage locations

GET 
/network_coverage

List all locations and the interfaces that region supports

Request

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

filters[available_services][contains] Available service

Possible values: [cloud_vpn, private_wireless_gateway, virtual_cross_connect]

The region of associated location to filter on.

filter[location.region] string

The region of associated location to filter on.

filter[location.site] string

The site of associated location to filter on.

filter[location.pop] string

The POP of associated location to filter on.

filter[location.code] string

The code of associated location to filter on.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Identifies the type of the resource.

location

object

region string

Identifies the geographical region of location.

site string

Site of location.

pop string

Point of presence of location.

code string

Location code.

name string

Human readable name of location.

available_services

object[]

List of interface types supported in this region.

Array [

oneOf

• Available service

string

Possible values: [cloud_vpn, private_wireless_gateway, virtual_cross_connect]

]

List of interface types supported in this region.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "record_type": "network_coverage",
      "location": {
        "region": "AMER",
        "site": "ORD",
        "pop": "CH1",
        "code": "chicago-il",
        "name": "Chicago IL, US"
      },
      "available_services": [
        "cloud_vpn"
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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/network_coverage' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "record_type": "network_coverage",
      "location": {
        "region": "AMER",
        "site": "ORD",
        "pop": "CH1",
        "code": "chicago-il",
        "name": "Chicago IL, US"
      },
      "available_services": [
        "cloud_vpn"
      ]
    }
  ],
  "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": {}
    }
  ]
}