APIsConfiguration specifications
Table of Contents
When you install a connector or plug-in on Managed Fusion, you do not need to supply the .zip file. The installation obtains the .zip file from the repository. |
How to access the API
How to access individual API endpoints
https://EXAMPLE_COMPANY.b.lucidworks.cloud/SERVICE_NAME/ENDPOINT
Example: https://EXAMPLE_COMPANY.b.lucidworks.cloud/query/query-pipelines
How to access API specs (in JSON format)
https://EXAMPLE_COMPANY.b.lucidworks.cloud/SERVICE_NAME/v2/api-docs
Example: https://EXAMPLE_COMPANY.b.lucidworks.cloud/query/v2/api-docs
List all Managed Fusion component services
The Managed Fusion introspect
endpoint lists basic information about endpoints and parameters for all Managed Fusion endpoints,
including the Connectors services endpoints:
curl -u USERNAME:PASSWORD https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/introspect
Use an API key to authenticate API operations
You can use an API key instead of a username and password combination to power your search application or operations. The following example authenticates a request to check the status of the query service with an API key:
curl -H "x-api-key: API_KEY" " https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/query/status"
For more information, see API Keys.