ngrok / ngrok-api-python

ngrok API client library for Python

ngrok Community Discussions

In this repository, you will find discussions for all things ngrok. Feel free to share feedback, discuss topics with other community members, or ask questions.

Product Feedback / New Feature Ideas

We encourage you to open a discussion if you have suggestions for how we can improve our products. You don't need to have a solution to the problem you are facing to kick off a discussion.

Prior to creating a new discussion, please take a look at previous discussions to see if someone else has already shared your suggestion(s). If you find a similar discussion, reply with additional details or upvote the discussion to signal your support rather than creating a new one.

Once you kick off a new feature discussion, the ngrok Product team will evaluate the feedback but may not be able to respond to every submission. From there, we will work with you, and the entire community, to ensure we understand the current capabilities ngrok doesn’t have and explore the space for potential solutions to your problem statement. If the product team determines that we will not be working to solve the problem you have identified, we may comment on the discussion describing our reasoning so our decisions can remain transparent.

Product Bug Reports

If you think you've found an bug in one of our products, the best place to report them is in the Bug Reports Discussion. This category is regularly monitored by the ngrok Product team who will triage and respond. If the issue is with an open source ngrok product, we encourage you to open public issues directly in those repositories.

Disclaimer

Any statement in this repository that is not purely historical is considered a forward-looking statement. Forward-looking statements included in this repository are based on information available to ngrok as of the date they are made, and ngrok assumes no obligation to update any forward-looking statements. The forward-looking comments in the public feedback discussions do not represent a commitment, guarantee, obligation or promise to deliver any product or feature, or to deliver any product and feature by any particular date, and are intended to outline the general development plans. Customers should not rely on these public feedback discussions to make any purchasing decision.

This repo was inspired by the Github Community Discussions Repo.

ngrok-api-python's Issues

Ngrok unable to delete tunnel sessions

ngrok-api 0.10.0

if __name__ == "__main__":
    client = ngrok.Client("<token>")
    for ses in client.tunnel_sessions.list():
        client.tunnel_sessions.stop(ses.id)

ngrok.error.Error: (Error(...), 'You did not provide a Content-Type with your request. Please check your API client implementation and use one of the supported content types: https://ngrok.com/docs/api#content-types')

Starting a simple tunnel

Just found this repo / pypi package. Really nice to see this available.

Just one minor question, since the documentation is quite technical, and does not refer to functionality but only to technical features.
I want to use this library to create a tunnel like I do during normal development on a daily basis, using the cli: ngrok http 5000. But I cannot find the actual endpoint that I need to use for that. Is this even possible, or is there more to it?

KeyError: 'ns_targets' when creating a reserved domain

When I create a reserved domain, I get the following error while the domain is created in ngrok.

>>> import os
>>> import ngrok
>>> ng = ngrok.Client(os.getenv('API_KEY'))
>>> ng.reserved_domains.create(name="test.example.com")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/takehiko.kodama/Documents/test/ngrok/env/lib/python3.9/site-packages/ngrok/services.py", line 2487, in create
    return ReservedDomain(self._client, result)
  File "/Users/takehiko.kodama/Documents/test/ngrok/env/lib/python3.9/site-packages/ngrok/datatypes.py", line 2694, in __init__
    ReservedDomainCertStatus(client, props["certificate_management_status"])
  File "/Users/takehiko.kodama/Documents/test/ngrok/env/lib/python3.9/site-packages/ngrok/datatypes.py", line 2849, in __init__
    ReservedDomainCertJob(client, props["provisioning_job"])
  File "/Users/takehiko.kodama/Documents/test/ngrok/env/lib/python3.9/site-packages/ngrok/datatypes.py", line 2907, in __init__
    if props["ns_targets"] is not None
KeyError: 'ns_targets'

Cannot install ngrok-api and ngrok packages at the same time

Replication:

• Install the ngrok SDK pip install ngrok
• Install the ngrok API client pip install ngrok-api
• Create a new file called test.py

  import ngrok
  
  ngrok.forward("http://localhost:8080")

• python test.py

Results in:

Traceback (most recent call last):
  File "test/test.py", line 3, in <module>
    ngrok.forward("http://localhost:8080")
    ^^^^^^^^^^^^^^
AttributeError: module 'ngrok' has no attribute 'forward'

Cause

The package ngrok and ngrok-api both contain the same published package folder ngrok. ngrok-api seems to take precedence:

ls python3.11/site-packages/ngrok
__init__.py     __main__.py     __pycache__     client.py       datatypes.py    error.py        http_client.py  iterator.py     mypy.ini        ngrok.abi3.so   ngrok.pyi       ngrok_parser.py py.typed        services.py     utils.py

Suggested fix

Update this package to expose the package directory ngrok_api which might be a better choice.

difficult installation of the ngrok api due to requests dependency specification

The ngrok-api package hard-specifies a version of requests, which is 2 years back. This specification model causes problems with pip and especially poetry. Pip displays a warning during installation if a newer application package is installed in the virtual environment. Poetry prohibits installation.

Because no versions of ngrok-api match >0.8.0,<0.9.0
 and ngrok-api (0.8.0) depends on requests (2.25.1), ngrok-api (>=0.8.0,<0.9.0) requires requests (2.25.1).
And because [...] depends on requests (>=2.28.2,<3.0.0)
 and no versions of [...] match >1.1.2,<2.0.0, ngrok-api (>=0.8.0,<0.9.0) is incompatible with [...] (>=1.1.2,<2.0.0).
So, because [xxxx] depends on both [...] (^1.1.2) and ngrok-api (^0.8.0), version solving failed.

I would like to implement one of the 2 following solutions :

Strategy 1 : Could you declare this dependency by authorizing the use of intermediate version (^2.25.1 instead of ==2.25.1). Knowing that in case of warning with pip, this is already what is done. We're running ngrok-api with a newer version of requests ?

Strategy 2 : Could you update the requests package used more regularly ?

Thanks a lot for your work.

Unable to setup up ngrok tunnel

I am not able to setup ngrok tunnel
bellow is the error I am facing
The ngrok process errored on start: Your ngrok-agent version "2.3.41" is too old. The minimum supported agent version for your account is "3.2.0". Please update to a newer version with ngrok update, by downloading from https://ngrok.com/download, or by updating your SDK version. Paid accounts are currently excluded from minimum agent version requirements. To begin handling traffic immediately without updating your agent, upgrade to a paid plan: https://dashboard.ngrok.com/billing/subscription.\r\n\r\nERR_NGROK_121\r\n.

Please let me know if there is any temprory fix
I have tried updating the ngrok version in the pip packge