Skip to main content

uip or folders

uip or folders manages Orchestrator folders — the hierarchical containers that scope processes, jobs, assets, queues, and user permissions. Verbs cover listing, creating, moving, editing, and deleting folders, plus a runtimes command that reports machine-runtime allocation inside a folder.

Synopsis​

uip or folders <verb> [options]

Verbs​

VerbPurpose
listList folders. Default: folders the current user can access; with --all, every folder in the tenant.
createCreate a folder, optionally nested under a parent.
getFetch one folder by key or path.
deleteDelete a folder by key or path.
moveRe-parent a folder, or move it to the root.
editUpdate display name and/or description.
runtimesShow runtime allocation (total / connected / available) per runtime type for a folder.

uip or folders list​

List folders. The default view uses GetAllForCurrentUser — folders the caller has access to. With --all, the verb switches to the full Folders endpoint (Standard and Solution folders in the tenant); with --type personal, it switches to the PersonalWorkspaces endpoint. Filtering and sorting flags (--name, --path, --type, --top-level, --order-by) require --all.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.
-a--allflagoffList all folders in the tenant; required to enable the filter and sort flags below.
-n--nametext—Contains-match on display name. Requires --all.
—--pathpath prefix—Filter by folder path prefix (for example, Shared matches Shared and everything below). Requires --all.
—--typeenum—standard, solution, or personal. Requires --all. personal switches to the personal-workspaces endpoint.
—--top-levelflagoffOnly root folders (no parent). Requires --all. Not supported with --type personal.
-l--limitnumber50Page size.
—--offsetnumber0Skip count.
—--order-byfield—OData sort (for example, Name asc). Requires --all.
—--login-validityminutes10Minimum minutes before token expiry that triggers a pre-request refresh.

Examples​

# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal

Data shape (--output json)​

{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}

With --all, items also include FeedType and PermissionModel. With --type personal, the payload is { Key, Name, OwnerName, OwnerKey, LastLogin }.

uip or folders create​

Create a folder, optionally nested under a parent. --parent accepts either a folder GUID or a path (Shared, Production/EU).

Arguments​

NameRequiredPurpose
<name>yesFolder display name.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.
-d--descriptiontext—Folder description.
-p--parentkey or path—Parent folder by GUID or path. Omit for a root folder.
—--feed-typeenumProcessesProcesses, Libraries, FolderHierarchy.
—--permission-modelenumFineGrainedFineGrained or InheritFromTenant.
—--provision-typeenumAutomaticAutomatic or Manual.

Examples​

uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant

Data shape (--output json)​

{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}

uip or folders get​

Fetch one folder by key or path. The positional argument auto-detects: UUID input is treated as a key, anything else as a path.

Arguments​

NameRequiredPurpose
<folder-key-or-path>yesFolder GUID or path.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.

Examples​

uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'

Data shape (--output json)​

{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}

uip or folders delete​

Delete a folder by key or path. Fails if the folder contains entities or user associations — remove or move contents first.

Arguments​

NameRequiredPurpose
<folder-key-or-path>yesFolder GUID or path.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.

Examples​

uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'

Data shape (--output json)​

{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}

uip or folders move​

Move a folder to a new parent, or up to the root. You must provide exactly one of --parent or --root.

Arguments​

NameRequiredPurpose
<folder-key-or-path>yesFolder GUID or path to move.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.
-p--parentkey or path—New parent folder. Required unless --root is set.
—--rootflagoffMove to the top level (no parent).

Examples​

uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'

Data shape (--output json)​

{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}

--root sets TargetParentPath to (root).

uip or folders edit​

Update display name and/or description. At least one of --name or --description must be provided.

Arguments​

NameRequiredPurpose
<folder-key-or-path>yesFolder GUID or path.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.
-n--nametext—New display name.
-d--descriptiontext—New description.

Examples​

uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'

Data shape (--output json)​

{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}

uip or folders runtimes​

List runtime allocation for a folder — for each runtime type, how many slots are total, connected, and available. Useful for checking capacity before starting jobs.

Arguments​

NameRequiredPurpose
<folder-key-or-path>yesFolder GUID or path.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant.

Examples​

uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"

Data shape (--output json)​

{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}

Exit codes​

See Exit codes. No verb-specific overrides.

See also​