Validate Routes and Ports

This article is intended for developers and administrators who need an in-depth view of the interactions occurring between the services involved with Coveo for Sitecore and Coveo Cloud. You can use the information below to add the necessary URLs to your firewall exceptions.

Coveo for Sitecore (December 11, 2020)

The Coveo Cloud Organization section of the Command Center now contains a Platform Endpoints subsection which lists the specific endpoints your Sitecore instance is using, combined with a Copy to clipboard functionality.

Topology of Services and Components

Topology of services

1: Pushing Sitecore documents to a Coveo Cloud index is a two-step process comprising a call to the amazonaws.com endpoint and another to the coveo.com endpoint (see Manage Batches of Items in a Push Source).

2: With Amazon planning to deprecate path-style URLs, the old s3.amazonaws.com URL was replaced with this new format in the Coveo for Sitecore December 2020 release.

3: In pre-September 2020 releases of Coveo for Sitecore, the analytics endpoint was usageanalytics.coveo.com.

Note: The URLs contain [Region] and [Region Code] portions or don’t, depending on the selected deployment region.

Validating Routes #1-4 (from Sitecore to Coveo Cloud)

Source Sitecore
Destination
  • platform-[Region code].cloud.coveo.com
  • api-[Region code].cloud.coveo.com/push
  • [Bucket name].s3.[Region].amazonaws.com
  • platform-[Region code].cloud.coveo.com/rest/ua
Protocol HTTPS
Port 443

The URLs contain [Region] and [Region Code] portions or don’t, depending on the selected deployment region.

The routes are used for these purposes:

  • platform-[Region code].cloud.coveo.com: To manage the Coveo Cloud resources such as creating sources, fields and performing search requests.
  • api-[Region code].cloud.coveo.com/push: To push documents and permissions to Coveo Cloud. The full Push API URL value used by the code is set when activating Coveo for Sitecore or changing the Coveo organization your Sitecore instance is linked to.
  • [Bucket name].s3.[Region].amazonaws.com: To push documents and permissions to Coveo Cloud using a Push API file container.
  • platform-[Region code].cloud.coveo.com/rest/ua: To send Coveo for Sitecore activity statistics to Coveo.

To validate the route

  1. On the Sitecore server, open a web browser and access each of the destinations mentioned above (e.g., https://platform-eu.cloud.coveo.com).
  2. You should be able to reach each URL.

Validating Route #5 (from Sitecore to Sitecore through the Load Balancer)

Source Sitecore
Destination

Load Balancer

Protocol HTTPS
Port 80 (or 443)

The route is used by the FetchPageContent and the HtmlContentInBodyWithRequestsProcessor processors to retrieve the page content.

To validate the route:

If Sitecore is secure, the protocol is HTTPS and port is 443.

  1. From the Sitecore server, open a web browser and access http://[Load balancer hostname]/coveo/rest.
  2. You should get an output similar to this:

Recommended Articles