> ## 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.

# Replace



## OpenAPI

````yaml https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml put /edges/https/{edge_id}/routes/{id}/circuit_breaker
openapi: 3.0.0
info:
  title: ngrok OpenAPI
  version: 1.0.0
servers:
  - url: https://api.ngrok.com
security:
  - authentication: []
paths:
  /edges/https/{edge_id}/routes/{id}/circuit_breaker:
    put:
      tags:
        - EdgeRouteCircuitBreakerModule
      summary: Replace
      operationId: EdgeRouteCircuitBreakerModuleReplace
      parameters:
        - $ref: '#/components/parameters/ngrokVersion'
        - name: edge_id
          in: path
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EdgeRouteCircuitBreakerReplace'
      responses:
        '200':
          description: n/a
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointCircuitBreaker'
components:
  parameters:
    ngrokVersion:
      name: ngrok-version
      in: header
      required: true
      schema:
        type: integer
        default: 2
  schemas:
    EdgeRouteCircuitBreakerReplace:
      type: object
      properties:
        edge_id:
          description: n/a
          type: string
        id:
          description: n/a
          type: string
        module:
          $ref: '#/components/schemas/EndpointCircuitBreaker'
          description: n/a
    EndpointCircuitBreaker:
      type: object
      properties:
        enabled:
          description: >
            `true` if the module will be applied to traffic, `false` to disable.
            default `true` if unspecified
          type: boolean
        tripped_duration:
          description: >
            Integer number of seconds after which the circuit is tripped to wait
            before re-evaluating upstream health
          type: integer
        rolling_window:
          description: >
            Integer number of seconds in the statistical rolling window that
            metrics are retained for.
          type: integer
        num_buckets:
          description: |
            Integer number of buckets into which metrics are retained. Max 128.
          type: integer
        volume_threshold:
          description: >
            Integer number of requests in a rolling window that will trip the
            circuit. Helpful if traffic volume is low.
          type: integer
        error_threshold_percentage:
          description: |
            Error threshold percentage should be between 0 - 1.0, not 0-100.0
          type: number
  securitySchemes:
    authentication:
      type: http
      scheme: bearer

````