Overview of REST API calls

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

{toc}

h2. 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.

h3. Collection APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Description ||
| [/api/collections|lweug: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_|lweug:Collections] | GET: Retrieve basic information for a specific collection. \\
DELETE: Delete a collection. |
| [/api/collections/_collection_/info|lweug:Collection Info] | GET: Retrieve detailed information about the size and contents of a collection. |
| [/api/collections/_collection_/info/_name_|lweug:Collection Info] | GET: Retrieve a single data point about the collection such as the free disk space or the number of documents. |
| [/api/collections/_collection_/index|lweug:Collection Index Delete] | DELETE: Delete the index for an entire collection. |
{table-plus}


h3. Data Source & Crawler APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Description ||
| [/api/collections/_collection_/datasources|lweug:Data Sources] | GET: Retrieve a list of all data sources and their configurations. \\
POST: Create a new configuration. |
| [/api/collections/_collection_/datasources/_id_|lweug:Data Sources] | 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|lweug:Data Source Schedules] | GET: Retrieve the schedule for a specific data source.  \\
PUT: Update the schedule for a data source. |
| [/api/collections/_collection_/datasources/all/job|lweug:Data Source Jobs] | 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|lweug:Data Source Jobs] | 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|lweug:Data Source Status] | GET: Retrieve the crawling status of a specific data source. |
| [/api/collections/_collection_/datasources/_id_/history|lweug:Data Source History] | GET: Retrieve the history of the last 50 crawls of a specific data source. |
| [/api/collections/_collection_/datasources/_id_/crawldata|lweug:Data Source Crawl Data Delete] | DELETE: Delete the crawl history for a data source. |
| [/api/collections/_collection_/datasources/_id_/index|lweug:Collection Index Delete] | DELETE: Delete indexed content for a specific data source. |
| [/api/collections/_collection_/datasources/_id_/mapping|lweug:Field 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_|lweug:Field Mapping] | 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_|lweug:Field Mapping] | 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|lweug:JDBC Drivers] | GET: Retrieve a list of all JDBC drivers. \\
POST: Upload a new JDBC driver. \\ |
| [/api/collections/_collection_/jdbcdrivers/_filename_|lweug:JDBC Drivers] | DELETE: Remove a JDBC driver. |
| [/api/collections/_collection_/jdbcdrivers/classes|lweug:JDBC Drivers] | GET: Retrieve a list of all JDBC 4.0 compliant drivers. |
| [/api/collections/_collection_/batches|lweug:Batch Operations] | GET: Retrieve a list of all batches. \\
DELETE: Delete all batches. |
| [/api/collections/_collection_/batches/_crawler_|lweug:Batch Operations] | 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|lweug:Batch Operations] | 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_|lweug:Batch Operations] | GET: Retrieve the status of a batch crawl job. \\
PUT: Start a batch crawl job. \\
DELETE: Stop a batch crawl job. |
{table-plus}

h3. Activity APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Description ||
| [/api/collections/_collection_/activities|lweug:Activities] | GET: Retrieve a list of activities and their schedules. \\
POST: Create an activity and its schedule. |
| [/api/collections/_collection_/activities/_id_|lweug:Activities] | 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|lweug:Activity Status] | GET: Retrieve the status of a specific activity. |
| [/api/collections/_collection_/activities/_id_/history|lweug:Activity History] | GET: Retrieve the history of the last 50 runs of a specific activity. |
{table-plus}

h3. Field-Related APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Verb & Description ||
| [/api/collections/_collection_/fields|lweug:Fields] | GET: Retrieve all fields and their attributes. \\
POST: Create a new field. |
| [/api/collections/_collection_/fields/_name_|lweug:Fields] | GET: Retrieve attributes for a specific field. \\
PUT: Update the attributes for a specific field. \\
DELETE: Delete a field. |
| [/api/collections/_collection_/fieldtypes|lweug:FieldTypes] | GET: Retrieve all field types and their attributes. \\
POST:  Create a new field types. |
|[/api/collections/_collection_/fieldtypes/_name_|lweug:FieldTypes] | 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|lweug:Dynamic Fields] | GET: Retrieve all dynamic fields and their attributes. \\
POST: Create a new dynamic field. |
| [/api/collections/_collection_/dynamicfields/_name_|lweug:Dynamic Fields] | GET: Retrieve attributes for a specific dynamic field. \\
PUT: Update the attributes for a specific dynamic field. \\
DELETE: Delete a dynamic field. |
{table-plus}

h3. Setting APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Verb & Description ||
| [/api/collections/_collection_/settings|lweug:Settings] | GET: Retrieve all settings for a collection. \\
PUT: Update settings for a collection. |
| [/api/collections/_collection_/settings/_name_|lweug:Settings] | GET: Retrieve a specific setting. \\
PUT: Update a specific setting. |
| [/api/collections/_collection_/caches|lweug:Caches] | GET: Retrieve details of all configured caches. \\
POST: Create a new cache configuration. |
| [/api/collections/_collection_/caches/_name_|lweug:Caches] | GET: Retrieve details of a specific cache. \\
PUT: Update details of a specific cache \\
DELETE: Delete a cache configuration. |
{table-plus}

h3. User & Search-Related APIs

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Verb & Description ||
|[/api/collections/_collection_/click|lweug:Click Scoring] | GET: Retrieve statistics about recent Click Scoring events.\\
PUT: Record Click Scoring events. |
| [/api/collections/_collection_/roles|lweug:Roles] | GET: Retrieve a list of all existing roles. \\
POST: Create a new role. |
| [/api/collections/_collection_/roles/_role_|lweug:Roles] | GET: Retrieve details for a specific role. \\
PUT: Update details for a specific role. \\
DELETE: Delete a role. |
| [/api/collections/_collection_/filtering|lweug:Filtering Results] | GET: Retrieve a list of existing search filter configurations. \\
POST: Create a new search filter configuration. |
| [/api/collections/_collection_/filtering/_instance_|lweug:Filtering Results] | GET: Retrieve details of a specific search filter configuration. \\

h2. Global APIs

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

{table-plus:cellspacing=0|width=75%|columnAttributes=style="width:35%;",style="width=65%;"|enableSorting=false|highlightColor=#E6EDF4}

|| API || Verb & Description ||
| [/api/collectiontemplates|lweug:Collection Templates] | GET: Retrieve a list of available collection templates. |
| [/api/version|lweug:Version] | GET: Retrieve the Solr and LucidWorks version of the application. |
| [/api/alerts|lweug:Alerts API] | GET: Retrieve all alerts and their attributes. \\
POST: Create an alert. |
| [/api/alerts?username=_username_|lweug:Alerts API] | GET: Retrieve all alerts for a specific user. |
| [/api/alerts/_id_|lweug:Alerts API] | GET: Retrieve details for a specific alert. \\
PUT: Update details for a specific alert. \\
DELETE: Delete a specific alert. |
| [/api/alerts/_id_/check|lweug:Alerts API] | PUT: Run an alert to check for new results. |
| [/api/users|lweug:Users] | GET: Retrieve a list of all locally-created users. \\
POST: Create a user locally. |
| [/api/users/_username_|lweug:Users] | GET: Retrieve details for a specific user. \\
PUT: Update details for a specific user. \\
DELETE: Delete a user. |
| [/api/config/ssl|lweug:SSL Configuration] | GET: Retrieve details of the current SSL implementation. \\
PUT: Update the SSL implementation. |
| [/api/crawlers/status|lweug:Crawler Status]| GET: Get status and history of communication between the Core and Connectors components. |
{table-plus}

{navbar}