Skip to main content
GET
/
endpoints
List
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>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Query Parameters

​
before_id
string

Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.

​
limit
string

Constrains the number of results in the dataset. See the API Overview for details.

​
id
array

Filter results by endpoint IDs. Deprecated: use filter instead.

​
url
array

Filter results by endpoint URLs. Deprecated: use filter instead.

​
filter
string

A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Response

200 - application/json

List all active endpoints on the account

​
endpoints
object[]

the list of all active endpoints on this account

​
uri
string

URI of the endpoints list API resource

​
next_page_uri
string

URI of the next page, or null if there is no next page