COconductorone
Automations

Clear Automation Circuit Breaker

Changed on

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

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/automations/{id}/circuit_breaker/clear
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

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