List

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>"
}

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

limit

string

ids

array

urls

array

Response

200 - application/json

List all active endpoints on the account

endpoints

object[]

the list of all active endpoints on this account

Show child attributes

endpoints.id

string

unique endpoint resource identifier

endpoints.region

string

identifier of the region this endpoint belongs to

endpoints.created_at

string

timestamp when the endpoint was created in RFC 3339 format

endpoints.updated_at

string

timestamp when the endpoint was updated in RFC 3339 format

endpoints.public_url

string

URL of the hostport served by this endpoint

endpoints.proto

string

protocol served by this endpoint. one of http, https, tcp, or tls

endpoints.scheme

string

n/a

endpoints.hostport

string

hostport served by this endpoint (hostname:port) -> soon to be deprecated

endpoints.host

string

n/a

endpoints.port

integer

n/a

endpoints.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)

endpoints.metadata

string

user-supplied metadata of the associated tunnel or edge object

endpoints.description

string

user-supplied description of the associated tunnel

endpoints.domain

object

the domain reserved for this endpoint

Show child attributes

endpoints.domain.id

string

a resource identifier

endpoints.domain.uri

string

a uri for locating a resource

endpoints.tcp_addr

object

the address reserved for this endpoint

Show child attributes

endpoints.tcp_addr.id

string

a resource identifier

endpoints.tcp_addr.uri

string

a uri for locating a resource

endpoints.tunnel

object

the tunnel serving requests to this endpoint, if this is an ephemeral endpoint

Show child attributes

endpoints.tunnel.id

string

a resource identifier

endpoints.tunnel.uri

string

a uri for locating a resource

endpoints.edge

object

the edge serving requests to this endpoint, if this is an edge endpoint

Show child attributes

endpoints.edge.id

string

a resource identifier

endpoints.edge.uri

string

a uri for locating a resource

endpoints.upstream_url

string

the local address the tunnel forwards to

endpoints.upstream_protocol

string

the protocol the agent uses to forward with

endpoints.url

string

the url of the endpoint

endpoints.principal

object

The ID of the owner (bot or user) that owns this endpoint

Show child attributes

endpoints.principal.id

string

a resource identifier

endpoints.principal.uri

string

a uri for locating a resource

endpoints.traffic_policy

string

The traffic policy attached to this endpoint

endpoints.bindings

string[]

the bindings associated with this endpoint

endpoints.tunnel_session

object

The tunnel session of the agent for this endpoint

Show child attributes

endpoints.tunnel_session.id

string

a resource identifier

endpoints.tunnel_session.uri

string

a uri for locating a resource

endpoints.uri

string

URI of the Cloud Endpoint API resource

endpoints.name

string

user supplied name for the endpoint

endpoints.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

API Filtering Create

Universal Gateway

Traffic Policy

Secure Tunnels

Observability

IAM

SSH Certificates

Partners

Vaults & Secrets

Deprecated

Authorizations

Headers

Query Parameters

Response