Coverage

List network coverage locations

Changed on

List all locations and the interfaces that region supports

get/network_coverage

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/network_coverage
  • Auth: HTTP bearer

Query parameters

Consolidated filters parameter (deepObject style). Originally: filters[available_services][contains]

location.regionstring

The region of associated location to filter on.

location.sitestring

The site of associated location to filter on.

location.popstring

The POP of associated location to filter on.

location.codestring

The code of associated location to filter on.

Consolidated filter parameter (deepObject style). Originally: filter[location.region], filter[location.site], filter[location.pop], filter[location.code]

{
  "location.region": "AMER",
  "location.site": "SJC",
  "location.pop": "SV1",
  "location.code": "silicon_valley-ca"
}
numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

Example response

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

Changes

  • b90f73c590c5Revision changes
    • warning

      added the new tailscale_subnet_router enum value to the //// response property for the response status

    • info

      added the enum value tailscale_subnet_router to the property available_services/oneOf[subschema #1: Available service]/ of the query request parameter filters

    • info

      added the enum value tailscale_subnet_router to the property available_services/oneOf[subschema #2]/contains of the query request parameter filters

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status