Skip to main content
POST
CreateAutomation

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.

Body

application/json

The CreateAutomationRequest message.

annotations
object

Bounded key/value metadata bag for IaC marking and customer tags. See .rfcs/object-annotations.md §2. Limits: ≤16 entries; keys 1–128 chars matching ^[A-Za-z][A-Za-z0-9._/-]{0,127}$; values 0–256 chars matching URL-safe ASCII; total serialized ≤4096 bytes. Keys starting with c1/ are reserved for server-managed use and rejected on write.

Well-known keys: managed_by, iac_workspace, iac_resource_address, iac_tool_version.

appId
string | null

the app id this workflow_template belongs to

automationSteps
Automation Step · object[] | null

Ordered list of steps that the automation executes.

circuitBreakerMax
integer<uint32> | null

Circuit breaker rate cap. See Automation.circuit_breaker_max for semantics.

circuitBreakerPeriod
enum<string> | null

The circuitBreakerPeriod field.

Available options:
CIRCUIT_BREAKER_PERIOD_UNSPECIFIED,
CIRCUIT_BREAKER_PERIOD_HOUR,
CIRCUIT_BREAKER_PERIOD_DAY,
CIRCUIT_BREAKER_PERIOD_WEEK,
CIRCUIT_BREAKER_PERIOD_MONTH
context
Automation Context · object | null

The AutomationContext message.

description
string | null

Optional description explaining the automation's purpose.

displayName
string | null

Human-readable name for the automation.

draftAutomationSteps
Automation Step · object[] | null

Steps saved as a draft that have not yet been published.

draftTriggers
Automation Trigger · object[] | null

Triggers saved as a draft that have not yet been published.

enabled
boolean | null

Whether the automation is active and eligible for execution.

isDraft
boolean | null

Whether this automation is in draft mode. Draft automations are not eligible for trigger-based execution.

triggers
Automation Trigger · object[] | null

Triggers that determine when the automation runs.

Response

200 - application/json

Successful response

The CreateAutomationResponse message.

automation
Automation · object | null

The Automation message.

This message contains a oneof named disabled_reason. Only a single field of the following list may be set at a time:

  • circuitBreaker
webhookCapabilityUrl
string | null

One-time absolute webhook URL for capability URL authentication, shown once at creation time. Contains the full URL including the embedded token (e.g. https://tenant.conductorone.com/api/v1/webhooks/incoming/{id}/t/{token}). Populated only when the webhook trigger uses capability URL authentication.

webhookHmacSecret
string | null

One-time HMAC shared secret, shown once at creation time. Populated only when the webhook trigger uses HMAC authentication.