UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip rpa list-instances

Syntax and options for `uip rpa list-instances` (alias uip rpa instances list), which lists running UiPath Studio instances and their status.

uip rpa list-instances lists running UiPath Studio instances and reports each one's status. Also reachable as uip rpa instances list — both names invoke the same command; instances list is the canonical, visible form per the current CLI naming convention, and list-instances is kept as a hidden top-level alias for compatibility.

Synopsis

uip rpa list-instances
uip rpa instances list
uip rpa list-instances
uip rpa instances list

No options on either form.

Example

uip rpa list-instances
uip rpa list-instances

Data shape (--output json)

{
  "Code": "InstanceList",
  "Data": [
    { "ProcessId": 12345, "ProjectDirectory": "/work/MyProject", "ExecutionStatus": "Idle" }
  ]
}
{
  "Code": "InstanceList",
  "Data": [
    { "ProcessId": 12345, "ProjectDirectory": "/work/MyProject", "ExecutionStatus": "Idle" }
  ]
}

ProjectDirectory is "(none)" when the instance has no project open. ExecutionStatus is "(unknown)" when it couldn't be read. An Error field is added per-item when that instance's status read itself failed. When no instances are running, the command prints a plain No running Studio instances found. message instead of an empty Data array.

See also

  • Synopsis
  • Example
  • Data shape (--output json)
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated