Skip to main content
  • Latest version: v1.1.0
  • Compatible with Fusion version: 5.9.0 and later
The REST V2 connector enables users to crawl content by exposing its data through a REST API. It can be configured to communicate with a wide selection of external datasources by making API calls and indexing the responses. As an out-of-the-box V2 connector, it provides a low-code user experience for indexing data from REST API-compatible sources. This connector is the alternative solution for various deprecated and removed V1 connectors. Key concepts:
  • The REST V2 connector is a new approach to Fusion connectors: one connector that can index data from many different datasources.
  • The connector is powered by recipes, which are JSON configurations for the REST V2 connector that are customized for a specific datasource.
  • A supported datasource will have a corresponding recipe.
  • Over time, the deprecated V1 connectors may be replaced by comparable REST V2 connector recipes.
REST V2 connector features:
  • Indexes REST API-compatible datasources for data integration.
  • Supports initial full crawl and re-full crawl and object mapping.
  • Remote framework and pagination are supported.
  • Supports basic and OAuth authentication methods.
  • Enhances the datasource retrieval capability with a globally standardized format connector.
  • Saves DevOps time by using a preconfigured connector.

​
How REST V2 is different from other connectors

Most connectors are developed solely for a specific datasource. The REST V2 connector is able to work any datasources that has a supported recipe. This gives the REST V2 connector a great amount of flexibility and enhances its usefulness as part of the Lucidworks connectors offerings. An API call is made to the REST V2 connector containing a recipe as the body. API calls to set up the REST V2 connector go through the Connector Datasources API. This article lists and describes the Fusion properties used by REST V2. The recommended method of populating these fields is through the use of a recipe. For information on how to get a recipe from the public GitHub repository into Fusion, see How to use REST V2 recipes. The REST V2 connector performs a full crawl each time the connectors runs, as incremental crawling is not supported. When changes are made to the source, such as adding, deleting, or modifying content, those changes will reflect in the index after the next crawl is performed. You can check for new documents in the index by navigating to Querying > Query Workbench in the Fusion UI. Lucidworks no longer updates, maintains, or releases V1 connectors. A benefit of using this remote V2 connector over the classic V1 connectors is this V2 connector is regularly improved and updated, while the classic connectors are not. The REST V2 connector is replacing V1 connectors using comparable recipes. You can learn more about the benefits of V2 connectors by reading the differences between V1 and V2 connectors.

​
Recipes

Recipes are preconfigured datasource configurations that can be loaded into Fusion for quicker testing and setup of connectors. Parameter values are already entered into recipes for quick population of the required fields. Recipes are created in a JSON format and contain all of the parameters required to get a connector up and running. You can configure a connector using a recipe by issuing a POST request with the JSON as the body. Any minor adjustments required can be made directly in the JSON and sent to Fusion, where it will show in the UI. After the recipe has been sent to Fusion, you can also go into the Fusion UI and make changes.

​
Recipe repository

The REST V2 connector uses a public GitHub repository to store recipes. Here you will find all of the recipes that have been created and ready for use. The recipes are JSON files that can be added as the body in Postman requests or appended as the body in cURL calls. The parameter values can then be changed as necessary to match the data in the way you want it to be indexed. The repository is public and treated as an open source resource where everyone is welcome to contribute. Recipes are not considered a standard Lucidworks product. As such, Lucidworks does not guarantee that a recipe will be maintained or updated after it is created. If you encounter any issues or bugs, please report them in GitHub with detailed information to aid in troubleshooting.

​
Remote connectors

V2 connectors support running remotely in Fusion versions 5.7.1 and later. For more information, see Configure remote V2 connectors. Below is an example configuration showing how to specify the file system to index under the connector-plugins entry in your values.yaml file:
You may also need to specify the user that is authorized to access the file system, as in this example:

​
Learn more

The REST V2 Connector

The microlearning for The REST V2 Connector focuses on how to use the REST V2 connector and its recipes.

Using the REST V2 Connector

The quick learning for Using the REST V2 Connector focuses on how to ingest a datasource using REST V2 connector recipes.

​
Configuration