Skip to content

Cloud automations

Create automations that run an agent on a schedule or a webhook, and read their firings.

These commands follow the output contract: JSON when stdout is not a terminal, failures as JSON on stderr, and exit codes 0 to 6.

run fires an automation now. delete and rotate-secret need --yes.

Generated from dexto 2.0.0-beta.0.

dexto cloud automations list

List the project's automations.

dexto cloud automations list
Option What it does
--after <after> Start after this cursor, from the previous page.
--limit <limit> How many to return.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations get

Show an automation.

dexto cloud automations get <automation_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations create

Create an automation from flags (--name --agent --message and one of --cron, --at, --webhook) or --file.

dexto cloud automations create
Option What it does
--data <data> The request body as JSON.
--file <file> Read the request body from a JSON file, or - for stdin.
--agent <agent> The agent each firing runs.
--at <at> Fire once at this ISO 8601 time with an offset.
--cron <cron> Fire on this five-field cron expression.
--message <message> The message each firing sends the agent.
--name <name> Display name.
--session <session> Send every firing to this session instead of a new one each time.
--timezone <timezone> The IANA timezone the cron is read in (default UTC).
--webhook Fire on each signed request to a webhook URL.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations update

Change an automation's name or message, or any field with --file.

dexto cloud automations update <automation_id>
Option What it does
--data <data> The request body as JSON.
--file <file> Read the request body from a JSON file, or - for stdin.
--message <message> The message each firing sends.
--name <name> Display name.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations pause

Stop an automation's schedule.

dexto cloud automations pause <automation_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations resume

Resume a paused automation.

dexto cloud automations resume <automation_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations run

Fire an automation now, whatever its status.

dexto cloud automations run <automation_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations delete

Delete an automation and its firing history.

dexto cloud automations delete <automation_id>
Option What it does
--yes Go ahead without being asked. Pass it only once your person has agreed.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations firings

List an automation's firings, newest first, with each run's status.

dexto cloud automations firings <automation_id>
Option What it does
--after <after> Start after this cursor, from the previous page.
--limit <limit> How many to return.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud automations rotate-secret

Replace a webhook's signing secret; the old one stops at once.

dexto cloud automations rotate-secret <automation_id>
Option What it does
--yes Go ahead without being asked. Pass it only once your person has agreed.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

Shared options

Commands on this page that follow the JSON contract take these.

Option What it does
--api-base-url <api-base-url> The API origin (default https://api.dexto.ai, or DEXTO_API_BASE_URL).
--api-key <api-key> Use this key instead of DEXTO_API_KEY or the saved sign-in.
--profile <profile> The saved sign-in to use for this run (or DEXTO_PROFILE); see dexto accounts list.
--project <project> The Cloud project to act in when you're signed in (or DEXTO_CLOUD_PROJECT).
--json Print JSON, failures included (on stderr). The default when stdout isn't a terminal.
--table Print tables for people even when stdout isn't a terminal.