--- title: Organization endpoints slug: mcc80216 canonical_url: https://docs.coveo.com/en/mcc80216/ collection: manage-an-organization source_format: adoc --- # Organization endpoints > **Important** > > On June 3, 2025, Coveo deprecated older endpoints and make other endpoint-related changes. > However, since Coveo can't review your code, you must make sure that your implementation wasn't impacted by these changes. > Therefore, you should check your Coveo implementation and make the necessary changes as soon as possible, if applicable. > > See [Endpoint deprecation and other endpoint-related changes](https://docs.coveo.com/en/o1ih0284/) and [Detailed endpoint-related changes](https://docs.coveo.com/en/p59e8291/) for details. Until 2023, depending on where your primary deployment region was located, you needed to use [region-specific endpoints](https://docs.coveo.com/en/2976#data-residency-configuration) to send Coveo API requests. For example, if your primary region was Ireland, you needed to use `platform-eu.cloud.coveo.com/rest/search` to send requests to the Search API. Other than the Push API, which [still requires region-specific endpoints](https://docs.coveo.com/en/2976#data-residency-configuration), you no longer need to use region-specific endpoints. To improve separation of concerns and resiliency and to make multi-region and data residency deployments smoother, we have introduced _organization endpoints_. Besides the generic platform endpoints (`platform-.cloud.coveo.com`), which will keep working, three kinds of endpoints are now generated for each [Coveo organization](https://docs.coveo.com/en/185/), based on its ID: * `.org.coveo.com` ([Search requests](#search-endpoint)) * `.analytics.org.coveo.com` ([Usage Analytics logging](#analytics-endpoint)) * `.admin.org.coveo.com` ([organization administration](#admin-endpoint)) Similarly, three kinds of endpoints are also generated for each [HIPAA organization](https://docs.coveo.com/en/1853/), based on its ID as an alternative to `platformhipaa.cloud.coveo.com`: * `.orghipaa.coveo.com` (Search requests) * `.analytics.orghipaa.coveo.com` (Usage Analytics logging) * `.admin.orghipaa.coveo.com` (organization administration) With these new endpoints, you no longer need to keep track of the location of your primary deployment region. These endpoints are region agnostic and will automatically route requests to the region offering the lowest latency. Whether your deployment strategy is data residency or multi-region, use the newly created organization-specific endpoints for more seamless interaction with Coveo APIs and to facilitate query rerouting if a problem occurs. You can review your current and recommended endpoints in your organization settings, under [**Traffic**](https://platform.cloud.coveo.com/admin/#/orgid/settings/organization/traffic) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/settings/organization/traffic) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/settings/organization/traffic) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/settings/organization/traffic)). ![Coveo Traffic panel](https://docs.coveo.com/en/assets/images/manage-an-organization/traffic-endpoint-deprecation.png) Alternatively, you can call the [global configuration endpoint](https://platform.cloud.coveo.com/docs?urls.primaryName=Organization#/Organization%20Global%20Configuration/rest_global_organizations_paramId_get). > **Warning** > > When migrating to organization endpoints, make sure to update your [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) to allow requests to the new endpoints. ## Search endpoint For Search requests, use: * `.org.coveo.com/rest/search` for a non-HIPAA organization * `.orghipaa.coveo.com/rest/search` for a HIPAA organization Those endpoints cover requests made to: * `/rest/search/*` * `/rest/organizations//machinelearning/user/actions` For technical reasons, requests to the following endpoints are supported through redirections to the primary deployment region (that is, slower response times can be observed when queries are routed to satellite regions). * `/rest/organizations//commerce/*` * `/rest/organizations//caseassists/*` * `/rest/organizations//insight/*` * `/rest/organizations//ipxinterface/v1/interfaces//loader` ### Atomic #### v3 Atomic v3 automatically enforces the use of organization endpoints. #### v2 > **Note** > > Only available since Atomic v2.23.4 If using the [Atomic library](https://docs.coveo.com/en/lcdf0264/) v2, set the `organizationEndpoints` parameter using the `getOrganizationEndpoints` function when initializing your [`atomic-search-interface`](https://static.cloud.coveo.com/atomic/v3/storybook/index.html?path=/docs/atomic-search-interface\--docs), as seen in the following code. The library will infer which endpoints to use. ```javascript (async () => { await customElements.whenDefined('atomic-search-interface'); const searchInterface = document.querySelector('#search'); await searchInterface.initialize({ accessToken:'', organizationId: '', organizationEndpoints: await searchInterface.getOrganizationEndpoints(''),<1> }); searchInterface.executeFirstSearch(); })(); ``` <1> For a HIPAA organization, pass `hipaa` as an argument to `getOrganizationEndpoints`, as follows: ```javascript getOrganizationEndpoints('', 'hipaa') ``` ### Headless #### v3 Headless v3 automatically enforces the use of organization endpoints. #### v2 > **Note** > > Only available since Headless v2.12.0 If using the [Coveo Headless library](https://docs.coveo.com/en/lcdf0493/) v2, set the `organizationEndpoints` parameter using the `getOrganizationEndpoints` function in your [`SearchEngineConfiguration`](https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.SearchEngineConfiguration.html) when initializing your [Headless Search Engine](https://docs.coveo.com/en/headless/latest/reference/modules/Search.html) (or analogously for other kinds of engines), as seen in the following code. The library will infer which endpoints to use. ```typescript export const headlessEngine = buildSearchEngine({ configuration: { organizationId: "", accessToken: "", organizationEndpoints: getOrganizationEndpoints(''),<1> } }) ``` <1> For a HIPAA organization, pass `hipaa` as an argument to `getOrganizationEndpoints`, as follows: ```javascript getOrganizationEndpoints('', 'hipaa') ``` ### JavaScript Search Framework If using the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/), set your search endpoint to `\https://.org.coveo.com/rest/search` or `\https://.orghipaa.coveo.com/rest/search`, depending on whether your organization is HIPAA or not. For example: ```javascript Coveo.SearchEndpoint.configureCloudV2Endpoint("", "", "https://.org.coveo.com/rest/search"); ``` ## Analytics endpoint To log [Coveo Analytics](https://docs.coveo.com/en/182/), use: * `.analytics.org.coveo.com/rest/ua/` for a non-HIPAA organization * `.analytics.orghipaa.coveo.com/rest/ua/` for a HIPAA organization These analytics endpoints let ad blockers distinguish between analytics and non-analytics requests sent to the Coveo platform. As a result, ad blockers can target and block requests to log [Coveo Analytics events](https://docs.coveo.com/en/260/) specifically, preventing issues with Search requests. Those endpoints cover requests made to: * `/rest/v15/analytics/*` * `/rest/v14/analytics/*` * `/rest/organizations/{organizationId}/events/**` ### Atomic and Headless If using the v3 Atomic or Headless libraries, the libraries enforce the use of organization endpoints for analytics logging. If using v2, specify the `organizationEndpoints` parameter using the `getOrganizationEndpoints` function, as specified [previously](#atomic), lets the library infer which analytics endpoint to target. ### JavaScript Search Framework If using the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/), set your analytics component `data-endpoint` property. The property must use one of the following formats depending on your JavaScript Search Framework version and whether your organization is HIPAA or not. **Non-HIPAA organization** * [Coveo JavaScript Search Framework v2.8864 (April 2020)](https://docs.coveo.com/en/m54e5269#april-2020-release-v28864) or later: ```html https://.analytics.org.coveo.com/rest/ua ``` * [Coveo JavaScript Search Framework v2.8521 (March 2020)](https://docs.coveo.com/en/m54e5269#march-2020-release-v28521) or earlier: ```html https://.analytics.org.coveo.com/ ``` **HIPAA organization** * [Coveo JavaScript Search Framework v2.8864 (April 2020)](https://docs.coveo.com/en/m54e5269#april-2020-release-v28864) or later: ```html https://.analytics.orghipaa.coveo.com/rest/ua ``` * [Coveo JavaScript Search Framework v2.8521 (March 2020)](https://docs.coveo.com/en/m54e5269#march-2020-release-v28521) or earlier: ```html https://.analytics.orghipaa.coveo.com/ ``` **Example** For a non-HIPAA organization that's using Coveo JavaScript Search Framework v2.8864 or later: ```html
``` ## Admin endpoint Use `.admin.org.coveo.com` and `.admin.orghipaa.coveo.com` instead of `platform-.cloud.coveo.com` and `platformhipaa.cloud.coveo.com` to perform administrative API calls, including reading UA reports. These endpoints can be used for most Coveo API requests outside UA logging. While they can technically be used for search, you should use the [search endpoints introduced earlier](#search-endpoint) instead. A further advantage is that you no longer need to know your main region to navigate to the [Administration Console](https://docs.coveo.com/en/183/). As a test, type in `.admin.org.coveo.com` with your specific `` into your browser to access the Administration Console. You'll be automatically redirected to the proper region endpoint. ## Integrations Certain [Coveo integrations](https://docs.coveo.com/en/1495/) require a configuration that differs from what's explained in the preceding sections of this article. ### Coveo for Sitecore To configure organization endpoints in a Coveo for Sitecore deployment, see [Migrate to organization endpoints](https://docs.coveo.com/en/o1ud0002/). ### Coveo for Salesforce To configure organization endpoints for a Coveo for Salesforce deployment, see [Using the Advanced Configuration page](https://docs.coveo.com/en/1275#using-the-advanced-configuration-page). ### Coveo for ServiceNow By default, Coveo for ServiceNow integrations use organization endpoints for search and usage analytics requests. No additional configuration is required. However, if your Coveo for ServiceNow requests must go through a proxy server or a specific region endpoint in a multi-region deployment, you can [disable the organization endpoints feature](https://docs.coveo.com/en/2104#organization-endpoints).