NGngrok
EdgesHTTPSRoutes

Create

Changed on

Create an HTTPS Edge Route

post/edges/https/{edge_id}/routes

Request

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

Path parameters

edge_idstring required

unique identifier of this edge

Headers

ngrok-versioninteger required

Request body

edge_idstring

unique identifier of this edge

match_typestring required

Type of match to use for this route. Valid values are "exact_path" and "path_prefix".

matchstring required

Route selector: "/blog" or "example.com" or "example.com/blog"

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.

Response

Create an HTTPS Edge Route

edge_idstring

unique identifier of this edge

idstring

unique identifier of this edge route

created_atstring

timestamp when the edge configuration was created, RFC 3339 format

match_typestring

Type of match to use for this route. Valid values are "exact_path" and "path_prefix".

matchstring

Route selector: "/blog" or "example.com" or "example.com/blog"

uristring

URI of the edge API resource

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.

Changes