This API lists available collection templates for use in creating new collections.
Each template is a .zip file that consists of LucidWorks configuration files. The default LucidWorks configuration is available as default.zip found in $LWE_HOME/app/collection_templates. The default configuration can be customized as needed and put in a .zip archive for use when creating new collections in the future. The .zip file can have any name, including default.zip, although using the same name would overwrite the system default template, meaning it would not be available at a later time if needed. All templates must be placed in $LWE_HOME/conf/collection_templates to be available during collection creation.
For more information about creating templates, see Using Collection Templates.
Information for LucidWorks Search in the Cloud Users
You can create custom templates with LucidWorks Search on-premise only. Customers using LucidWorks Search hosted in AWS or Azure have two collection templates out of the box that can be accessed using this API, but there is no mechanism to create and upload custom templates.
API Entry Points
/api/collectiontemplates: list available collection templates
List Collection Templates
GET /api/collectiontemplates
Input
Path Parameters
None.
Query Parameters
None.
Output
Output Content
A JSON array of available template file names.
Response Codes
200: OK
Examples
Input
curl 'http://localhost:8888/api/collectiontemplates'
Output
["default.zip"]
