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.

You can use the Create a source from simple configuration operation to create a basic shared Web source in a Coveo Cloud V2 organization:

Note:

This introductory topic explains how create a Web source, which is why the sourceType value in the request body is WEB2. The Coveo Cloud V2 platform also allows you to create many other types of sources (see Possible sourceType Values).

Ensure that:

  • You replace {organizationId} in the path by the actual ID of the target Coveo Cloud V2 organization (see Getting the organizationId).
  • You replace MyAccessToken in the Authorization header by an access token that grants the privilege to edit sources in the target organization (see Creating an API key, Getting the Privileges of an Access Token, and Getting Your Coveo Cloud V2 Platform Access Token).
  • You specify an appropriate name for your source in the request body.

    Note:

    Icon

    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.

  • In the urls list, you specify one or more URLs from which to start crawling the pages to index with your source.

    Best Practice:

    Icon

    You should normally only index one website per web source.

The body of a successful response 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 ID later (see Getting the sourceId).

Example:
201 Created
  • No labels