NGngrok
EdgesTCP

Get

Changed on

Get a TCP Edge by ID

get/edges/tcp/{id}

Request

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

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get a TCP Edge by ID

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

Changes