NGngrok
Endpoints

Get

Changed on

Get the status of an endpoint by ID

get/endpoints/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/endpoints/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get the status of an endpoint by ID

idstring

unique endpoint resource identifier

regionstring

identifier of the region this endpoint belongs to

created_atstring

timestamp when the endpoint was created in RFC 3339 format

updated_atstring

timestamp when the endpoint was updated in RFC 3339 format

public_urlstring

deprecated [replaced by URL]: URL of the hostport served by this endpoint

protostring

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

schemestring

n/a

hostportstring

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

hoststring

n/a

portinteger

n/a

typestring

whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a Cloud Endpoint)

metadatastring

user-supplied metadata of the associated tunnel or edge object

descriptionstring

user-supplied description of the associated tunnel

upstream_urlstring

the local address the tunnel forwards to

upstream_protocolstring

the protocol the agent uses to forward with

urlstring

the url of the endpoint

traffic_policystring

The Traffic Policy attached to this endpoint

bindingsstring[]

the bindings associated with this endpoint

uristring

URI of the Cloud Endpoint API resource

namestring

user supplied name for the endpoint

pooling_enabledboolean

whether the endpoint allows pooling

Changes

  • e4e00fe7c606Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1039536f4bfdRevision changes
    • info

      added the optional property to the response with the status