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-targetadded in 1.0 Returns a list of the known buckets used for storage
DELETE/api/v1/bucket-storage-target/idadded in 1.0 Deletes a bucket storage configuration
POST/api/v1/clusterconfig/ingestpartitions/distribute-evenly-from-host/idadded in 1.0 Move partitions between nodes.
GET/api/v1/clusterconfig/ingestpartitionsadded in 1.0 Returns a list of the digest partitions.
POST/api/v1/clusterconfig/ingestpartitionsadded in 1.0 Manage the digest partitions to control manually where each partition is.
POST/api/v1/clusterconfig/ingestpartitions/setdefaultsadded in 1.0 Control partition distribution to nodes in the cluster.
GET/api/v1/clusterconfig/kafka-queues/partition-assignmentadded in 1.0 Returns a list of the Kafka queue settings.
POST/api/v1/clusterconfig/kafka-queues/partition-assignmentadded in 1.0 Modify or update Kafka queue settings.
POST/api/v1/clusterconfig/kafka-queues/partition-assignment/set-replication-defaultsavailable 1.0 to 1.88.2 Apply default Kafka replication settings to all nodes in a cluster.
GET/api/v1/clusterconfig/members/idadded in 1.0 Shows a node in the cluster
PUT/api/v1/clusterconfig/members/idadded in 1.0 Update the configuration of a node in the cluster.
DELETE/api/v1/clusterconfig/members/idadded in 1.0 Delete the configuration of a node in the cluster.
GET/api/v1/clusterconfig/membersadded in 1.0 Returns a list of the nodes that are members of a cluster
POST/api/v1/clusterconfig/segments/distribute-evenly-to-host/id/percentageadded in 1.0 Move existing segments between nodes.
POST/api/v1/clusterconfig/segments/distribute-evenly-reshuffle-all/percentageadded in 1.0 Reshuffle existing segments between nodes.
POST/api/v1/clusterconfig/segments/prune-replicasadded in 1.0 Reduce the number of replicas on existing segments.
POST/api/v1/clusterconfig/segments/distribute-evenlyavailable 1.0 to 1.88.2 Modify settings for segments in a cluster.
POST/api/v1/clusterconfig/segments/distribute-evenly-from-host/id/percentageadded in 1.0 Move existing segments between nodes.
POST/api/v1/clusterconfig/segments/partitionsavailable 1.0 to 1.88.2 Assign the segment partitions to nodes in the cluster.
POST/api/v1/clusterconfig/segments/partitions/setdefaultsavailable 1.0 to 1.88.2 Modify the segment partitions of a node in the cluster.
GET/api/v1/clusterconfig/segments/partitionsavailable 1.0 to 1.88.2 List the segment partitions of a node in the cluster.
GET/api/v1/clusterconfig/segments/segment-statsadded in 1.0 Get the segments statistics.
POST/api/v1/delete-missing-segmentsadded in 1.0 Remove missing segments from the cluster.
GET/api/v1/missing-segmentsadded in 1.0 Returns list of all missing segments in CSV format.
POST/api/v1/repositories/viewname/resurrect-deleted-segmentsadded in 1.0 Restore recently deleted segments.
GET/api/v1/repositories/repository/max-datasourcesadded in 1.0 See the current default limit on the number of datasources.
POST/api/v1/repositories/repository/max-datasourcesadded in 1.0 Set a new value for the maximum number of allowed datasources.
DELETE/api/v1/repositories/repository/datasources/datasourceidadded in 1.0 Marks the datasource for deletion, triggering deletion of all segments in the datasource.
GET/api/v1/repositories/repository/taggroupingadded in 1.0 List repositories grouped by tags in the cluster.
POST/api/v1/repositories/repository/taggroupingadded in 1.0 Apply new tag grouping rules to repositories in the cluster.
DELETE/api/v1/repositories/repository/datasources/datasourceid/segments/segmentidadded in 1.0 Mark a segment file for deletion.
GET/api/v1/repositories/repository/datasources/datasourceid/autoshardingadded in 1.0 Show the autosharding settings for a datasource.
POST/api/v1/repositories/repository/datasources/datasourceid/autosharding/numberadded in 1.0 Update the autosharding settings for a datasource.
DELETE/api/v1/repositories/repository/datasources/datasourceid/autoshardingadded in 1.0 Delete the autosharding settings for a datasource.
GET/api/v1/statusadded in 1.0 Check the health of the cluster.