mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
ngrok-release-bot
26 lines
575 B
ReStructuredText
26 lines
575 B
ReStructuredText
Client
|
|
=====================================
|
|
|
|
:class:`~ngrok.Client` is the root object of the `ngrok-api` library. Construct
|
|
a Client with an API Key. Then you can access API Services as properties of the
|
|
Client object:
|
|
|
|
::
|
|
|
|
import ngrok
|
|
|
|
# construct the api client
|
|
client = ngrok.Client("<API KEY>")
|
|
|
|
# list all ip policies
|
|
for policy in client.ip_policies.list():
|
|
print(policy)
|
|
|
|
# create an ngrok agent authtoken
|
|
cred = client.credentials.create()
|
|
print(cred)
|
|
|
|
.. automodule:: ngrok
|
|
:members: Client
|
|
:undoc-members: Client
|