Relay

Relay in Test Cloud for securely connecting UiPath cloud services to supported on-premises HTTP, HTTPS, and TCP-based endpoints without a VPN or inbound firewall changes.

Relay is available for Unified Pricing: Standard and Enterprise platform plans.

Relay connects UiPath cloud services to systems inside your network. A lightweight Relay client on a machine you control opens an outbound-only connection to UiPath, and cloud services use that connection to reach the HTTP, HTTPS, and supported TCP-based endpoints you register, with no VPN, inbound firewall rule, or network change on your side.

When you register an on-premises endpoint under a Relay Group, UiPath generates a private Relay URL for it. UiPath cloud services 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
On-premises endpoint	A service inside your network, identified by a hostname (FQDN) or IP address and port, that you register for UiPath cloud services to reach through Relay.
Relay client	A lightweight binary that runs inside your network as a Windows or Linux service, or as a container. It opens the outbound connection to UiPath relay infrastructure and forwards requests to internal services.
On-prem executor	A Java process managed by the Relay client for supported TCP-based connections, such as SAP BAPI. It is not required for HTTP or HTTPS endpoints.
Relay Group	What you create with Add Relay in UiPath Administration: a tenant-level container for one or more Relay clients and the on-premises endpoints they expose. Separate Relay Groups can cover different network segments.
Relay URL	A private address that UiPath generates for each registered on-premises endpoint. Only UiPath cloud services can call it, using a relay-scoped token, so you cannot use it from your own applications.

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, or relay 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 run relay restart <id> from it.
• Support status. UiPath Administration reports each Relay client as Up to date, Update available, or Out of support. Relay clients earlier than 26.4.0 are out of support and cannot register with Test Cloud until upgraded.

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	Supported scenarios and UiPath cloud services that use Relay
Troubleshooting	Common issues, FAQ, and support bundle collection