getSettings #

Retrieves the Elasticsearch index settings for the specified Kuzzle collection.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/<index>/<collection>/_settings
Method: GET

Other protocols #

{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "collection",
  "action": "getSettings",
}

Arguments #

collection: collection name
index: index name

Response #

Returns a setting object with the following structure:

{
  "status": 200,
  "error": null,
  "action": "getSettings",
  "controller": "collection",
  "collection": "<collection>",
  "index": "<index>",
  "headers": {},
  "result": {
    "routing": {
      "allocation": {
        "include": {
          "_tier_preference": "data_content"
        }
      }
    },
    "number_of_shards": "1",
    "provided_name": "&platform.config",
    "creation_date": "1738682329397",
    "number_of_replicas": "1",
    "uuid": "aY0IBbKJSvuIrwqqYyKkUw",
    "version": {
      "created": "7160299"
    }
  },
}

Possible errors #

Edit this page on Github