---
title: "List"
method: GET
path: "/endpoints"
tags: ["Endpoints"]
---

# List

`GET /endpoints`

List all active endpoints on the account

## Query parameters

- `before_id` string
- `limit` string
- `filter` string

## Headers

- `ngrok-version` integer, required

## Response `200`

List all active endpoints on the account

- EndpointList
  - `endpoints` Endpoint[] — the list of all active endpoints on this account
    - `id` string — unique endpoint resource identifier
    - `region` string — identifier of the region this endpoint belongs to
    - `created_at` string — timestamp when the endpoint was created in RFC 3339 format
    - `updated_at` string — timestamp when the endpoint was updated in RFC 3339 format
    - `public_url` string — deprecated [replaced by URL]: URL of the hostport served by this endpoint
    - `proto` string — protocol served by this endpoint. one of `http`, `https`, `tcp`, or `tls`
    - `scheme` string — n/a
    - `hostport` string — hostport served by this endpoint (hostname:port) -> soon to be deprecated
    - `host` string — n/a
    - `port` integer — n/a
    - `type` string — whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) or `cloud (represents a cloud endpoint)`
    - `metadata` string — user-supplied metadata of the associated tunnel or edge object
    - `description` string — user-supplied description of the associated tunnel
    - `domain` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `tcp_addr` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `tunnel` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `edge` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `upstream_url` string — the local address the tunnel forwards to
    - `upstream_protocol` string — the protocol the agent uses to forward with
    - `url` string — the url of the endpoint
    - `principal` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `traffic_policy` string — The traffic policy attached to this endpoint
    - `bindings` string[] — the bindings associated with this endpoint
    - `tunnel_session` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `uri` string — URI of the Cloud Endpoint API resource
    - `name` string — user supplied name for the endpoint
    - `pooling_enabled` boolean — whether the endpoint allows pooling
  - `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

## Other responses

- `4XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.
- `5XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.

## Changes

- **2026-08-25** `c697539ac350` — 2 warning
  - deleted the `query` request parameter `id`
  - deleted the `query` request parameter `url`
- **2025-12-16** `602cd080d3a7` — 2 warning, 3 info
  - deleted the `query` request parameter `ids`
  - deleted the `query` request parameter `urls`
  - added the new optional `query` request parameter `filter`
  - added the new optional `query` request parameter `id`
  - …1 more
- **2025-08-14** `eab8e464e330` — 2 info
  - added the new optional `query` request parameter `ids`
  - added the new optional `query` request parameter `urls`
- **2025-05-27** `e4e00fe7c606` — 2 warning, 2 info
  - removed the optional property `endpoints/items/principal_id` from the response with the `200` status
  - removed the optional property `endpoints/items/upstream_proto` from the response with the `200` status
  - added the optional property `endpoints/items/pooling_enabled` to the response with the `200` status
  - added the optional property `endpoints/items/upstream_protocol` to the response with the `200` status
- **2024-10-24** `1039536f4bfd` — 1 info
  - added the optional property `endpoints/items/principal_id` to the response with the `200` status

[Change history](https://skmtc.dev/ngrok/apis/ngrok-openapi/changes/endpoints/get.md)

---

[API](https://skmtc.dev/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.dev/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/revisions/c697539ac350/schema)