uip resource buckets

Manage Orchestrator buckets — storage containers for files used by automations. Bucket operations are folder-scoped. For per-file operations inside a bucket, see uip resource bucket-files.

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

Synopsis

uip resource buckets list          [--folder-path <path> | --folder-key <key>] [-n <name>] [--exclude-folder-path <path>] [--exclude-folder-key <key>]
uip resource buckets get           <bucket-key>
uip resource buckets create        <name> --folder-path <path> | --folder-key <key> [options below]
uip resource buckets update        <bucket-key> [options as for create]
uip resource buckets delete        <bucket-key>
uip resource buckets share         <bucket-key> --folder-path <path> | --folder-key <key>
uip resource buckets unshare       <bucket-key> --folder-path <path> | --folder-key <key>
uip resource buckets list-folders  <bucket-key>

list

List buckets. Without --folder-*, lists across all accessible folders (with optional --exclude-folder-path / --exclude-folder-key). With a folder, lists buckets inside that folder. Filter: -n, --name <name>.

uip resource buckets list --folder-path Shared

get

Get bucket details by key.

uip resource buckets get a1b2c3d4-0000-0000-0000-000000000001

create

Create a bucket in a folder. Requires <name>. Optional flags include --identifier <guid> (auto-generated if omitted), -d, --description, --storage-provider <Azure|Amazon|Minio|S3Compatible|FileSystem> (omit for Orchestrator built-in), --storage-parameters, --storage-container, --credential-store-key (required for Azure and Amazon), --external-name, --password, --options <None|ReadOnly|AuditReadAccess|AccessDataThroughOrchestrator>, --tags <json>.

uip resource buckets create invoices --folder-path Shared \
  --description "Invoice attachments"

update

Update bucket properties by key. Same flags as create (all optional).

delete

Delete a bucket by key.

share / unshare

Add or remove the bucket from a folder.

list-folders

List the folders a bucket is shared with.

See also

• uip resource bucket-files — per-file operations inside a bucket.
• uip resource overview — shared conventions for every uip resource verb.
• How-to: manage Orchestrator assets and queues — bucket-file upload / download patterns.