Sign in
Endpoints

Update

Update an Endpoint by ID, currently available only for cloud endpoints

patch/endpoints/{id}

Path parameters

idstring required

unique endpoint resource identifier

Headers

ngrok-versioninteger required

Request body

idstring

unique endpoint resource identifier

urlstring

the url of the endpoint

traffic_policystring

The traffic policy attached to this endpoint

descriptionstring

user-supplied description of the associated tunnel

metadatastring

user-supplied metadata of the associated tunnel or edge object

bindingsstring[]

the bindings associated with this endpoint

Response

Update an Endpoint by ID, currently available only for cloud endpoints

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

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_protostring

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 clep API resource

namestring

user supplied name for the endpoint

Changes