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

Collections API

Use the Collections APIs to manage collections:

  • Create a Solr collection.

  • List all collections in a Solr cluster.

  • Get information about a collection.

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

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

  • Delete a Solr collection.

Overview of endpoints and methods

The Collections API has these endpoints and methods:

Method Use

Collections
Endpoint: customers/customerId/clusters/clusterId/collections

GET

Get a list of collections.

POST

Create a collection.

A specific collection
Endpoint: customers/customerId/clusters/clusterId/collections/collectionName

GET

Get information about a collection.

PUT

Modify one or more attributes of a collection. 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 collection.

DELETE

Delete a collection.

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/clusterId/collections is https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/customerId/clusters/clusterId/collections.