Cluster Management API

The Cluster Management API is the primary endpoint for actions related to settings and management of all parts of a cluster, including repositories, segments, nodes, and storage buckets. The information is for users managing self-hosted Falcon LogScale installations.

All requests except the status and autosharding endpoints require root-level access. See Manage root access.

Refer to the Cluster Management documentation for more details on how to perform common tasks like adding and removing nodes from a cluster.

For a list of the supported endpoints and methods, see the table below.

Available Endpoints

Table:

HTTP MethodURIAvailabilityDescription
GET/api/v1/bucket-storage-target  Returns a list of the known buckets used for storage
DELETE/api/v1/bucket-storage-target/id  Deletes a bucket storage configuration
POST/api/v1/bucket-storage-target/update-segments-storage-targetadded in 1.177 Change the bucket entity references in all relevant segment entities.
POST/api/v1/bucket-storage-target/update-uploaded-files-storage-targetadded in 1.182 Update uploaded files storage target.
POST/api/v1/clusterconfig/ingestpartitions/setdefaultsremoved in 1.133 Control partition distribution to nodes in the cluster.
POST/api/v1/clusterconfig/ingestpartitions/distribute-evenly-from-host/idremoved in 1.133 Move partitions between nodes.
POST/api/v1/clusterconfig/ingestpartitionsremoved in 1.133 Manage the digest partitions to control manually where each partition is.
GET/api/v1/clusterconfig/ingestpartitions  Returns a list of the digest partitions.
GET/api/v1/clusterconfig/kafka-queues/partition-assignmentremoved in 1.147 Returns a list of the Kafka queue settings.
POST/api/v1/clusterconfig/kafka-queues/partition-assignmentremoved in 1.147 Modify or update Kafka queue settings.
GET/api/v1/clusterconfig/members  Returns a list of the nodes that are members of a cluster
GET/api/v1/clusterconfig/members/id  Shows a node in the cluster
PUT/api/v1/clusterconfig/members/id  Update the configuration of a node in the cluster.
DELETE/api/v1/clusterconfig/members/id  Delete the configuration of a node in the cluster.
POST/api/v1/clusterconfig/segments/distribute-evenly-reshuffle-all/percentageremoved in 1.133 Reshuffle existing segments between nodes.
POST/api/v1/clusterconfig/segments/distribute-evenly-to-host/id/percentageremoved in 1.133 Move existing segments between nodes.
POST/api/v1/clusterconfig/segments/distribute-evenly-from-host/id/percentageremoved in 1.133 Move existing segments between nodes.
POST/api/v1/clusterconfig/segments/prune-replicasremoved in 1.133 Reduce the number of replicas on existing segments.
GET/api/v1/clusterconfig/segments/segment-stats  Get the segments statistics.
POST/api/v1/delete-missing-segments  Remove missing segments from the cluster.
GET/api/v1/missing-segments  Returns list of all missing segments in CSV format.
GET/api/v1/repositories/repository/taggrouping  List repositories grouped by tags in the cluster.
POST/api/v1/repositories/repository/taggrouping  Apply new tag grouping rules to repositories in the cluster.
GET/api/v1/repositories/repository/datasources/datasourceid/autosharding  Show the autosharding settings for a datasource.
POST/api/v1/repositories/repository/datasources/datasourceid/autosharding/number  Update the autosharding settings for a datasource.
DELETE/api/v1/repositories/repository/datasources/datasourceid/autosharding  Delete the autosharding settings for a datasource.
GET/api/v1/repositories/repository/max-datasources  See the current default limit on the number of datasources.
POST/api/v1/repositories/repository/max-datasources  Set a new value for the maximum number of allowed datasources.
DELETE/api/v1/repositories/repository/datasources/datasourceid  Marks the datasource for deletion, triggering deletion of all segments in the datasource.
POST/api/v1/repositories/repository/datasources/datasourceid/segments/segmentid/unset-bucket-idadded in 1.219 Unset bucket ID for segments on disk but not in bucket storage
DELETE/api/v1/repositories/repository/datasources/datasourceid/segments/segmentid  Mark a segment file for deletion.
POST/api/v1/repositories/viewname/resurrect-deleted-segments  Restore recently deleted segments.
GET/api/v1/status  Check the health of the cluster.