Skip to main content

Endpoints


List Endpoints

List all active endpoints on the account

Request

GET /endpoints

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/endpoints

Response

Returns a 200 response on success

Example Response

{
"endpoints": [
{
"id": "ep_2TMGIKmMaI1zwU7r1tOAI4Gghby",
"created_at": "2023-07-31T23:17:34Z",
"updated_at": "2023-07-31T23:17:34Z",
"public_url": "tls://endpoint-example.com",
"proto": "tls",
"hostport": "endpoint-example.com:443",
"type": "edge",
"domain": {
"id": "rd_2TMGI9Jlxc0L7mmJD6YgbEE7MKr",
"uri": "https://api.ngrok.com/reserved_domains/rd_2TMGI9Jlxc0L7mmJD6YgbEE7MKr"
},
"edge": {
"id": "edgtls_2TMGIEAvsu9Eg9xQVO6zgxZUAzM",
"uri": "https://api.ngrok.com/edges/tls/edgtls_2TMGIEAvsu9Eg9xQVO6zgxZUAzM"
}
},
{
"id": "ep_2TMGIKA81pzMxYkFQdWlCqyGm0S",
"created_at": "2023-07-31T23:17:34Z",
"updated_at": "2023-07-31T23:17:34Z",
"public_url": "https://58bb38c7dcb6.ngrok.paid",
"proto": "https",
"hostport": "58bb38c7dcb6.ngrok.paid:443",
"type": "ephemeral",
"tunnel": {
"id": "tn_2TMGIKA81pzMxYkFQdWlCqyGm0S",
"uri": "https://api.ngrok.com/tunnels/tn_2TMGIKA81pzMxYkFQdWlCqyGm0S"
}
}
],
"uri": "https://api.ngrok.com/endpoints",
"next_page_uri": null
}

Fields

   
endpointsEndpointthe list of all active endpoints on this account
uristringURI of the endpoints list API resource
next_page_uristringURI of the next page, or null if there is no next page

Endpoint fields

   
idstringunique endpoint resource identifier
regionstringidentifier of the region this endpoint belongs to
created_atstringtimestamp when the endpoint was created in RFC 3339 format
updated_atstringtimestamp when the endpoint was updated in RFC 3339 format
public_urlstringURL of the hostport served by this endpoint
protostringprotocol served by this endpoint. one of http, https, tcp, or tls
hostportstringhostport served by this endpoint (hostname:port)
typestringwhether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge)
metadatastringuser-supplied metadata of the associated tunnel or edge object
domainRefthe domain reserved for this endpoint
tcp_addrRefthe address reserved for this endpoint
tunnelRefthe tunnel serving requests to this endpoint, if this is an ephemeral endpoint
edgeRefthe edge serving requests to this endpoint, if this is an edge endpoint

Ref fields

   
idstringa resource identifier
uristringa uri for locating a resource

Get Endpoint

Get the status of an endpoint by ID

Request

GET /endpoints/{id}

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/endpoints/ep_2TMGIKmMaI1zwU7r1tOAI4Gghby

Response

Returns a 200 response on success

Example Response

{
"id": "ep_2TMGIKmMaI1zwU7r1tOAI4Gghby",
"created_at": "2023-07-31T23:17:34Z",
"updated_at": "2023-07-31T23:17:34Z",
"public_url": "tls://endpoint-example.com",
"proto": "tls",
"hostport": "endpoint-example.com:443",
"type": "edge",
"domain": {
"id": "rd_2TMGI9Jlxc0L7mmJD6YgbEE7MKr",
"uri": "https://api.ngrok.com/reserved_domains/rd_2TMGI9Jlxc0L7mmJD6YgbEE7MKr"
},
"edge": {
"id": "edgtls_2TMGIEAvsu9Eg9xQVO6zgxZUAzM",
"uri": "https://api.ngrok.com/edges/tls/edgtls_2TMGIEAvsu9Eg9xQVO6zgxZUAzM"
}
}

Fields

   
idstringunique endpoint resource identifier
regionstringidentifier of the region this endpoint belongs to
created_atstringtimestamp when the endpoint was created in RFC 3339 format
updated_atstringtimestamp when the endpoint was updated in RFC 3339 format
public_urlstringURL of the hostport served by this endpoint
protostringprotocol served by this endpoint. one of http, https, tcp, or tls
hostportstringhostport served by this endpoint (hostname:port)
typestringwhether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge)
metadatastringuser-supplied metadata of the associated tunnel or edge object
domainRefthe domain reserved for this endpoint
tcp_addrRefthe address reserved for this endpoint
tunnelRefthe tunnel serving requests to this endpoint, if this is an ephemeral endpoint
edgeRefthe edge serving requests to this endpoint, if this is an edge endpoint

Ref fields

   
idstringa resource identifier
uristringa uri for locating a resource