mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
eric
4918d2d51f
- Remove test_backends() function that tests deprecated backend APIs - Remove test_tcp_edges() function that tests deprecated TCP edge APIs - Remove test_tls_edges() function that tests deprecated TLS edge APIs - Remove test_https_edges() function that tests deprecated HTTPS edge APIs - Update generated client code to reflect API deprecations These test functions would no longer pass due to the deprecation of edge and backend related APIs. The client library no longer exposes these APIs. Amp-Thread-ID: https://ampcode.com/threads/T-40db5ce4-b00c-48f1-b53a-467c3454aadd Co-authored-by: Amp <amp@ampcode.com>
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")