Lucidworks Search cluster API
The Search Cluster API lets you connect Fusion with existing Solr instances in a Zookeeper-managed cluster.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/lucidworks:lucidworks-search-cluster-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Fusion Admin Search cluster API
description: These APIs provide general administrative functions for your Fusion instance. Use these APIs to manage Fusion objects, App Studio objects, connections to Solr clusters, license files, job schedules, and more. You can also use them to create a history of service events.
termsOfService: https://lucidworks.com/legal/developer-license-agreement/
contact:
name: Lucidworks
url: www.lucidworks.com
email: support@lucidworks.com
license:
name: License of API
url: https://lucidworks.com/legal/developer-license-agreement/
version: '5.9'
servers:
- url: https://{FUSION HOST}/api
description: Fusion
variables:
FUSION HOST:
default: FUSION_HOST
description: Your environment host.
- url: https://{FUSION HOST}/api/apps/{APP_NAME}
description: Fusion app
variables:
FUSION HOST:
default: FUSION_HOST
description: Your environment host.
APP_NAME:
default: APP_NAME
description: The name of your Fusion application.
tags:
- name: Search cluster
description: The Search Cluster API lets you connect Fusion with existing Solr instances in a Zookeeper-managed cluster.
paths:
/searchCluster/status:
get:
tags:
- Search cluster
summary: Get search cluster service status
description: Check the status of the Search Cluster service.
operationId: getStatus_20
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceStatus'
/searchCluster:
get:
tags:
- Search cluster
summary: List all clusters
description: Return the definitions for all existing clusters.
operationId: listSearchClusters_1
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchCluster'
post:
tags:
- Search cluster
summary: Create a cluster
description: Create a new cluster definition.
operationId: createSearchCluster
parameters:
- name: validate
in: query
description: Before creating the cluster definition, verify that Fusion can connect to this new search cluster correctly.
schema:
type: boolean
requestBody:
description: JSON-formatted cluster configuration values.
content:
application/json:
schema:
$ref: '#/components/schemas/SearchCluster'
required: false
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/SearchCluster'
x-codegen-request-body-name: body
/searchCluster/{id}:
get:
tags:
- Search cluster
summary: Get a cluster
description: Return the definition for the specified cluster.
operationId: getSearchCluster
parameters:
- name: id
in: path
description: The cluster ID.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/SearchCluster'
put:
tags:
- Search cluster
summary: Update a cluster
description: Update a cluster definition.
operationId: createOrUpdateSearchCluster
parameters:
- name: id
in: path
description: The cluster ID.
required: true
schema:
type: string
- name: If-Match
in: header
description: An optional tag to match against the specified blob.
schema:
type: string
default: '-1'
- name: validate
in: query
description: Validate the updated cluster definition before saving it.
schema:
type: boolean
requestBody:
description: JSON-formatted cluster configuration values.
content:
application/json:
schema:
$ref: '#/components/schemas/SearchCluster'
required: false
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/SearchCluster'
x-codegen-request-body-name: body
delete:
tags:
- Search cluster
summary: Delete a cluster
description: Delete a cluster definition.
operationId: deleteSearchCluster
parameters:
- name: id
in: path
description: The cluster ID.
required: true
schema:
type: string
- name: If-Match
in: header
description: An optional tag to match against the specified blob.
schema:
type: string
default: '-1'
responses:
'200':
description: successful operation
content: {}
/searchCluster/{id}/systemInfo:
get:
tags:
- Search cluster
summary: Get search cluster system info
description: Return details about a search cluster, including the JVM version, the OS, free space available, and so on.
operationId: getSystemInfo
parameters:
- name: id
in: path
description: The cluster ID.
required: true
schema:
type: string
- name: nodeName
in: query
description: Return information only for the named node.
schema:
type: string
- name: all
in: query
description: When true, system information for every node of the cluster is returned.
schema:
type: boolean
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/SystemInfo'
/searchCluster/{id}/nodes:
get:
tags:
- Search cluster
summary: Get cluster nodes status
description: Get the status of each node of the cluster.
operationId: getClusterState
parameters:
- name: id
in: path
description: The cluster ID.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/Node'
/searchCluster/_schema:
get:
tags:
- Search cluster
summary: Get the search cluster schema
description: Fetch the JSON schema for all configuration values.
operationId: getSchema_2
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectType'
components:
schemas:
JVMRawMemoryInfo:
type: object
properties:
free:
type: integer
format: int64
total:
type: integer
format: int64
max:
type: integer
format: int64
used:
type: integer
format: int64
used%:
type: number
format: double
AnyType:
type: object
properties:
type:
type: string
readOnly: true
enum:
- String
- Number
- Integer
- Boolean
- Object
- Array
- 'Null'
- Ref
title:
type: string
readOnly: true
description:
type: string
readOnly: true
enum:
uniqueItems: true
type: array
readOnly: true
items:
type: object
properties: {}
default:
type: object
properties: {}
readOnly: true
category:
type: string
readOnly: true
categoryPriority:
type: integer
format: int32
readOnly: true
hints:
uniqueItems: true
type: array
readOnly: true
items:
type: string
unsafe:
type: boolean
readOnly: true
oneOf:
type: array
readOnly: true
items:
$ref: '#/components/schemas/AnyTypeObjectObject'
PropertyGroup:
type: object
properties:
label:
type: string
readOnly: true
properties:
type: array
readOnly: true
items:
type: string
ServiceStatus:
type: object
properties:
status:
type: string
enum:
- starting
- ok
- warning
- error
- shutdown
node:
type: string
readOnly: true
messages:
type: array
readOnly: true
items:
$ref: '#/components/schemas/StatusMessage'
StatusMessage:
type: object
properties:
date:
type: string
format: date-time
readOnly: true
message:
type: string
readOnly: true
ObjectType:
type: object
properties:
type:
type: string
readOnly: true
enum:
- String
- Number
- Integer
- Boolean
- Object
- Array
- 'Null'
- Ref
title:
type: string
readOnly: true
description:
type: string
readOnly: true
required:
uniqueItems: true
type: array
readOnly: true
items:
type: string
properties:
type: object
additionalProperties:
$ref: '#/components/schemas/AnyType'
readOnly: true
additionalProperties:
type: object
properties: {}
readOnly: true
minProperties:
type: integer
format: int32
readOnly: true
maxProperties:
type: integer
format: int32
readOnly: true
definitions:
type: object
additionalProperties:
$ref: '#/components/schemas/AnyType'
readOnly: true
category:
type: string
readOnly: true
categoryPriority:
type: integer
format: int32
readOnly: true
enum:
uniqueItems: true
type: array
readOnly: true
items:
type: object
properties: {}
hints:
uniqueItems: true
type: array
readOnly: true
items:
type: string
unsafe:
type: boolean
readOnly: true
default:
type: object
properties: {}
readOnly: true
oneOf:
type: array
readOnly: true
items:
$ref: '#/components/schemas/AnyTypeObjectObject'
propertyGroups:
type: array
readOnly: true
items:
$ref: '#/components/schemas/PropertyGroup'
SystemInfo:
type: object
properties:
mode:
type: string
enum:
- std
- solrcloud
baseUrl:
type: string
lucene:
$ref: '#/components/schemas/Version'
jvm:
$ref: '#/components/schemas/JVMInfo'
system:
$ref: '#/components/schemas/HostInfo'
AnyTypeObjectObject:
type: object
properties:
type:
type: string
readOnly: true
enum:
- String
- Number
- Integer
- Boolean
- Object
- Array
- 'Null'
- Ref
title:
type: string
readOnly: true
description:
type: string
readOnly: true
enum:
uniqueItems: true
type: array
readOnly: true
items:
type: object
properties: {}
default:
type: object
properties: {}
readOnly: true
category:
type: string
readOnly: true
categoryPriority:
type: integer
format: int32
readOnly: true
hints:
uniqueItems: true
type: array
readOnly: true
items:
type: string
unsafe:
type: boolean
readOnly: true
oneOf:
type: array
readOnly: true
items:
$ref: '#/components/schemas/AnyTypeObjectObject'
JVMMemoryInfo:
type: object
properties:
raw:
$ref: '#/components/schemas/JVMRawMemoryInfo'
AuthConfig:
type: object
properties:
authType:
type: string
readOnly: true
enum:
- NONE
- BASIC
- KERBEROS
username:
type: string
readOnly: true
password:
type: string
readOnly: true
keyTab:
type: string
readOnly: true
principal:
type: string
readOnly: true
SearchCluster:
type: object
properties:
id:
type: string
readOnly: true
connectString:
type: string
readOnly: true
zkClientTimeout:
type: integer
format: int32
readOnly: true
zkConnectTimeout:
type: integer
format: int32
readOnly: true
cloud:
type: boolean
readOnly: true
bufferFlushInterval:
type: integer
format: int32
readOnly: true
bufferSize:
type: integer
format: int32
readOnly: true
concurrency:
type: integer
format: int32
readOnly: true
authConfig:
$ref: '#/components/schemas/AuthConfig'
validateCluster:
type: boolean
HostInfo:
type: object
properties:
name:
type: string
version:
type: string
arch:
type: string
systemLoadAverage:
type: number
format: double
committedVirtualMemorySize:
type: integer
format: int64
freePhysicalMemorySize:
type: integer
format: int64
freeSwapSpaceSize:
type: integer
format: int64
processCpuTime:
type: integer
format: int64
totalPhysicalMemorySize:
type: integer
format: int64
totalSwapSpaceSize:
type: integer
format: int64
openFileDescriptorCount:
type: integer
format: int64
maxFileDescriptorCount:
type: integer
format: int64
uname:
type: string
uptime:
type: string
JVMInfo:
type: object
properties:
version:
type: string
name:
type: string
processors:
type: integer
format: int32
memory:
$ref: '#/components/schemas/JVMMemoryInfo'
Node:
type: object
properties:
name:
type: string
readOnly: true
baseUrl:
type: string
readOnly: true
state:
type: string
readOnly: true
Version:
type: object
properties:
solr-spec-version:
type: string
lucene-spec-version:
type: string
securitySchemes:
Basic_auth:
type: http
scheme: basic
API_key:
name: x-api-key
type: apiKey
in: header
x-original-swagger-version: '2.0'
x-provenance:
method: harvested
publisher: Lucidworks
source: https://doc.lucidworks.com/api-reference/5.9/fusion-api-swagger.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)