Skip to end of metadata
Go to start of metadata

A Web source typically crawls the content of a single website, starting from the specified URL (or URLs), and then recursively following any hyperlink it finds in pages to discover the entire site (see Add/Edit Web Source - Panel). By default, a Web source schedule is set to rescan the website at midnight everyday.

Use the Create a source from simple configuration operation to create a basic shared Web source in a Coveo Cloud V2 organization.

Request template


This introductory topic explains how create a SHARED Web source, which is why the sourceType property is set to WEB2 and the sourceVisibility property is set to SHARED in the above request template.

The Coveo Cloud V2 platform allows you to create many other types of sources (see Available Coveo Cloud V2 Source types and Possible sourceType Values), and supports three different types of source visibility: PRIVATE, SHARED, and SECURED (see Source Permission Types).

In the request path:

In the Authorization HTTP header:

In the request body:

  • Replace <MyWebSourceName> by a meaningful name property value.


    You cannot change the name of a source once it has been created, so make sure the name you choose fits the content you intend to index with that source.

  • Replace <MyURL>* by one or more urls from which to start crawling the pages to index with your source.

    Best Practice:

    Although you can provide more than one value in the urls array, you should normally only index one website per Web source.

The body of a successful response (201 Created) contains information about the source you just created. The id property value is important, as it is a required parameter in many Coveo Cloud V2 platform REST API operations. You can always retrieve this value later (see Retrieving the ID of a Source).

Example request - Creating a basic shared Web source
Successful response- 201 Created
  • No labels