---
title: "Replace"
method: PUT
path: "/edges/https/{edge_id}/routes/{id}/circuit_breaker"
tags: ["EdgeRouteCircuitBreakerModule"]
---

# Replace

`PUT /edges/https/{edge_id}/routes/{id}/circuit_breaker`

## Path parameters

- `edge_id` string, required
- `id` string, required

## Headers

- `ngrok-version` integer, required

## Request body

- EdgeRouteCircuitBreakerReplace
  - `edge_id` string — n/a
  - `id` string — n/a
  - `module` EndpointCircuitBreaker
    - `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

## Response `200`

n/a

- EndpointCircuitBreaker
  - `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

## Other responses

- `4XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.
- `5XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.

---

[API](https://skmtc.dev/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.dev/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/revisions/c697539ac350/schema)