Tunnel Sessions

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

class ngrok.services.TunnelSessionsClient(client)[source]

Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.

get(id)[source]

Get the detailed status of a tunnel session by ID

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-tunnel-sessions-get

Return type

TunnelSession

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

List all online tunnel sessions running on this account.

Parameters
  • before_id (Optional[str]) –

  • limit (Optional[str]) –

https://ngrok.com/docs/api#api-tunnel-sessions-list

Return type

TunnelSessionList

restart(id)[source]

Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-tunnel-sessions-restart

stop(id)[source]

Issues a command instructing the ngrok agent that started this tunnel session to exit.

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-tunnel-sessions-stop

update(id)[source]

Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

Parameters

id (str) –

https://ngrok.com/docs/api#api-tunnel-sessions-update