uip is connections

Syntax and options for `uip is connections`, which manages OAuth sessions between a UiPath tenant and external connectors.

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 run and activities use at runtime. The verbs cover discovery (list, export), authentication (create, edit), health checks (ping), and management (rename, set-default, update-polling-interval, base-url, delete). 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]

Verbs

Verb	Purpose
list	List connections, optionally scoped to a connector, folder, or BYOA status.
export	Export every connection (across all folders) for audit.
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.
rename	Rename an existing connection.
set-default	Mark a connection as the default for its connector.
update-polling-interval	Change a connection's polling interval.
base-url	Get the API base URL a connection resolves to.
delete	Delete a connection (destructive, requires -y/--yes).

uip is connections list

List connections in the tenant's default scope. Optional positional <connector-key> filters the result to one connector; flags can scope by folder, connection ID, or BYOA status.

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	—	Search connections in a specific folder. Must be a UUID. Mutually exclusive with --all-folders.
—	--connection-id	id	—	Filter to a specific connection ID.
—	--byoa	flag	off	Filter to BYOA (Bring Your Own Account) connections only.
—	--all-folders	flag	off	Search connections across all folders instead of the default scope. Mutually exclusive with --folder-key — combining them fails with a Failure before any request is made.
—	--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 --byoa --all-folders

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": "[e-mail]",
      "IsDefault": "No",
      "ByoaConnection": "No",
      "ElementInstanceId": 123456,
      "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 export

Export every connection across all folders, for audit purposes. Takes no arguments or connection-scoping options — it always covers the full tenant.

Arguments

None.

Example

uip is connections export

Data shape (--output json)

{
  "Code": "ConnectionExport",
  "Data": {
    "a1b2c3d4-0000-0000-0000-000000000001": {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Zoho Desk - Prod",
      "state": "Enabled"
    }
  }
}

Data is a map keyed by connection ID — not an array. When the tenant has no connections at all, the response is instead {"Code": "Message", "Data": {"Message": "No connections found to export."}}.

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
—	--no-browser	flag	off	Don't auto-open the browser; print the URL for manual navigation.
—	--no-wait	flag	off	Return the pending authorization details (SessionId, AuthUrl) immediately instead of polling for completion.

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

# Return immediately with the pending session instead of polling
uip is connections create uipath-zoho-desk --no-browser --no-wait

Data shape (--output json)

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "[e-mail]",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

With --no-wait, the response is instead the pending authorization:

{
  "Code": "ConnectionAuthorizationPending",
  "Data": {
    "Status": "AuthorizationPending",
    "SessionId": "s1000000-0000-0000-0000-000000000001",
    "AuthUrl": "https://.../authorize?...",
    "Instructions": "Open AuthUrl to authorize the connection, then run 'uip is connections list' or 'uip is connections ping <connection-id>' to verify the connection.",
    "Connector": "uipath-zoho-desk"
  }
}

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
—	--force-refresh	flag	off	Force a live connection status refresh instead of using a cached status.

Examples

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

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

Data shape (--output json)

{
  "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
—	--no-browser	flag	off	Don't auto-open the browser; print the URL for manual navigation.
—	--no-wait	flag	off	Return the pending authorization details immediately instead of polling for completion.

Examples

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"
  }
}

With --no-wait, the response is the same pending-authorization shape shown under create above.

uip is connections rename

Rename an existing connection.

Arguments

Name	Required	Purpose
<connection-id>	yes	Connection ID to rename.

Options

Short	Long	Value	Default	Description
—	--name	text	—	Required. New connection name. Cannot be empty.

Example

uip is connections rename a1b2c3d4-0000-0000-0000-000000000001 \
    --name "Zoho Desk - Production"

Data shape (--output json)

{
  "Code": "ConnectionRenamed",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Zoho Desk - Production"
  }
}

A conflicting or invalid new name fails with Failure, pointing at connections list to verify the ID and pick a non-conflicting name.

uip is connections set-default

Mark a connection as the default connection for its connector — the one picked automatically where a connector allows only one active default.

Arguments

Name	Required	Purpose
<connection-id>	yes	Connection ID to set as default.

Example

uip is connections set-default a1b2c3d4-0000-0000-0000-000000000001

Data shape (--output json)

{
  "Code": "ConnectionSetDefault",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection set as default."
  }
}

uip is connections update-polling-interval

Change how often the connection polls for events (used by event-driven activities/triggers built on this connection).

Arguments

Name	Required	Purpose
<connection-id>	yes	Connection ID to update.

Options

Short	Long	Value	Default	Description
—	--polling-interval	minutes	—	Required. New polling interval, in minutes. Must be a positive integer.

Example

uip is connections update-polling-interval a1b2c3d4-0000-0000-0000-000000000001 \
    --polling-interval 15

Data shape (--output json)

{
  "Code": "ConnectionPollingIntervalUpdated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "PollingIntervalInMinutes": 15
  }
}

A non-integer or non-positive value fails client-side before any request is sent. If the connection doesn't support a configurable polling interval, the server rejects the request — verify the connection ID with connections list --refresh and confirm the connector supports polling.

uip is connections base-url

Get the API base URL a connection currently resolves to — useful when building a raw HTTP request against the connector's underlying API.

Arguments

Name	Required	Purpose
<connection-id>	yes	Connection ID to inspect.

Example

uip is connections base-url a1b2c3d4-0000-0000-0000-000000000001

Data shape (--output json)

{
  "Code": "ConnectionBaseUrl",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "BaseUrl": "https://api.example.com/v2"
  }
}

Failure points at connections list to verify the ID and confirm the connection is Enabled.

uip is connections delete

Delete a connection. This is irreversible — the CLI never prompts.

Arguments

Name	Required	Purpose
<connection-id>	yes	Connection ID to delete.

Options

Short	Long	Value	Default	Description
-y	--yes	flag	—	Required. Confirms this irreversible operation.

Example

uip is connections delete a1b2c3d4-0000-0000-0000-000000000001 --yes

Data shape (--output json)

{
  "Code": "ConnectionDeleted",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection deleted successfully."
  }
}

An unknown connection ID fails with Failure pointing at connections list --all-folders to find it.

Related

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

See also

• Integration Service tool overview
• Global options
• Exit codes