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 LogScale installations.

All requests except the status and autosharding endpoints require root-level access. See Managing 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


HTTP MethodURIDescription
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/clusterconfig/ingestpartitions/setdefaults Control partition distribution to nodes in the cluster.
POST/api/v1/clusterconfig/ingestpartitions/distribute-evenly-from-host/id Move partitions between nodes.
POST/api/v1/clusterconfig/ingestpartitions 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/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.
GET/api/v1/clusterconfig/members Returns a list of the nodes that are members of a cluster
POST/api/v1/clusterconfig/segments/distribute-evenly-to-host/id/percentage Move existing segments between nodes.
POST/api/v1/clusterconfig/segments/distribute-evenly-reshuffle-all/percentage Reshuffle existing segments between nodes.
POST/api/v1/clusterconfig/segments/prune-replicas Reduce the number of replicas on existing segments.
POST/api/v1/clusterconfig/segments/distribute-evenly-from-host/id/percentage Move existing segments between nodes.
POST/api/v1/delete-missing-segments Remove missing segments from the cluster.
GET/api/v1/globalsubset/clustervhost Returns information about the cluster and current node.
GET/api/v1/missing-segments Returns list of all missing segments in CSV format.
POST/api/v1/repositories/viewname/resurrect-deleted-segments Restore recently deleted segments.
DELETE/api/v1/repositories/repository/datasources/datasourceid/segments/segmentid Delete a segment file from metadata 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/number 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.
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/status Check whether node can be reached and current version.