Network Routes

List all Network Routes

Changed on

Lists the routes of the account's Networks. A Network's list is its effective route table: the routes added with POST /network_routes (origin static) and the routes that its attachments install (origin attachment). Lookup is longest prefix within the Network.

get/network_routes

Request

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

Query parameters

network_idstring uuid required

The id of the Network whose route table is returned. Required.

origin'static' | 'attachment'

Only routes of this origin.

next_hop.type'tunnel' | 'wireguard_peer' | 'wireguard_interface' | 'private_wireless_gateway' | 'virtual_cross_connect' | 'ipsec_tunnel' | 'public_internet_gateway'

Only routes whose next hop has this type.

cidrstring

Only routes with this CIDR.

status'pending' | 'active' | 'inactive' | 'failed'

Only routes with this status.

Consolidated filter parameter (deepObject style). Originally: filter[network_id], filter[origin], filter[next_hop.type], filter[cidr], filter[status]

{
  "network_id": "91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24",
  "origin": "static",
  "next_hop.type": "tunnel",
  "cidr": "10.20.0.0/16",
  "status": "active"
}
sort'cidr' | '-cidr' | 'status' | '-status' | 'created_at' | '-created_at'
Example:-created_at

Sorts the results by a field, ascending, or descending with a leading -. The default is -created_at.

afterstring

The cursor from meta.cursors.after of the previous page.

limitinteger

The number of results per page.

Consolidated page parameter (deepObject style). Originally: page[after], page[limit]

Response

Successful response.

Example response

{
  "data": [
    {
      "id": "e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53",
      "record_type": "network_route",
      "network_id": "91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24",
      "cidr": "10.20.0.0/16",
      "next_hop": {
        "type": "tunnel",
        "id": "62d438d2-8a51-4c5e-9d0c-1f6b2a7e4c39"
      },
      "origin": "static",
      "status": "active",
      "created_at": "2026-10-21T15:04:05.123456Z"
    }
  ],
  "meta": {
    "next": "/v2/network_routes?filter%5Bnetwork_id%5D=91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24&page%5Bafter%5D=MjAyNi0xMC0yMVQxNjowNjowMC4wNDMwNDRa&page%5Blimit%5D=1"
  }
}

Changes