- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- connectors
- connections
- activities
- resources
- triggers
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
uip is connectors browses the Integration Service connector catalog — every integration the tenant can authenticate against (Salesforce, Slack, Zoho Desk, etc.). It is read-only: list returns the catalog, get returns the full record for one connector by key. Both verbs cache results per-tenant on disk; pass --refresh to force a fresh fetch.
Synopsis
uip is connectors <verb> [options]
uip is connectors <verb> [options]
Verbs
| Verb | Purpose |
|---|---|
list | List connectors available to the tenant; optionally filter by name or key. |
get | Fetch full details for one connector by key. |
uip is connectors list
List connectors available to the current tenant. Cached per-tenant on disk.
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
-t | --tenant | name | session default | Override the tenant selected at auth time. |
-f | --filter | text | — | Substring match against connector name or key. |
| — | --refresh | flag | off | Force re-fetch from the API, ignoring cache. |
Examples
uip is connectors list
uip is connectors list --filter zoho
uip is connectors list --filter slack \
--output-filter 'Data[].{name:Name, key:Key}'
uip is connectors list
uip is connectors list --filter zoho
uip is connectors list --filter slack \
--output-filter 'Data[].{name:Name, key:Key}'
Data shape (--output json)
{
"Code": "ConnectorList",
"Data": [
{
"Id": 492,
"Name": "Zoho Desk",
"Key": "uipath-zoho-desk",
"Vendor": "",
"Active": "No",
"Version": "",
"Stage": "",
"DapCompatible": "No"
}
]
}
{
"Code": "ConnectorList",
"Data": [
{
"Id": 492,
"Name": "Zoho Desk",
"Key": "uipath-zoho-desk",
"Vendor": "",
"Active": "No",
"Version": "",
"Stage": "",
"DapCompatible": "No"
}
]
}
If no connectors match, the command succeeds with Code: "Message" and Data: { "Message": "No connectors found." }.
uip is connectors get
Return the full record for one connector by key.
Arguments
| Name | Required | Purpose |
|---|---|---|
<connector-key> | yes | Connector key, for example uipath-zoho-desk. Find it with connectors list. |
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
-t | --tenant | name | session default | Override the tenant. |
Examples
uip is connectors get uipath-zoho-desk
uip is connectors get uipath-zoho-desk \
--output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'
uip is connectors get uipath-zoho-desk
uip is connectors get uipath-zoho-desk \
--output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'
Data shape (--output json)
{
"Code": "Connector",
"Data": [
{
"Id": 492,
"Name": "Zoho Desk",
"Key": "uipath-zoho-desk",
"Description": "Zoho Desk streamlines customer service...",
"HasEvents": "Yes",
"HasCruds": "No",
"HasMethods": "No",
"DapCompatible": "No",
"Categories": "IT and help desk",
"Tags": "Service desk, Agents, Tickets",
"Tier": "2"
}
]
}
{
"Code": "Connector",
"Data": [
{
"Id": 492,
"Name": "Zoho Desk",
"Key": "uipath-zoho-desk",
"Description": "Zoho Desk streamlines customer service...",
"HasEvents": "Yes",
"HasCruds": "No",
"HasMethods": "No",
"DapCompatible": "No",
"Categories": "IT and help desk",
"Tags": "Service desk, Agents, Tickets",
"Tier": "2"
}
]
}
Full field list (all returned): Id, Name, Key, AppName, Vendor, Description, Active, Version, LifecycleStage, DiscoveryType, DefaultAuth, HasEvents, HasCruds, HasMethods, DapCompatible, MinDapVersion, ActivityPackVersion, ActivityColor, Categories, Tags, DocumentationUrl, Guid, Tier, CreatedAt, UpdatedAt.
Related
uip is connections— create OAuth sessions against the connectors discovered here.uip is activities— list the operations a connector exposes.uip is resources— describe and execute a connector's data-plane objects.uip is triggers— event-driven connector operations.