UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

Last updated May 7, 2026

uip resource triggers

Manage Orchestrator triggers: time (schedule), queue, and API. Time and queue triggers are folder-scoped; API triggers are tenant-scoped. Every verb accepts --type <time|queue|api> (default time).

For the cross-resource conventions (auth, folder scoping, key types, output envelope), see the uip resource overview.

Synopsis

uip resource triggers list     [--type <type>] [--folder-path <path> | --folder-key <key>] [-n <name>] [--enabled | --disabled]
uip resource triggers get      <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers create   --type <type> --name <n> --release-key <k> --runtime-type <r> --job-priority <p> [type-specific flags]
uip resource triggers update   <trigger-key> --type <type> [type-specific flags]
uip resource triggers delete   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers enable   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers disable  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers history  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [-l <n>] [--offset <n>]
uip resource triggers list     [--type <type>] [--folder-path <path> | --folder-key <key>] [-n <name>] [--enabled | --disabled]
uip resource triggers get      <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers create   --type <type> --name <n> --release-key <k> --runtime-type <r> --job-priority <p> [type-specific flags]
uip resource triggers update   <trigger-key> --type <type> [type-specific flags]
uip resource triggers delete   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers enable   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers disable  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>]
uip resource triggers history  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [-l <n>] [--offset <n>]

List triggers. Filters: -n, --name, --enabled, --disabled (mutually exclusive).

uip resource triggers list --type time --folder-path Shared --enabled
uip resource triggers list --type time --folder-path Shared --enabled

Get a trigger by key.

create

Create a trigger. Required flags: --name, --release-key, --runtime-type <Serverless|Unattended|Headless|NonProduction|AgentService>, --job-priority <Low|Normal|High> (default Normal).

Type-specific:

  • time needs --cron (Quartz 6-field format) and optionally --time-zone.
  • queue needs --queue-key (and accepts --items-threshold, --max-jobs, --items-per-job, --activate-on-complete).
  • api needs --slug and --method <Get|Post|Put|Delete> (with optional --calling-mode).

Common: -d, --description, --input-arguments <json>, --calendar-key, --stop-strategy <SoftStop|Kill>, --kill-process-expression, --resume-on-same-context, --run-as-me, repeatable --target "machine=<guid>,user=<guid>,session=<int>", --mapping-mode <dynamic|strict>.

uip resource triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC
uip resource triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC

update

Update by key. Same type-specific flags as create, all optional. Use --no-* counterparts to unset booleans.

delete

Delete a trigger by key.

enable / disable

Toggle a trigger by key. Both take --type, --folder-path / --folder-key.

history

Show the trigger execution history (fire log). Paginated via -l, --limit / --offset. Useful for diagnosing why a trigger did not fire (missing license, no machines, disabled, etc.).

See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated