v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB

AbuseReports2

AgentIngresses5

APIKeys5

ApplicationSessions3

ApplicationUsers3

BotUsers5

CertificateAuthorities5

Credentials5

EdgeRouteBackendModule3

EdgeRouteCircuitBreakerModule3

EdgeRouteCompressionModule3

EdgeRouteIPRestrictionModule3

EdgeRouteOAuthModule3

EdgeRouteOIDCModule3

EdgeRouteRequestHeadersModule3

EdgeRouteResponseHeadersModule3

EdgeRouteSAMLModule3

EdgeRouteTrafficPolicyModule3

EdgeRouteUserAgentFilterModule3

EdgeRouteWebhookVerificationModule3

EdgeRouteWebsocketTCPConverterModule3

EdgesHTTPS5

EdgesHTTPSRoutes4

EdgesTCP5

EdgesTLS5

Endpoints5

EventDestinations5

EventSources5

EventSubscriptions5

FailoverBackends5

HTTPResponseBackends5

HTTPSEdgeMutualTLSModule3

HTTPSEdgeTLSTerminationModule3

IPPolicies5

IPPolicyRules5

IPRestrictions5

ReservedAddrs5

ReservedDomains7

Secrets5

ServiceUsers5

SSHCertificateAuthorities5

SSHCredentials5

SSHHostCertificates5

SSHUserCertificates5

StaticBackends5

TCPEdgeBackendModule3

TCPEdgeIPRestrictionModule3

TCPEdgeTrafficPolicyModule3

TLSCertificates5

TLSEdgeBackendModule3

TLSEdgeIPRestrictionModule3

TLSEdgeMutualTLSModule3

TLSEdgeTLSTerminationModule3

TLSEdgeTrafficPolicyModule3

TunnelGroupBackends5

Tunnels2

TunnelSessions5

Vaults6

WeightedBackends5

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

pooling_enabledboolean

n/a

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

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