Sign in

v8

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

Update

Updates an HTTPS Edge Route 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/{edge_id}/routes/{id}

Path parameters

edge_idstring required

unique identifier of this edge

idstring required

unique identifier of this edge route

Headers

ngrok-versioninteger required

Request body

edge_idstring

unique identifier of this edge

idstring

unique identifier of this edge route

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"

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

Updates an HTTPS Edge Route 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.

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.