Skip to main content
PUT
Replace

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
id
string
required

Body

application/json
edge_id
string

n/a

id
string

n/a

module
object

n/a

Response

200 - application/json

n/a

enabled
boolean

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

tripped_duration
integer

Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health

rolling_window
integer

Integer number of seconds in the statistical rolling window that metrics are retained for.

num_buckets
integer

Integer number of buckets into which metrics are retained. Max 128.

volume_threshold
integer

Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.

error_threshold_percentage
number

Error threshold percentage should be between 0 - 1.0, not 0-100.0