Support Resources

LucidWorks Forum
KnowledgeBase

LucidWorks Search 2.7

PDF Versions

This is the documentation for LucidWorks Search 2.7, the most recent release.

Skip to end of metadata
Go to start of metadata

This section provides an overview of the various API calls, what they do, with links to more documentation for each call.

Collection-Specific APIs

These APIs all require the collection name to be specified in the request. They apply only to the collection named; changes to multiple collections require multiple API calls to each collection.

Collection APIs

API

Description

/api/collections

GET: Retrieve a list of collections for the entire installation with basic information about name and data location on disk.
POST: Create a new collection.

/api/collections/collection

GET: Retrieve basic information for a specific collection.
DELETE: Delete a collection.

/api/collections/collection/info

GET: Retrieve detailed information about the size and contents of a collection.

/api/collections/collection/info/name

GET: Retrieve a single data point about the collection such as the free disk space or the number of documents.

/api/collections/collection/index

DELETE: Delete the index for an entire collection.

Data Source & Crawler APIs

API

Description

/api/collections/collection/datasources

GET: Retrieve a list of all data sources and their configurations.
POST: Create a new configuration.

/api/collections/collection/datasources/id

GET: Retrieve details of the configuration for a specific data source.
PUT: Update a specific data source.
DELETE: Delete a data source.

/api/collections/collection/datasources/id/schedule

GET: Retrieve the schedule for a specific data source. 
PUT: Update the schedule for a data source.

/api/collections/collection/datasources/all/job

GET: Retrieve the crawling status of all data sources.
PUT: Instruct all data sources to start crawling.
DELETE: Instruct all data sources to stop crawling.

/api/collections/collection/datasources/id/job

GET: Retrieve the crawling status of a specific data source. 
PUT: Instruct a specific data source to start crawling.
DELETE: Instruct a specific data source to stop crawling.

/api/collections/collection/datasources/id/status

GET: Retrieve the crawling status of a specific data source.

/api/collections/collection/datasources/id/history

GET: Retrieve the history of the last 50 crawls of a specific data source.

/api/collections/collection/datasources/id/crawldata

DELETE: Delete the crawl history for a data source.

/api/collections/collection/datasources/id/index

DELETE: Delete indexed content for a specific data source.

/api/collections/collection/datasources/id/mapping

GET: Get only the field mapping settings for a specific data source.
PUT: Update the field mapping settings for a specific data source.
DELETE: Remove all custom field mapping settings for a specific data source, and return it to defaults.

/api/collections/collection/datasources/id/mapping/part

GET: List the values for a specific part of the field mapping settings for a data source.
DELETE: Remove custom values for a specific part of the field mapping settings for a data source (and return it to defaults).

/api/collections/collection/datasources/id/mapping/part/key

GET: List the values for a specific field mapping setting, within a part.
DELETE: Remove custom values for a specific field mapping setting, within a part (and return it to defaults).

/api/collections/collection/jdbcdrivers

GET: Retrieve a list of all JDBC drivers.
POST: Upload a new JDBC driver.

/api/collections/collection/jdbcdrivers/filename

DELETE: Remove a JDBC driver.

/api/collections/collection/jdbcdrivers/classes

GET: Retrieve a list of all JDBC 4.0 compliant drivers.

/api/collections/collection/batches

GET: Retrieve a list of all batches.
DELETE: Delete all batches.

/api/collections/collection/batches/crawler

GET: Retrieve a list of all batches for a specific crawler.
DELETE: Delete all batches for a specific crawler.

/api/collections/collection/batches/crawler/job

GET: Retrieve a list of all jobs for a specific crawler.
PUT: Define a job for a specific crawler.

/api/collection/collection/batches/crawler/job/batch_id

GET: Retrieve the status of a batch crawl job.
PUT: Start a batch crawl job.
DELETE: Stop a batch crawl job.

Activity APIs

API

Description

/api/collections/collection/activities

GET: Retrieve a list of activities and their schedules.
POST: Create an activity and its schedule.

/api/collections/collection/activities/id

GET: Retrieve the schedule for a specific activity.
PUT: Update the schedule for a specific activity.
DELETE: Delete the schedule for a specific activity.

/api/collections/collection/activities/id/status

GET: Retrieve the status of a specific activity.

/api/collections/collection/activities/id/history

GET: Retrieve the history of the last 50 runs of a specific activity.

Field-Related APIs

API

Verb & Description

/api/collections/collection/fields

GET: Retrieve all fields and their attributes.
POST: Create a new field.

/api/collections/collection/fields/name

GET: Retrieve attributes for a specific field.
PUT: Update the attributes for a specific field.
DELETE: Delete a field.

/api/collections/collection/fieldtypes

GET: Retrieve all field types and their attributes.
POST:  Create a new field types.

/api/collections/collection/fieldtypes/name

GET: Retrieve attributes for a specific field type.
PUT: Update the attributes for a specific field type.
DELETE: Delete a field type.

/api/collections/collection/dynamicfields

GET: Retrieve all dynamic fields and their attributes.
POST: Create a new dynamic field.

/api/collections/collection/dynamicfields/name

GET: Retrieve attributes for a specific dynamic field.
PUT: Update the attributes for a specific dynamic field.
DELETE: Delete a dynamic field.

Setting APIs

API

Verb & Description

/api/collections/collection/settings

GET: Retrieve all settings for a collection.
PUT: Update settings for a collection.

/api/collections/collection/settings/name

GET: Retrieve a specific setting.
PUT: Update a specific setting.

/api/collections/collection/caches

GET: Retrieve details of all configured caches.
POST: Create a new cache configuration.

/api/collections/collection/caches/name

GET: Retrieve details of a specific cache.
PUT: Update details of a specific cache
DELETE: Delete a cache configuration.

User & Search-Related APIs

API

Verb & Description

/api/collections/collection/click

GET: Retrieve statistics about recent Click Scoring events.
PUT: Record Click Scoring events.

/api/collections/collection/roles

GET: Retrieve a list of all existing roles.
POST: Create a new role.

/api/collections/collection/roles/role

GET: Retrieve details for a specific role.
PUT: Update details for a specific role.
DELETE: Delete a role.

/api/collections/collection/filtering

GET: Retrieve a list of existing search filter configurations.
POST: Create a new search filter configuration.

/api/collections/collection/filtering/instance

GET: Retrieve details of a specific search filter configuration.
PUT: Update the details of a specific search filter configuration.
DELETE: Delete a specific search filter configuration.

/api/collections/collection/components/list-name?handlerName=/handlerName

GET: List the search components for a search handler.
PUT: Update the search components for a search handler.

Global APIs

These APIs are not specific to a collection, but instead apply to the entire LucidWorks installation.

API

Verb & Description

/api/collectiontemplates

GET: Retrieve a list of available collection templates.

/api/version

GET: Retrieve the Solr and LucidWorks version of the application.

/api/alerts

GET: Retrieve all alerts and their attributes.
POST: Create an alert.

/api/alerts?username=username

GET: Retrieve all alerts for a specific user.

/api/alerts/id

GET: Retrieve details for a specific alert.
PUT: Update details for a specific alert.
DELETE: Delete a specific alert.

/api/alerts/id/check

PUT: Run an alert to check for new results.

/api/users

GET: Retrieve a list of all locally-created users.
POST: Create a user locally.

/api/users/username

GET: Retrieve details for a specific user.
PUT: Update details for a specific user.
DELETE: Delete a user.

/api/config/ssl

GET: Retrieve details of the current SSL implementation.
PUT: Update the SSL implementation.

/api/crawlers/status

GET: Get status and history of communication between the Core and Connectors components.