Endpoints#
Do not construct this object directly, instead access the
endpoints property of an ngrok.Client object.
- class ngrok.services.EndpointsClient(client)[source]#
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.
- get(id)[source]#
Get the status of an endpoint by ID
- Parameters:
id (
str) – a resource identifier
https://ngrok.com/docs/api#api-endpoints-get
- Return type:
- list(before_id=None, limit=None)[source]#
List all active endpoints on the account
- Parameters:
before_id (
Optional[str,None]) –limit (
Optional[str,None]) –
https://ngrok.com/docs/api#api-endpoints-list
- Return type: