Specify an edge for the connection

[jimkring]

In the parameters for ngrok.forward() (see full configuration param's list) I don't see any option to specify an edge or other label for the tunnel.

Is this possible from the python api?

[bobzilladev]

Hello, thanks for your question! There is a labels kwarg that can be used, here's an example:
ngrok.forward("localhost:8080", proto="labeled", labels="edge:edghts_2G...", authtoken_from_env=True)

We'll get the documentation updated to add it. Thanks again!

[jimkring]

That's great it's already supported by the API!

A couple other points:

1. I created a suggestion to make this a named parameter.

2. It would probably make sense to add an option to the ngrok dashboard for creating a tunnel using the Python (Rust, Go, etc.) APIs, as described in the screenshot below:

[jimkring]

@bobzilladev another thought:

3. The example you provided labels="edge:edghts_2G..." shows a truncated string. What's the format for passing multiple labels? e.g. is it a comma-delimited list like labels="key1:value1,key2:value2"?

[bobzilladev]

Will try to answer these questions here:

1. For a more concrete style the builder pattern configuration can be used, here's an example of that which is more explicit: ngrok-labeled.py
2. Adding to the start a tunnel pane has been discussed, for now the python getting started page is a dashboard resource to help initial setup: dashboard.ngrok.com/get-started/setup/python
3. The labels kwarg can take an array as well, labels=["key1:value1", "key2:value2"]

Hopefully that's useful, thanks for the feedback!

[jimkring]

Yes, thanks!