Sign in
Automations

Clear Automation Circuit Breaker

Clear the circuit breaker on an automation that was auto-disabled by the rate cap. Future events flow normally; existing paused executions are not affected (use ResolvePausedAutomationExecutions to run or cancel them).

post/api/v1/automations/{id}/circuit_breaker/clear

Path parameters

idstring required

The unique identifier of the automation whose circuit breaker should be cleared.

Request body

decision'PAUSED_EXECUTION_DECISION_UNSPECIFIED' | 'PAUSED_EXECUTION_DECISION_RUN' | 'PAUSED_EXECUTION_DECISION_CANCEL'

What to do with paused executions. UNSPECIFIED means clear the breaker only (backward-compatible default). RUN or CANCEL creates a bulk action to resolve them asynchronously.

reasonstring

Admin-supplied reason when decision is CANCEL. Up to 1024 bytes.

Response

Successful response

bulkActionIdstring

The bulk action ID if a bulk action was created to resolve paused executions. Empty when decision is UNSPECIFIED or there were no paused executions.

Changes

Changed in 2 of the 34 revisions of this API.4

  • 977d59b116573See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 18b8559fb9d71See the full diff
    • ○

      endpoint added

      endpoint-added