Configuring a Relay group

Relay Group configuration steps in Test Cloud for registering on-premises endpoints and generating the configuration used by the Relay client.

A Relay Group holds the on-premises endpoints that UiPath cloud services reach through Relay. Creating one produces the configuration string you use to install the Relay client on a machine inside your network.

Prerequisites

• Organization Administrator or Tenant Administrator role in Automation Cloud. To give other users view-only access, create a custom role with the Relay > Relay group > View permission and assign it from the Manage access tab in UiPath Administration.

Important:

Relay access is controlled by dedicated Relay permissions. Custom roles that relied on the Centralized Access Administration page permission no longer grant access to Relay Groups, so add Relay > Relay group > View to those roles. Organization Administrators and Tenant Administrators are unaffected.

Steps

1. In UiPath Administration, select your tenant and select the Relay tile.

   

2. Select Add Relay in the upper-right corner.

   

3. Fill in the relay group details and add one or more endpoints. Required fields are marked with an asterisk in the UI.

   

   For HTTP or HTTPS endpoints, select the protocol and enter the endpoint URL. You can also enter a Health check path, such as /health or /status.

   Relay calls the health check path periodically with a GET request. A 2xx response indicates the endpoint is healthy. If the check fails repeatedly, Relay stops forwarding traffic to that endpoint until it recovers. If you omit the path, Relay uses a TCP port-reachability check, which confirms that the port is open but cannot detect application-level failures.

   For supported TCP-based endpoints, select TCP and enter the target as hostname:port, for example sap.mycompany.com:3350. The health check path does not apply to TCP endpoints.

4. Select Save, then select Generate config on the confirmation page.

   

5. Copy the configuration string and save it to a file on the machine where you plan to install the Relay client.

   Important:

   Treat the configuration file as a secret. It contains the credentials that authenticate the Relay client to Automation Cloud.

   You can edit the Relay Group at any time to add, remove, or modify endpoints.

Result

The Relay Group is created and the client configuration is ready. Each registered endpoint has been assigned a private Relay URL that UiPath cloud services use to route requests through the relay infrastructure.

Next, install and start the Relay client on a machine inside your network. See Deploying the Relay client.