---
title: About the REST endpoint configuration files
slug: '2568'
canonical_url: https://docs.coveo.com/en/2568/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# About the REST endpoint configuration files
When loading a Coveo Hive search page in a web browser, the page components use the [reverse proxy](https://docs.coveo.com/en/2554/) to perform queries.
As it's installed on the Sitecore website, the reverse proxy can access information from the Sitecore context.

The reverse proxy relies on two important modules.
The first one is a custom HTTP handler that's seen as the reverse proxy REST endpoint itself.
Its default location in the website is `\https://<INSTANCE_HOSTNAME>/coveo/rest`.
The second module is the [Search API](https://docs.coveo.com/en/52/), which resides in the [Coveo Platform](https://docs.coveo.com/en/186/).
The Search API is responsible for querying the search index.

This article presents the reverse proxy configuration settings stored in the `Coveo.SearchProvider.Rest.config` and the `Coveo.SearchProvider.Rest.Custom.config` patch file.
These settings may be found under the `configuration/sitecore/coveo/restEndpointConfiguration` element.

> **Note**
>
> The `Coveo.SearchProvider.Rest.config` file also contains a section for pipeline configurations (see [About the REST endpoint pipelines](https://docs.coveo.com/en/2569/)).

## The `restEndpointConfiguration` section settings

Many of the following settings are automatically set at activation in the `Coveo.SearchProvider.Rest.Custom.config` patch file, while the others have default values that shouldn't need to be changed.

[%header,cols="3,4,1"]
|===
|Name
|Description
|Default value

|`searchApiUri`
|The URI to connect to the Coveo Search API (see [Validate routes and ports](https://docs.coveo.com/en/2535/)).
You shouldn't have to update the value of this setting.
|

|`analyticsUri`
|The URI to connect to the Coveo Usage Analytics API (see [Validate routes and ports](https://docs.coveo.com/en/2535/)).
You shouldn't have to update the value of this setting.
|

|`organizationId`
|The ID of the Coveo organization that's being queried.
You shouldn't have to update the value of this setting.
|

|`apiKey`
|The encrypted API key of the Coveo organization that's being queried.
You shouldn't have to update the value of this setting.
|

a|{empty}
--


[.version.c4sc.c4sc-new.5-0-822-2.October-30&-2020]
[Coveo for Sitecore 5.0.822.2](https://docs.coveo.com/en/3360#release-notes)


--
`bypassCoveoForSitecoreProxy`
|Whether to bypass the reverse proxy for Coveo Hive search and analytics calls (see [Performing a query from a Coveo Hive search page through the reverse proxy](https://docs.coveo.com/en/2554#scenario-2-performing-a-query-from-a-coveo-hive-search-page-through-the-reverse-proxy) and [Performing a query from a Coveo Hive search page directly to the Coveo Platform](https://docs.coveo.com/en/2554#scenario-3-performing-a-query-from-a-coveo-hive-search-page-directly-to-the-coveo-platform)).
You should only change the value of this setting in the **Command Center**, in the **Configuration Manager** section.
|`false`

|`requestTimeout`
|The timeout period for requests going through the reverse proxy.
|`00:00:30`

|`searchTokenExpiration`
|Defines the period when the search token is valid.
|`01:00:00`

|`restEndpointPath`
|Defines the location of the reverse proxy REST endpoint in the Sitecore website (see [About the architecture of Coveo for Sitecore](https://docs.coveo.com/en/2554/)).
You shouldn't have to update the value of this setting.  
  
See [Change the default REST endpoint reverse proxy path](https://docs.coveo.com/en/2160/) for instructions on how to set up a custom endpoint.
|`/coveo/rest`
|===

### Compiled configuration example

When examining the compiled configuration, the content of several nodes will be a reference to the value of a corresponding `<cloudPlatformConfiguration>` element, because of settings in `Coveo.SearchProvider.Rest.Custom.config` overriding the ones in `Coveo.SearchProvider.Rest.config`.

```xml
<restEndpointConfiguration>
  ...
  <searchApiUri ref="coveo/cloudPlatformConfiguration/cloudPlatformUri"/>
  <analyticsUri>https://analytics.cloud.coveo.com</analyticsUri>
  <apiKey ref="coveo/cloudPlatformConfiguration/searchApiKey" patch:source="Coveo.SearchProvider.Rest.Custom.config"/>
  <organizationId ref="coveo/cloudPlatformConfiguration/organizationId" patch:source="Coveo.SearchProvider.Rest.Custom.config"/>
</restEndpointConfiguration>
```

> **Important**
>
> In pre-November 2021 releases of Coveo for Sitecore, the US East region `<analyticsUri>` element text node was `+https://platform.cloud.coveo.com/rest/ua+`.
> See [Validate routes and ports](https://docs.coveo.com/en/2535/) for the list of deployment region endpoints.