NGngrok
EdgesHTTPS

Update

Changed on

Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

patch/edges/https/{id}

Request

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

Path parameters

idstring required

unique identifier of this edge

Headers

ngrok-versioninteger required

Request body

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.

hostportsstring[]

hostports served by this edge

Response

Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

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 configuration was created, RFC 3339 format

uristring

URI of the edge API resource

hostportsstring[]

hostports served by this edge

Changes