Looking for the old docs site? You can still view it for a limited time here.

Clusters API

Use the Clusters APIs to manage your Solr clusters in Lucidworks Managed Search:

  • Create Solr clusters in Lucidworks Managed Search.

  • List all of your organization’s Solr clusters.

  • Get detailed information about a specific Solr cluster.

  • Using the PUT method, modify one or more attributes of a Solr cluster.

  • Using the PATCH method, modify one or more attributes of a Solr cluster.

  • Delete a Solr cluster.

Overview of endpoints and methods

The Clusters API has these endpoints and methods:

Method Use

Clusters
Endpoint: customers/customerId/clusters

GET

Get a list of all Solr clusters.

POST

Create a Solr cluster.

A specific cluster
Endpoint: customers/customerId/clusters/clusterId

GET

Get information about a Solr cluster.

PUT

Modify one or more attributes of a Solr cluster. The operation is atomic; either all attributes are updated or none of them are (if the operation fails).

PATCH

Modify one or more attributes of a Solr cluster. Unlike with PUT, the values of optional attributes that aren’t specified in the PATCH command remain unchanged.

DELETE

Delete a Solr cluster.

To obtain HTTP request URIs, prepend https://pg01.us-west1.cloud.lucidworks.com/managed/api/ to the endpoints shown. For example, the HTTP request URI for the endpoint customers/customerId/clusters is https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/customerId/clusters.

Caution
PUT replaces all optional attributes that aren’t specified with their default values. If nondefault values of optional attributes are desired, specify the desired values for those attributes when using PUT. Alternatively, use PATCH.