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 the Coveo Platform. 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 Platform index is a two-step process comprising a call to the amazonaws.com endpoint and another to the Coveo Push API 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-November 2021 releases of Coveo for Sitecore, the usage analytics endpoint was platform-<REGION_CODE>.cloud.coveo.com/rest/ua or platform.cloud.coveo.com/rest/ua.

Note: The URLs may contain <REGION> and <REGION_CODE> portions, depending on the selected deployment region.

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

Source Sitecore
Destination
  • platform-<REGION_CODE>.cloud.coveo.com
  • api-<REGION_CODE>.cloud.coveo.com/push
  • <BUCKET_NAME>.s3.<REGION>.amazonaws.com
  • analytics-<REGION_CODE>.cloud.coveo.com
Protocol HTTPS
Port 443

The URLs may contain <REGION> and <REGION_CODE> portions, depending on the selected deployment region.

Examples:

Coveo Platform endpoint, US-East region: platform.cloud.coveo.com
Coveo Platform endpoint, Austalia region: platform-au.cloud.coveo.com
Push API endpoint, Ireland region: api-eu.cloud.coveo.com/push Usage analytics endpoint, US-East region: analytics.cloud.coveo.com Usage analytics endpoint, Ireland region: analytics-eu.cloud.coveo.com

The routes are used for these purposes:

  • platform-<REGION_CODE>.cloud.coveo.com: To manage the Coveo Platform resources such as creating sources, fields and performing search requests.
  • api-<REGION_CODE>.cloud.coveo.com/push: To push documents and permissions to the Coveo Platform. 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 the Coveo Platform using a Push API file container.
  • analytics-<REGION_CODE>.cloud.coveo.com: To send Coveo for Sitecore activity data 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:

What's Next for Me?