Tunnels

List all Tunnels

Changed on

Lists the tunnels on the account with their status and connected tunnel processes. Responses never include tunnel_token.

get/tunnels

Request

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

Query parameters

namestring

The name of the tunnel.

status'inactive' | 'healthy' | 'degraded'

The status of the tunnel.

Consolidated filter parameter (deepObject style). Originally: filter[name], filter[status]

{
  "name": "chicago-dc",
  "status": "healthy"
}
sort'name' | '-name' | 'status' | '-status' | 'created_at' | '-created_at' | 'updated_at' | '-updated_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": "62d438d2-8a51-4c5e-9d0c-1f6b2a7e4c39",
      "record_type": "tunnel",
      "name": "chicago-dc",
      "status": "healthy",
      "connection_count": 2,
      "connections": [
        {
          "hostname": "dc1-tunnel-a",
          "version": "0.6.0",
          "region_code": "chicago-il",
          "connected_at": "2026-10-21T15:04:05.123456Z"
        }
      ],
      "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