Skip to main content

ngrok HTTP API client library

Project description

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")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ngrok_api-0.13.0.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

ngrok_api-0.13.0-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file ngrok_api-0.13.0.tar.gz.

File metadata

  • Download URL: ngrok_api-0.13.0.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for ngrok_api-0.13.0.tar.gz
Algorithm Hash digest
SHA256 511229133c2db27e990c6359f0a7a87898a277e58459a5bf791a8a82026a404b
MD5 c7a679e8c59657b7b3043fcdb8ee0d47
BLAKE2b-256 ba0ae54b138e3ec6e1c4c9856f963dd48c5c539e67ff51e439108c4685e47d7a

See more details on using hashes here.

File details

Details for the file ngrok_api-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: ngrok_api-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for ngrok_api-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46a311bc03d643eafb814685084009afff645404a69caf567e1c873633f14ab7
MD5 fe3d727fe89a047ae129a68657a9724b
BLAKE2b-256 52dd3c41a009b61a268f4e0482f70a6c94a72fb4a9d098ad520677efe339a4e5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page