Impacts of endpoint deprecation

This is for:

Developer System Administrator

Beginning December 9, 2024, Coveo will take the following actions:

  • Deprecate the Coveo V1 platform (cloudplatform.coveo.com) and usage analytics (usageanalytics.coveo.com) endpoints.

  • Block analytics-logging calls made towards the search (<ORG_ID>.org.coveo.com/*) and administration (<ORG_ID>.admin.org.coveo.com/*) endpoints.

  • Block search requests made to the analytics logging endpoints (<ORG_ID>.analytics.org.coveo.com/* and analytics.cloud.coveo.com).

  • Report all analytics-logging calls made to the platform endpoint (platform.cloud.coveo.com) as sub-optimal.

See Endpoint deprecation and other endpoint-related changes for more information.

To ensure that your Coveo for Salesforce implementation continues to function as expected, follow the guidelines outlined in this article.

Version 5.8 and later

If you’re using organization endpoints, no action is required.

If you’re not using organization endpoints, API calls won’t be blocked but will be marked as sub-optimal under Traffic (platform-ca | platform-eu | platform-au) in the Coveo Administration Console.

To ensure optimal performance, we recommend enabling organization endpoints. This will improve separation of concerns, resiliency, and make multi-region and data residency deployments smoother.

Versions 5.2 to 5.7

If you’re using organization endpoints, no action is required.

If you’re not using organization endpoints, you must update to version 5.8 to use the analytics endpoint (analytics.cloud.coveo.com) instead of the platform endpoint (platform.cloud.coveo.com) to send usage analytics events. While your API calls will be marked as sub-optimal under Traffic (platform-ca | platform-eu | platform-au) in the Coveo Administration Console, they won’t be blocked.

To ensure optimal performance, we recommend enabling organization endpoints. This will improve separation of concerns, resiliency, and make multi-region and data residency deployments smoother.

Versions 4.21 to 4.33.1

No immediate action is required. However, upgrading to the latest v4 release is recommended.

These versions use the platform endpoint (platform.cloud.coveo.com) for search requests and the analytics endpoint (analytics.cloud.coveo.com) for usage analytics. While your API calls will be marked as sub-optimal under Traffic (platform-ca | platform-eu | platform-au) in the Coveo Administration Console, they won’t be blocked.

For optimal performance, we recommend upgrading to version 5 and enabling organization endpoints. This will improve separation of concerns, resiliency, and make multi-region and data residency deployments smoother.

Versions 4.20 and earlier

A minimum upgrade to v4.21 is required. However, upgrading to the latest v4 release is recommended. After upgrading, follow the guidelines in Versions 4.21 to 4.33.1.

Verify endpoint routing

  1. Review the endpoints used in your organization settings under Traffic (platform-ca | platform-eu | platform-au).

    Alternatively, you can access the Network tab in your browser’s developer tools.

  2. Validate the following endpoints:

    1. Ensure search requests (/rest/search) are being sent to platform.cloud.coveo.com/rest/search (suboptimal) or to <ORG_ID>.org.coveo.com/rest/search (optimal).

    2. Ensure analytics requests (/analytics) are being sent to analytics.cloud.coveo.com (suboptimal) or to <ORG_ID>.analytics.org.coveo.com (optimal).