v8

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

Create

Create a TCP Edge

post/edges/tcp

Headers

ngrok-versioninteger required

Request body

descriptionstring

human-readable description of what this edge will be used for; optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

hostportsstring[]

hostports served by this edge

Response

Create a TCP Edge

idstring

unique identifier of this edge

descriptionstring

human-readable description of what this edge will be used for; optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

created_atstring

timestamp when the edge was created, RFC 3339 format

uristring

URI of the edge API resource

hostportsstring[]

hostports served by this edge