Settings

Get collection settings

/ Get, / Settings

Get collection settings #

Returns settings information about one or more collections.

Examples #

The following request gets the settings information of all the collections under the default namespace:

GET /default:*/_settings

Retrieve the settings information of all the collections:

GET /_settings

Request #

GET /<target>/_settings

Path Parameters #

  • target
    (Optional, String) Comma-separated, names of the collections to get (wildcard supported)

Runtime node settings and dynamic log level

/ Settings, / Operations, / Observability

Runtime node settings and dynamic log level #

Node-local knobs no longer require a restart. GET/PUT /_node/_local/settings exposes transient overrides over the pizza.yml values — search lane budgets, the slowlog threshold, the default search timeout, trash retention — and they take effect immediately:

# drop the slowlog threshold to 200ms on one node, effective immediately
curl -X PUT http://127.0.0.1:28000/_node/_local/settings \
  -H 'Content-Type: application/json' \
  -d '{"node.search.slow_threshold_ms": 200}'

The flagship: log.level flips live — no restart, no dropped requests — which turns “turn on debug logging on the suspicious node” into a one-liner while preserving target-specific directives like openraft=warn.

...

Update collection settings

/ Update, / Settings, / Collection

Update collection settings #

Update the collection-level settings of an existing collection. The change is applied through the Raft-replicated metadata request, so it survives restarts and reaches every node.

Examples #

Change the default replica count used for newly allocated rollings:

PUT /my-collection/_settings
{
  "rolling": { "number_of_replicas": 2 }
}

Restrict the collection’s shard copies to two nodes:

PUT /my-collection/_settings
{
  "routing": {
    "allocation": {
      "include": { "_id": "node-a,node-b" }
    }
  }
}

The API returns the following result:

...

Update rolling settings

/ Update, / Settings, / Rolling

Update rolling settings #

Adjust the replica count of an existing rolling: every shard group of the rolling gains new unassigned replica shards (allocated by the shard allocator when capacity allows) or has its extra replicas removed, and the rolling’s number_of_replicas setting is updated.

This is the leaf-most level of the layered settings model — it overrides the collection-level default for this rolling only.

Examples #

Scale the rolling 0 of my-collection from 1 to 2 replicas:

...