uipath-cli

latest

false

UiPath CLI user guide

Last updated May 7, 2026

uip is connections

uip is connections manages the tenant's OAuth sessions against connectors. A connection is the authenticated link between a UiPath tenant folder and an external account; it carries the tokens that resources execute and activities use at runtime. The verbs cover discovery (list), authentication (create, edit), and health checks (ping). Both create and edit open the connector's OAuth URL in a browser and poll the server for completion (5-second interval, 5-minute total timeout).

Synopsis

uip is connections <verb> [options]
uip is connections <verb> [options]

Verbs

Verb	Purpose
`list`	List connections, optionally scoped to a connector or folder.
`create`	Create a new connection through the connector's OAuth flow.
`ping`	Check whether a connection is currently enabled and reachable.
`edit`	Re-authenticate an existing connection through the OAuth flow.

uip is connections list

List connections in the tenant. Optional positional <connector-key> filters the result to one connector; flags can scope by folder or single connection ID.

Arguments

Name	Required	Purpose
`[connector-key]`	no	Connector key to filter by (for example, `uipath-zoho-desk`). Omit to list across all connectors.

Options

Short	Long	Value	Default	Description
—	`--folder-key`	UUID	—	Folder key to filter by. Must be a UUID.
—	`--connection-id`	id	—	Filter to a specific connection ID.
`-t`	`--tenant`	name	session default	Override the tenant.
—	`--refresh`	flag	off	Force re-fetch from the API, ignoring cache.

Examples

uip is connections list

uip is connections list uipath-zoho-desk

uip is connections list uipath-zoho-desk --refresh \
    --output-filter 'Data[].{id:Id, state:State}'
uip is connections list

uip is connections list uipath-zoho-desk

uip is connections list uipath-zoho-desk --refresh \
    --output-filter 'Data[].{id:Id, state:State}'

Data shape (--output json)

{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "IsDefault": "No",
      "Folder": "Shared",
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "Created": "2026-01-10T10:00:00.000Z",
      "Updated": "2026-01-10T10:00:00.000Z"
    }
  ]
}
{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "IsDefault": "No",
      "Folder": "Shared",
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "Created": "2026-01-10T10:00:00.000Z",
      "Updated": "2026-01-10T10:00:00.000Z"
    }
  ]
}

If some connections are disabled, the response carries a Warning field alongside Data. An invalid --folder-key that is not a UUID is rejected upfront.

uip is connections create

Create a new connection through the connector's OAuth flow. The CLI opens the auth URL in your browser (unless you pass --no-browser) and polls the server for completion. Poll interval: 5 seconds. Total timeout: 5 minutes.

Arguments

Name	Required	Purpose
`<connector-key>`	yes	Connector key, for example `uipath-zoho-desk`.

Options

Short	Long	Value	Default	Description
`-t`	`--tenant`	name	session default	Override the tenant.
—	`--no-browser`	flag	off	Don't auto-open the browser; print the URL for manual navigation.

Examples

uip is connections create uipath-zoho-desk

# Headless / CI-friendly — print the URL instead of launching a browser
uip is connections create uipath-zoho-desk --no-browser
uip is connections create uipath-zoho-desk

# Headless / CI-friendly — print the URL instead of launching a browser
uip is connections create uipath-zoho-desk --no-browser

Data shape (--output json)

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}
{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

Failure modes:

User declines or auth fails: Failure with the server's message; exit 1.
Poll timeout (5 minutes): Failure: "Authentication timed out after 5 minutes"; exit 2.
Poll transport failure: Failure; exit 1.
Interrupted/aborted (Ctrl+C): Failure; exit 1.

uip is connections ping

Check whether a connection is currently enabled and reachable.

Arguments

Name	Required	Purpose
`<connection-id>`	yes	Connection ID (UUID) returned by `connections list` or `connections create`.

Options

Short	Long	Value	Default	Description
`-t`	`--tenant`	name	session default	Override the tenant.

Examples

uip is connections ping a1b2c3d4-0000-0000-0000-000000000001
uip is connections ping a1b2c3d4-0000-0000-0000-000000000001

Data shape (--output json)

{
  "Code": "ConnectionPing",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Enabled",
    "Message": "Connection is active."
  }
}
{
  "Code": "ConnectionPing",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Enabled",
    "Message": "Connection is active."
  }
}

A disabled or unreachable connection emits Failure with Instructions: "Run 'uip is connections edit <id>' to re-authenticate.".

uip is connections edit

Re-authenticate an existing connection. Same OAuth flow as create, targeted at an existing connection ID rather than issuing a new one. Same polling contract and exit codes.

Arguments

Name	Required	Purpose
`<connection-id>`	yes	Connection ID to re-authenticate.

Options

Short	Long	Value	Default	Description
`-t`	`--tenant`	name	session default	Override the tenant.
—	`--no-browser`	flag	off	Don't auto-open the browser; print the URL for manual navigation.

Examples

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001 --no-browser
uip is connections edit a1b2c3d4-0000-0000-0000-000000000001

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001 --no-browser

Data shape (--output json)

{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}
{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}

uip is connectors — discover connector keys for create.
uip is resources — execute verbs require --connection-id from a connection here.
uip is activities — list operations the connection can drive.
uip is triggers — event hooks activated through a connection.

Was this page helpful?

PREVIOUSconnectors

NEXTactivities

UiPath CLI user guide

Synopsis​

Verbs​

uip is connections list​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip is connections create​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip is connections ping​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip is connections edit​

Arguments​

Options​

Examples​

Data shape (--output json)​

Related​

See also​

Was this page helpful?

Synopsis

Verbs

uip is connections list

Arguments

Options

Examples

Data shape (--output json)

uip is connections create

Arguments

Options

Examples

Data shape (--output json)

uip is connections ping

Arguments

Options

Examples

Data shape (--output json)

uip is connections edit

Arguments

Options

Examples

Data shape (--output json)

Related

See also