Configurations API

The Configurations API allows setting global properties for Fusion. Some settings are not set by any configuration file but are reported as settings from the operating system. Those settings cannot be changed with this API.

Fusion 5 users: This API is blocked on the API gateway by default in Fusion 5 because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.

Examples

Show the configuration items that include the pattern ‘zk-connect’, with verbose enabled: REQUEST

curl -u USERNAME:PASSWORD https://FUSION_HOST:8764/api/configurations?verbose=true&pattern=zk-connect

RESPONSE

{
  "com.lucidworks.apollo-admin.config/zk-connect" : [ {
    "value" : "fusion-host:9983",
    "location" : "system properties"
  } ]
}

Get the configuration items from the Connectors JVM that include the term ‘connect’: REQUEST

curl -u USERNAME:PASSWORD https://FUSION_HOST:8984/connectors/api/v1/configurations?pattern=connect

Get the configuration items from the Fusion JVM that start with ‘com.lucidworks’: REQUEST

https://FUSION_HOST:8764/api/configurations?prefix=com.lucidworks

Change the default allowed recommendation types to include ‘itemsForItem”: REQUEST

curl -u USERNAME:PASSWORD -X PUT -H 'Content-type: application/json' -d '{"itemsForQuery", "termsForDocument", "itemsforItem"}' https://FUSION_HOST:8764/api/configurations/com.lucidworks.apollo.service.recommend.allowed.types

RESPONSE None. Check the setting again to confirm the changes.

Fusion Server

Fusion AI

App Studio

Examples

​Examples

Examples