Skip to main content
GET
/
endpoints
/
{id}
Get
curl --request GET \
  --url https://api.ngrok.com/endpoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "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
}

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

Path Parameters

​
id
string
required

a resource identifier

Response

200 - application/json

Get the status of an endpoint by ID

​
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

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
object

the domain reserved for this endpoint

​
tcp_addr
object

the address reserved for this endpoint

​
tunnel
object

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

​
edge
object

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

​
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
object

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

​
traffic_policy
string

The traffic policy attached to this endpoint

​
bindings
string[]

the bindings associated with this endpoint

​
tunnel_session
object

The tunnel session of the agent for this endpoint

​
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