Connect a private relay to the Reverse Tunnel gateway

task australia Updated Sep 10, 2026 2 min read connect-customer-relay.md
Raw file servicenow.com

Configure and register a private relay to establish an encrypted connection to the Reverse Tunnel gateway.

Before you begin

  • The host machine must be running Linux x86-64 or Windows x86-64.
  • The host machine must have outbound network access to the ServiceNow instance on port 443.
  • After the relay registers, the host machine must also have access to each gateway host on its data port and admin port. For the purpose of each port, see Reverse Tunnel architecture.
  • A user account must be available to create a service account for the relay.

Role required: sn_zc_tunnel.relay_manager

Procedure

  1. Download the relay artifact Reverse Tunnel Relay from the ServiceNow Store.

  2. Extract the artifact files.

  3. Verify outbound network access from the host machine to your ServiceNow instance on port 443.

    Replace <instance> with the name of your ServiceNow instance.

    On Windows, run the following command:

    Text
    Test-NetConnection -ComputerName <instance>.service-now.com -Port 443

    On Linux, run the following command:

    Text
    nc -zv <instance>.service-now.com 443

    For examples of the output, see Verify outbound network access for a private relay.

  4. Configure and start the relay following the README instructions included in the extracted artifact.

  5. Navigate to All > Private Relay > Relays and verify a relay record was created.

    Note: After successful registration, a record ID is stored in the config.yaml file. Do not modify or remove this value.

  6. Verify outbound network access from the relay host machine to each gateway host.

    Outbound firewall rules must permit access to each gateway host on its data port and admin port. For the required steps, see Verify outbound network access for a private relay.

  7. Register backend services to the relay.

    1. Note the fully qualified domain name (FQDN) and port number of the data source you want to access through the tunnel.

      For example: acme.snowflakecomputing.com:443.

    2. In the relay record, select Unlock Services.

    3. Select Lookup using list icon [Omitted image "lookup-using-list-icon.png"] Alt text: to open the Service Endpoints list.

    4. Select New.

    5. Enter a name for the service endpoint and the FQDN and port number.

    6. Select Submit.

    7. Save the record.

    Assigned services are reported to the gateway, which routes incoming traffic to the correct relay. To add or update service endpoints after initial setup, see Manage relay service endpoints through Reverse Tunnel.

  8. Set up the zero copy connection.

    1. Navigate to All > Zero Copy Connectors (Workflow Data Fabric).

    2. Select the connector you want to configure with the relay.

    3. Enter the credentials for the connector.

      Note: The connection URL hostname must exactly match the FQDN registered as a service endpoint. If the backend data source has an IP allowlist restriction, verify the relay is running on the same machine that is on the allowlist.

    4. Select Test Connection.

      If the connection test succeeds, the private tunnel setup is complete.

Keywords private relayrelay registrationReverse Tunnelconfig.yaml
Search documentation
Search document titles and file paths on the australia branch