UiPath Documentation
test-cloud
latest
false
Test Cloud admin guide

Using Relay

Relay connectivity layer in Test Cloud for bridging UiPath cloud services with on-premises resources through Integration Service and API Workflows.

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 — such as internal Jira, SAP, or custom APIs — that are not exposed to the public internet. 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.

Note:

Only HTTP-based connections are supported through Relay. Database Hub connections over Relay are not yet supported.

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.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated