Changing the Default Coveo for Sitecore REST Endpoint Proxy Path

Changing the Default Coveo for Sitecore REST Endpoint Proxy Path

This is for:

Developer System Administrator

By default, the REST endpoint proxy for your Coveo for Sitecore instance is set to http://<YourSitecoreInstance>/coveo/rest.

To change it, follow these steps:

1. Open the Coveo.SearchProvider.Custom.config file in a text editor.

2. In the configuration/sitecore element, look for a <sites> element. If there’s no <sites> element, add one.

   <sitecore>
     <sites>
     </sites>
   

3. In the <sites> element, add the <site> element below:

   <site name="coveorest" virtualFolder="/coveo/rest" physicalFolder="/coveo/rest" enableTracking="false" database="web" domain="extranet" />
   

   You should now have the following configuration structure:

   <sitecore>
     <sites>
       <site name="coveorest" virtualFolder="/coveo/rest" physicalFolder="/coveo/rest" enableTracking="false" database="web" domain="extranet" />
     </sites>
   

4. In the new <site> element, change the values for both the virtualFolder and physicalFolder attributes.

5. Open the Coveo.SearchProvider.Rest.Custom.config file in a text editor.

6. In the <restEndpointConfiguration> element, look for a <restEndpointPath> element. If there’s no <restEndpointPath> element, add one as follows:

    <coveo>
      <restEndpointConfiguration>
        <restEndpointPath>/coveo/rest</restEndpointPath>
   

7. Change the text content of the <RestEndpointPath> element to match the path of the rest site specified previously.

Changing the REST Endpoint an Existing Search Page Uses

If you’ve changed the location of the rest endpoint, you’ll need to reference the new location everywhere you’ve inserted a Legacy Search UI Framework Coveo Search component or a Coveo Hive UI Framework Coveo Search Resources component.

For Legacy Search UI Framework Pages

1. In the Sitecore Content Editor, select your Coveo search component.
2. In the presentation tab, select Details.
3. Click the Coveo Search sublayout.
4. Navigate to Advanced control properties.
5. Change the Rest uri endpoint.

For Coveo Hive UI Framework Pages

1. Open your search interface in the Sitecore Experience Editor.
2. Select your Coveo Search Resources component.
3. In the floating toolbar, select Edit the rendering’s data source. It should be the leftmost option in the toolbar.
4. Set the value of the Coveo REST endpoint field to the new path.

Once you performed all these steps you should be able to access your REST endpoint using the path of your choosing.