- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip or queues
Syntax and options for `uip or queues`, which manages Orchestrator queue containers for transactional work items.
Manage Orchestrator queues — containers for work items that automations process transactionally. Queues are folder-scoped. For per-item operations inside a queue, see uip or queue-items.
For the cross-resource conventions (auth, folder scoping, key types, output envelope), see the uip or overview.
Synopsis
uip or queues list --folder-path <path> | --folder-key <key> | --all-folders [-n, --name <name>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queues get <queue-key> [--all-fields]
uip or queues create <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update <queue-key> [options as for create]
uip or queues delete <queue-key> --yes [-f]
uip or queues get-stats --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders <queue-key> [--all-fields]
uip or queues share <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare <queue-key> --folder-path <path> | --folder-key <key>
uip or queues list --folder-path <path> | --folder-key <key> | --all-folders [-n, --name <name>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queues get <queue-key> [--all-fields]
uip or queues create <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update <queue-key> [options as for create]
uip or queues delete <queue-key> --yes [-f]
uip or queues get-stats --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders <queue-key> [--all-fields]
uip or queues share <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare <queue-key> --folder-path <path> | --folder-key <key>
list
List queues in a folder, or across every accessible folder with --all-folders. Provide exactly one of --folder-path, --folder-key, or --all-folders. Returns the queue name, key (GUID), item counts, and processing stats.
Filter by name with -n, --name <name> (contains-match). --sort-by <field> sorts results (default Id desc). --all-fields returns the full API payload.
uip or queues list --folder-path Shared
uip or queues list --all-folders --name Invoice
uip or queues list --folder-path Shared
uip or queues list --all-folders --name Invoice
get
Get queue details by key. Cross-folder. --all-fields returns the full API payload.
create
Create a queue in a folder. Requires <name>. Flags: -d, --description, --max-retries, --sla-in-minutes <minutes>, --risk-sla-in-minutes <minutes>, --auto-retry / --no-auto-retry (default on), --retry-abandoned-items / --no-retry-abandoned-items, --enforce-unique-reference / --no-enforce-unique-reference, --encrypted.
Retention flags:
| Flag | Default | Description |
|---|---|---|
--retention-action <Delete|Archive|None> | Delete | Action for completed items. Archive requires --retention-bucket. |
--retention-period <days> | 30 | Retention period for completed items. |
--retention-bucket <bucket-key> | — | Storage bucket key (GUID) for archived completed items. Required when --retention-action is Archive. The bucket must be in, or shared to, the queue folder. Get the key from uip or buckets list. |
--stale-retention-action <Delete|Archive|None> | Delete | Action for uncompleted items. Archive requires --stale-retention-bucket. |
--stale-retention-period <days> | 180 | Retention period for uncompleted items. |
--stale-retention-bucket <bucket-key> | — | Storage bucket key (GUID) for archived uncompleted items. Required when --stale-retention-action is Archive. The bucket must be in, or shared to, the queue folder. Get the key from uip or buckets list. |
uip or queues create InvoiceQueue --folder-path Shared \
--max-retries 3 --retention-period 90
# Archive completed items to a storage bucket
uip or queues create InvoiceQueue --folder-path Shared \
--retention-action Archive --retention-bucket b1b2c3d4-0000-0000-0000-000000000001
uip or queues create InvoiceQueue --folder-path Shared \
--max-retries 3 --retention-period 90
# Archive completed items to a storage bucket
uip or queues create InvoiceQueue --folder-path Shared \
--retention-action Archive --retention-bucket b1b2c3d4-0000-0000-0000-000000000001
update
Update queue properties by key. Cross-folder. Only the fields you provide change. Accepts -n, --name <name> to rename the queue, plus the same flags as create, all optional and without defaults.
Archive retention needs a storage bucket. Switching --retention-action or --stale-retention-action to Archive requires --retention-bucket or --stale-retention-bucket unless the queue already archives those items. Omit the bucket flag to keep the current bucket. When the action changes to Delete or None, the bucket is cleared.
delete
Delete a queue by key. Cross-folder. Requires -y, --yes — the CLI never prompts for destructive operations. Add -f, --force to delete a queue that still has items — without it, a non-empty queue is refused; --force deletes the items along with the queue and implies --yes.
uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes
get-stats
Get processing statistics (item counts, exception counts, processing times) for a queue. Unlike every other verb on this page, the queue is identified by a required option, not a positional argument: --key <queue-key>. Optional -n, --name <name> (contains-match, combined with --key), --from <date> / --to <date> (ISO 8601, filter by last-processed date), --all-fields.
uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001
uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001
get-folders, share, unshare
Exit codes
See Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted.
Related commands
uip or queue-items— per-item operations inside a queue.
See also
uip oroverview — shared conventions for everyuip orverb.- How-to: manage Orchestrator assets and queues — bulk patterns for queue items.