Skip to main content
GET
/
edges
/
https
/
{edge_id}
/
routes
/
{id}
/
request_headers
Get
curl --request GET \
  --url https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/request_headers \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "enabled": true,
  "add": {},
  "remove": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Path Parameters

​
edge_id
string
required

unique identifier of this edge

​
id
string
required

unique identifier of this edge route

Response

200 - application/json

n/a

​
enabled
boolean

true if the module will be applied to traffic, false to disable. default true if unspecified

​
add
object

a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server

​
remove
string[]

a list of header names that will be removed from the HTTP Request before being sent to the upstream application server