cURL
curl --request GET \ --url https://api.ngrok.com/endpoints \ --header 'Authorization: Bearer <token>' \ --header 'ngrok-version: <ngrok-version>'
{ "endpoints": [ { "id": "<string>", "region": "<string>", "created_at": "<string>", "updated_at": "<string>", "public_url": "<string>", "proto": "<string>", "scheme": "<string>", "hostport": "<string>", "host": "<string>", "port": 123, "type": "<string>", "metadata": "<string>", "description": "<string>", "domain": { "id": "<string>", "uri": "<string>" }, "tcp_addr": { "id": "<string>", "uri": "<string>" }, "tunnel": { "id": "<string>", "uri": "<string>" }, "edge": { "id": "<string>", "uri": "<string>" }, "upstream_url": "<string>", "upstream_protocol": "<string>", "url": "<string>", "principal": { "id": "<string>", "uri": "<string>" }, "traffic_policy": "<string>", "bindings": [ "<string>" ], "tunnel_session": { "id": "<string>", "uri": "<string>" }, "uri": "<string>", "name": "<string>", "pooling_enabled": true } ], "uri": "<string>", "next_page_uri": "<string>" }
List all active endpoints on the account
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
the list of all active endpoints on this account
Show child attributes
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
Was this page helpful?