Client¶

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
ng = ngrok.Client("<API KEY>")

# list all ip policies
for policy in ng.ip_policies.list():
    print(policy)

# create an ngrok agent authtoken
cred = ng.credentials.create()
print(cred)

class ngrok.Client(api_key, base_url='https://api.ngrok.com')[source]¶

property abuse_reports¶

Return type: AbuseReportsClient

property api_keys¶

Return type: APIKeysClient

property certificate_authorities¶

Return type: CertificateAuthoritiesClient

property credentials¶

Return type: CredentialsClient

property endpoint_configurations¶

Endpoint Configuration managementAn Endpoint Configuration <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*