Tunnels#

Do not construct this object directly, instead access the tunnels property of an ngrok.Client object.

class ngrok.services.TunnelsClient(client)[source]#

Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

get(id)[source]#

Get the status of a tunnel by ID

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-tunnels-get

Return type:

Tunnel

list(before_id=None, limit=None)[source]#

List all online tunnels currently running on the account.

Parameters:
  • before_id (str) –

  • limit (str) –

https://ngrok.com/docs/api#api-tunnels-list

Return type:

TunnelList