Sign in
Automations

Create an automation

Create an automation: either a cron-driven project script (see scripts.create) or a signal investigation bound to a signal definition (see signalDefinitions.create).

post/automations

Request body

projectIdstring uuid

Project to create the automation in. Auto-filled from CLI and SDK context when omitted.

namestring required

Automation name.

descriptionstring nullable

Human-readable description. Required for log-match automations (investigation instructions).

scriptIdstring uuid

Project script to run, by ID. Provide exactly one of scriptId, script, or expressionId.

scriptstring

Project script to run, by name (resolved to scriptId server-side). Provide exactly one of scriptId, script, or expressionId.

expressionIdstring uuid

Log-match expression to bind. Creates a signal automation that investigates matching logs. Mutually exclusive with scriptId and script.

cronExpressionstring

Cron schedule for the automation. Defaults to every minute when omitted.

timezonestring

IANA timezone for cronExpression. Defaults to UTC.

timeoutSecondsinteger

Execution timeout in seconds. Defaults to 60.

enabledboolean

Whether the automation starts enabled. Defaults to true.

Response

OK

Changes

No recorded changes to this endpoint across all 4 revisions of this API.