REST V2 Connector Recipes

This repository contains ready-to-use recipes for the Fusion REST V2 connector — a single connector that can index content from any REST API-compatible datasource.

Each recipe is a preconfigured JSON file for a specific datasource, with the endpoints, pagination, and field mappings already set up. Load a recipe into Fusion, fill in your credentials and connection details, and start crawling.

You must install the REST V2 connector in Fusion before using these recipes.

Available recipes

Lucidworks provides the following recipes as reference implementations for commonly indexed datasources. The REST V2 connector isn't limited to these — use a recipe as a starting point to build your own for any REST API-compatible datasource.

Datasource	Recipe	Documentation
Alfresco	alfresco/alfresco.json	alfresco.asciidoc
Confluence	confluence/confluence.json	confluence.asciidoc
GitHub	github/github-repo.json	github.asciidoc
Jira	jira/jira.json	jira.asciidoc

Using a recipe

1. Open the recipe's JSON file and copy its contents.

2. Replace the placeholders in the JSON with your own values — at minimum, serviceURL, authentication credentials, collection, and pipeline.

3. Send the entire edited JSON file as the body of a POST request to the Connector Datasources API. Replace RECIPE_JSON_CONTENTS with the full contents of your edited file, and BASE64_USERNAME_PASSWORD with your Fusion credentials encoded as base64 (echo -n 'username:password' | base64):

   curl --location --request POST 'https://FUSION_HOST/api/apps/APP_NAME/connectors/datasources' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Basic BASE64_USERNAME_PASSWORD' \
   --data-raw 'RECIPE_JSON_CONTENTS'

4. In Fusion, go to Indexing > Datasources, find the new datasource, and review or adjust the configuration.

5. Save and run the datasource to start crawling.

For a full walkthrough of each JSON field and how to adapt a recipe to your setup, see Recipes and the REST V2 connector reference on the Lucidworks documentation site.