UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip or assets

Syntax and options for `uip or assets`, which manages Orchestrator assets (Text, Bool, Integer, Credential, Secret) in a folder.

Manage Orchestrator assets — named configuration values used by automations at runtime (Text, Bool, Integer, Credential, Secret). Most operations are folder-scoped.

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

Synopsis​

uip or assets list             [--folder-path <path> | --folder-key <key> | --all-folders] [-n <name>] [--type <type>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or assets get              <asset-key> [--all-fields]
uip or assets create           <name> <value> --folder-path <path> | --folder-key <key> [--type <type>] [-s <scope>] [-d <desc>] [--has-default] [--tags <list>] [--credential-store-key <guid>]
uip or assets update           <asset-key> [<value>] [flags as for create]
uip or assets delete           <asset-key> --yes
uip or assets get-folders      <asset-key>
uip or assets share            <asset-key> --folder-path <path> | --folder-key <key>
uip or assets unshare          <asset-key> --folder-path <path> | --folder-key <key>
uip or assets get-asset-value  <asset-key> --folder-path <path> | --folder-key <key> [--executor-key <guid>]
uip or assets list             [--folder-path <path> | --folder-key <key> | --all-folders] [-n <name>] [--type <type>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or assets get              <asset-key> [--all-fields]
uip or assets create           <name> <value> --folder-path <path> | --folder-key <key> [--type <type>] [-s <scope>] [-d <desc>] [--has-default] [--tags <list>] [--credential-store-key <guid>]
uip or assets update           <asset-key> [<value>] [flags as for create]
uip or assets delete           <asset-key> --yes
uip or assets get-folders      <asset-key>
uip or assets share            <asset-key> --folder-path <path> | --folder-key <key>
uip or assets unshare          <asset-key> --folder-path <path> | --folder-key <key>
uip or assets get-asset-value  <asset-key> --folder-path <path> | --folder-key <key> [--executor-key <guid>]

list​

List assets. Requires --folder-path, --folder-key, or --all-folders (to list across every accessible folder). Filters: -n, --name <name>, --type <Text|Bool|Integer|Credential|Secret> (case-insensitive). Credential and secret values are omitted from results. --sort-by <field> sorts results (for example, Name asc, Id desc); --all-fields returns the full API response instead of the curated summary.

uip or assets list --folder-path Shared --type Credential
uip or assets list --folder-path Shared --type Credential

get​

Get asset details by key. Cross-folder — no folder needed. Credential/secret values are not returned. --all-fields returns the full API response.

uip or assets get a1b2c3d4-0000-0000-0000-000000000001
uip or assets get a1b2c3d4-0000-0000-0000-000000000001

create​

Create an asset in a folder. Requires <name> and <value>. Flags: --type <Text|Bool|Integer|Credential|Secret> (default Text), -s, --scope <Global|PerRobot> (default Global), -d, --description, --has-default, --tags <comma-list>, --credential-store-key <guid> (required for Credential/Secret). Bool values must be true/false; Integer must be a whole number; Credential uses username:password format (except when backed by a read-only external credential store — then <value> is the external lookup name).

uip or assets create ApiEndpoint "https://api.example.com" \
  --folder-path Shared --type Text
uip or assets create ApiEndpoint "https://api.example.com" \
  --folder-path Shared --type Text

update​

Update an asset by key. Cross-folder. <value> is optional; only provided fields are changed. Same type/scope/tags flags as create.

uip or assets update a1b2c3d4-0000-0000-0000-000000000001 \
  "https://api.new.example.com" --description "Production API"
uip or assets update a1b2c3d4-0000-0000-0000-000000000001 \
  "https://api.new.example.com" --description "Production API"

delete​

Delete an asset by key. Cross-folder. Requires -y, --yes — the CLI never prompts for destructive operations.

uip or assets delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or assets delete a1b2c3d4-0000-0000-0000-000000000010 --yes

get-folders​

List every folder the asset is shared with, plus the total count.

uip or assets get-folders a1b2c3d4-0000-0000-0000-000000000001
uip or assets get-folders a1b2c3d4-0000-0000-0000-000000000001

share / unshare​

Add or remove the asset from a folder. Requires --folder-path or --folder-key.

uip or assets share a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path "Production"
uip or assets unshare a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path "Production"
uip or assets share a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path "Production"
uip or assets unshare a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path "Production"

get-asset-value​

Return the asset's value for the current user (default) or for a given executor (--executor-key <guid>). Requires --folder-path or --folder-key. Credential-type assets served by an external store can only be read via --executor-key; the command surfaces that remediation when it gets a 403.

uip or assets get-asset-value a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path Shared
uip or assets get-asset-value a1b2c3d4-0000-0000-0000-000000000001 \
  --folder-path Shared

Exit codes​

See Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated