Tunnels

Create a Tunnel

Changed on

Creates a tunnel and returns its tunnel_token. The token is the only credential the tunnel process needs, and this response and POST /tunnels/{id}/actions/rotate_token are the only ones that return it. A new tunnel is inactive until a tunnel process connects with the token.

post/tunnels

Request

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

Request body

namestring required

A user specified name for the tunnel.

Example request

{
  "name": "chicago-dc"
}

Response

Created. The response carries the tunnel token, once.

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",
    "tunnel_token": "tnl_example-token-shown-once"
  }
}

Changes