Sign in

v8

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

Update

Update TunnelGroup backend by ID

patch/backends/tunnel_group/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

descriptionstring

human-readable description of this backend. Optional

metadatastring

arbitrary user-defined machine-readable data of this backend. Optional

labelsobject

labels to watch for tunnels on, e.g. app->foo, dc->bar

Response

Update TunnelGroup backend by ID

idstring

unique identifier for this TunnelGroup backend

uristring

URI of the TunnelGroupBackend API resource

created_atstring

timestamp when the backend was created, RFC 3339 format

descriptionstring

human-readable description of this backend. Optional

metadatastring

arbitrary user-defined machine-readable data of this backend. Optional

labelsobject

labels to watch for tunnels on, e.g. app->foo, dc->bar