API reference

Tunnels

A public address for a service on a machine that cannot accept inbound connections.

Tunnels of an organisation, newest first

GET/v1/orgs/{org}/tunnels

API token or dashboard session

Tunnels of an organisation, newest first.

Path parameters

orgstringpathrequired
Organisation slug

Responses

200Tunnel[]

Fields of Tunnel

addressstringrequired
What to give to whoever should reach the tunnel: a URL for HTTP, host:port otherwise.
agentsintegerrequired
Agents currently connected. Zero means the tunnel is offline.
created_atdate-timerequired
hostnamestringrequired
iduuidrequired
machine_iduuid | null
The machine that serves it. Absent for a tunnel not yet attached to one.
namestringrequired
portinteger | null
Public port, for TCP and UDP tunnels.
protocolProtocolrequired
targetstring | null
The local service it leads to on that machine: host:port.

curl "https://api.infraflow.app/v1/orgs/acme/tunnels" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Response · 200

[
  {
    "address": "string",
    "agents": 0,
    "created_at": "2026-01-15T09:30:00Z",
    "hostname": "www.example.com",
    "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
    "machine_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
    "name": "my-app",
    "port": 3000,
    "protocol": "http",
    "target": "3000"
  }
]

Create a tunnel

POST/v1/orgs/{org}/tunnels

API token or dashboard session

Create a tunnel. HTTP tunnels get a hostname; TCP and UDP tunnels also get a public port.

Path parameters

orgstringpathrequired
Organisation slug

Request body · application/json

machine_iduuid | null
The machine that serves it. With target.
namestring | null
The label in the tunnel's hostname. Generated when omitted.
protocolProtocolrequired
reuseboolean

Point a tunnel at another local service, or move it to another machine

PATCH/v1/orgs/{org}/tunnels/{id}

API token or dashboard session

Point a tunnel at another local service, or move it to another machine. Its public address does not change.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

machine_iduuidrequired
The machine that serves it.
targetstringrequired
The local service on that machine: a port, or host:port.

Responses

Delete a tunnel

DELETE/v1/orgs/{org}/tunnels/{id}

API token or dashboard session

Delete a tunnel. Connected agents are disconnected.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/tunnels/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Get a ticket that lets an agent serve this tunnel

POST/v1/orgs/{org}/tunnels/{id}/ticket

API token or dashboard session

Get a ticket that lets an agent serve this tunnel.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TunnelTicket
501Problem
Tunnels are not enabled on this deployment

Fields of TunnelTicket

endpointstringrequired
host:port the agent connects to, over QUIC.

[ { "address": "string", "agents": 0, "created_at": "2026-01-15T09:30:00Z", "hostname": "www.example.com", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "machine_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "port": 3000, "protocol": "http", "target": "3000" } ]