- Getting started
- Data security and compliance
- Organizations
- Authentication and security
- Licensing
- About licensing
- Unified Pricing: Licensing plan framework
- Activating your Enterprise license
- Migrate from Test Suite to Test Cloud
- License migration
- Assigning licenses to tenants
- Assigning user licenses
- Deallocating user licenses
- Monitoring license allocation
- License overallocation
- Licensing notifications
- User license management
- Tenants and services
- Accounts and roles
- AI Trust Layer
- External applications
- Notifications
- Logging
- Data Export
- Testing in your organization
- Troubleshooting
- Migrating to Test Cloud
Relay integration scenarios in Test Cloud, covering Integration Service connections, API Workflows, Serverless robots, and supported TCP-based connections.
Relay acts as a connectivity layer between UiPath cloud services and on-premises resources. The sections below describe what each integration enables. Setup steps for each integration live in the respective product guide. Follow the links provided.
With Integration Service
Relay enables Integration Service connections to reach on-premises systems that are not exposed to the public internet, such as internal Jira, SAP, or custom APIs. Once a Relay Group is configured and an endpoint is registered, you can select Private as the connection type when creating a connection in Integration Service.
This also applies to Bring Your Own LLM scenarios where your language model endpoint is hosted on-premises or in a private network. For more details on using Relay with Integration Service, refer to Connections.
Relay supports HTTP and HTTPS connections, plus the TCP-based connections listed below. Database Hub connections and arbitrary TCP passthrough are not supported.
Supported TCP-based connections
Some on-premises systems are not reachable over HTTP. SAP BAPI, for example, uses SAP's RFC protocol over TCP.
Relay reaches these systems through the on-prem executor, a local process that speaks the connector's protocol. Only the connections listed below are supported.
| TCP-based connection | Protocol | Relay requirement |
|---|---|---|
| SAP BAPI | SAP RFC over TCP | Relay client 26.4.3 or later with the on-prem executor enabled |
With API Workflows and Agentic Processes
API Workflows and Agentic Processes can call on-premises APIs through Relay without any changes to your network perimeter. Use the Integration Service connection you created with your on-premises endpoint. This will route the calls to your target systems via Relay.
With Serverless Automation Cloud Robots
Serverless Automation Cloud Robots can call on-premises APIs through Relay by sending requests to the endpoint's Mapped URL, authenticated with the access token the robot runtime injects automatically. No local agent or virtual machine (VM) is required. For the full procedure and a code sample, refer to Calling on-premises APIs via Relay.
Notifications
When a Relay client becomes inactive, UiPath sends an in-app notification through the Notifications panel. Administrators can opt in to receive the same alerts by email from the Notifications settings page.