Validate Routes and Ports

This article is intended for developers and administrators who need an in-depth view of the interactions occurring between Coveo for Adobe services and the Coveo Platform, both on the AEM author instance and on the publish instance. You can use this information to add the necessary URLs to your firewall exceptions.

Topology of Services on the AEM Author Instance

Coveo for Adobe calls from AEM author instance

1: Pushing AEM documents to a Coveo Platform 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).

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

The routes are used for the following purposes:

  • platform-<REGION_CODE>.cloud.coveo.com: To retrieve the HTML of a hosted search page and perform search requests in preview mode.

  • api-<REGION_CODE>.cloud.coveo.com/push: To push documents to the Coveo Platform.

  • <BUCKET_NAME>.s3.<REGION>.amazonaws.com: To push documents to the Coveo Platform using a Push API file container.

  • Outbound call to AEM publish instance: To retrieve the latest published version of documents when indexing (used in result Quickviews).

    Ensure the author instance can reach the publish instance and is allowed to visit the published pages. When it can’t, the following error message is logged:

    The request to retrieve content from the publish instance failed for <DOCUMENT_URI> with code <HTTP_STATUS_CODE>.

To validate routes 1, 2, and 3

On the appropriate AEM server, open a web browser and access each of the endpoints for your deployment region (e.g., https://platform-eu.cloud.coveo.com). You should be able to reach each URL.

Topology of Services on the AEM Publish Instance

Coveo for Adobe calls from AEM publish instance

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

The routes are used for the following purposes:

  • platform-<REGION_CODE>.cloud.coveo.com: To retrieve the HTML of a hosted search page and perform search requests.

  • platform-<REGION_CODE>.cloud.coveo.com/rest/ua: To send search page usage analytics.

  • Inbound call from AEM author instance: To retrieve the latest published version of documents when indexing (used in result Quickviews).

    Ensure the author instance can reach the publish instance and is allowed to visit the published pages. When it can’t, the following error message is logged:

    The request to retrieve content from the publish instance failed for <DOCUMENT_URI> with code <HTTP_STATUS_CODE>.

To validate routes 5 and 6

On the appropriate AEM server, open a web browser and access both endpoints for your deployment region (e.g., https://platform-eu.cloud.coveo.com). You should be able to reach both URLs.

What's Next for Me?