- 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
Test Cloud admin guide
Relay is available for Unified Pricing: Standard and Enterprise platform plans.
Relay lets UiPath cloud services securely reach on-premises HTTP and HTTPS endpoints inside your network — without a VPN, without opening inbound firewall ports, and without changing your network topology.
When you register an on-premises endpoint under a Relay Group, UiPath generates a private Relay URL for it. Cloud services such as Integration Service and API Workflows use that URL to route requests through the UiPath relay infrastructure to a Relay client running inside your network, which forwards each request to the internal target.
Key concepts
| Term | Description |
|---|---|
| Relay Group | A tenant-level container that groups one or more Relay clients and the on-premises endpoints they expose. Each registered endpoint receives a unique Relay URL. Multiple Relay Groups can coexist in a tenant to cover different network segments. |
| Relay client | A lightweight binary (Windows or Linux) installed on a machine inside your network. It establishes the outbound connection to UiPath relay infrastructure and forwards requests to internal services. |
| Relay URL | A private proxy address generated by UiPath for each registered on-premises endpoint. UiPath cloud services use this URL instead of the actual endpoint address. |
| On-premises endpoint | An endpoint, identified by a hostname (FQDN) or IP address and port, that the Relay client exposes to Test Cloud. |
Relay client versioning and support
The Relay client is a versioned binary that you download and run inside your network. Your installed client version determines which commands, options, and connection capabilities are available to you:
- Your installed client version. New commands and options ship in new client versions. Run
relay version, orrelay describe <id>, to check the version you have installed. There is no automatic upgrade — to move to a newer version, download the binary from the UiPath Customer Portal and runrelay restart <id>from it.
Backward compatibility across versions is not guaranteed: an older client might not work with newer server-side updates. Keep your client up to date.
In this section
| Page | Description |
|---|---|
| Architecture and security | How Relay works, the connectivity flow, high availability, and security model |
| Configuring a Relay group | Create a Relay Group and generate the client configuration in UiPath Administration |
| Deploying the Relay client | Hardware requirements, networking prerequisites, and Relay client installation |
| Using Relay | Integration scenarios with Integration Service, API Workflows, and Agentic Processes |
| Troubleshooting | Common issues, FAQ, and support bundle collection |