ngrok API client library for Python
This library wraps the ngrok HTTP API to make it easier to consume in Python.
Installation
This library is published on PyPi:
pip install ngrok-api
Support
The best place to get support using this library is through the ngrok Slack Community. If you find any bugs, please contribute by opening a new GitHub issue.
Documentation
A quickstart guide and a full API reference are included in the ngrok python API documentation.
Quickstart
Please consult the documentation for additional examples.
import ngrok
# Construct the API client
client = ngrok.Client("<API KEY>")
# List all online tunnels
for t in client.tunnels.list():
print(t)
# Create an IP policy that allows traffic from some subnets
policy = client.ip_policies.create()
for cidr in ["24.0.0.0/8", "12.0.0.0/8"]:
client.ip_policy_rules.create(cidr=cidr, ip_policy_id=policy.id, action="allow")
3 maintainers
Metadata
3 maintainers
Release files for ngrok-api 0.19.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ngrok_api-0.19.0.tar.gz | 53.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ngrok_api-0.19.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.5 kB
Release files / ngrok_api-0.19.0.tar.gz
| Download URL | ngrok_api-0.19.0.tar.gz |
|---|---|
| Size | 53.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b43074b611f70e1fdc93f15155e79ace86ca4975d6ab51621ed6ea6e30915229
|
|
BLAKE2b-256 checksum How to use checksums |
b54097a2d8d65a669aaed8fcaad3c41ebb2a5d503601b07f01709e321f9ffb92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Release files / ngrok_api-0.19.0-py3-none-any.whl
| Download URL | ngrok_api-0.19.0-py3-none-any.whl |
|---|---|
| Size | 48.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
107a0cd8e8687a60723bbe0965d1ba03d4e1751014cff1e43116d79eab284e20
|
|
BLAKE2b-256 checksum How to use checksums |
93956d17b3d8a3e02f1e06e3477d88205d19c7775e15d759ce04ded7b311bca5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
