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

ClearAutomationCircuitBreaker

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Automation.ClearAutomationCircuitBreaker(ctx, operations.C1APIAutomationsV1AutomationServiceClearAutomationCircuitBreakerRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ClearAutomationCircuitBreakerResponse != nil {
        // handle response
    }
}

200

{
  "bulkActionId": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required

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

Body

application/json

The ClearAutomationCircuitBreakerRequest message.

decision · enum<string> | null

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.

Available options: PAUSED_EXECUTION_DECISION_UNSPECIFIED, PAUSED_EXECUTION_DECISION_RUN, PAUSED_EXECUTION_DECISION_CANCEL

reason · string | null

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

Response

200 - application/json

Successful response

The ClearAutomationCircuitBreakerResponse message.

bulkActionId · string | null

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.