Skip to main content

uip is connectors

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]

Verbs​

VerbPurpose
listList connectors available to the tenant; optionally filter by name or key.
getFetch full details for one connector by key.

uip is connectors list​

List connectors available to the current tenant. Cached per-tenant on disk.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride the tenant selected at auth time.
-f--filtertext—Substring match against connector name or key.
—--refreshflagoffForce 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}'

Data shape (--output json)​

{
  "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​

NameRequiredPurpose
<connector-key>yesConnector key, for example uipath-zoho-desk. Find it with connectors list.

Options​

ShortLongValueDefaultDescription
-t--tenantnamesession defaultOverride 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}'

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

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.

See also​