Sign in
EdgeRouteCircuitBreakerModule

Replace

put/edges/https/{edge_id}/routes/{id}/circuit_breaker

Path parameters

edge_idstring required
idstring required

Headers

ngrok-versioninteger required

Request body

edge_idstring

n/a

idstring

n/a

Response

n/a

enabledboolean

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

tripped_durationinteger

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

rolling_windowinteger

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

num_bucketsinteger

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

volume_thresholdinteger

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

error_threshold_percentagenumber

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

Changes

No recorded changes to this endpoint across all 9 revisions of this API.