UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip is

Commands for managing connectors, connections, activities, resources, and triggers in Integration Service using the `uip is` tool.

uip is is the Integration Service tool: it manages the connector platform that brokers OAuth connections to external SaaS and runs CRUD activities against them. The tool is organized around seven resources — connectors (the catalog), connections (OAuth sessions for an account), activities (per-connector operation definitions), resources (connector objects and their data-plane operations), triggers (event-driven connector operations), typecache (the Studio activity catalog, filtered by project type), and webhooks (webhook URLs for webhook-mode triggers). Install it with uip tools install is, or invoke uip is … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. is is the command prefix; the underlying package is @uipath/integrationservice-tool.

Most read commands cache responses per-tenant on disk to keep interactive use responsive; pass --refresh on any cached command to force a fresh fetch.

Resources

Each resource has its own reference page. The verb set on each page matches the commands registered by uip is — run uip is --help to confirm the full surface on your installation.

ResourcePurpose
connectorsThe connector catalog — every integration the tenant can reach.
connectionsTenant-side OAuth credentials/sessions for a connector.
activitiesThe operations a connector exposes (CreateTicket, ListAllRecords, etc.).
resourcesConnector objects (tickets, contacts, files), with describe and runtime run.
triggersEvent hooks (CREATED, UPDATED, DELETED) the connector can fire.
typecacheThe Studio activity catalog, filtered by project type (for example Agent) — a separate source from the connector catalog above.
webhooksThe webhook URL for a connector trigger running in webhook event mode.

Synopsis

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

Always uip is, never uip integration-service. is is the tool's command prefix (see the commandPrefix column in uip tools list).

Common flags

A small set of flags recurs across the resource verbs. They behave the same way wherever they appear:

FlagUsed byPurpose
--refreshcached read verbs (list, describe, get, objects)Force a re-fetch from the API and update the on-disk cache.
--connection-id <id>many verbsScope a request to one connection. Required by every resources run verb; optional on metadata reads, where it lets the server include custom objects/fields.

Verb-specific flags (filters, bodies, query parameters) are documented on each resource page.

Global options and exit codes

All uip is verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract.

See also

  • Resources
  • Synopsis
  • Common flags
  • Global options and exit codes
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated