Archived settings

If you upgrade a cluster with a deprecated persistent cluster setting to a version that no longer supports the setting, Elasticsearch automatically archives that setting. Similarly, if you upgrade a cluster that contains an index with an unsupported index setting, Elasticsearch archives the index setting.

We recommend you remove any archived settings after upgrading. Archived settings are considered invalid and can interfere with your ability to configure other settings.

Archived settings start with the archived. prefix.

Use the following cluster update settings request to check for archived cluster settings. If the request returns an empty object ({ }), there are no archived cluster settings.

resp = client.cluster.get_settings(
    flat_settings=True,
    filter_path="persistent.archived*",
)
print(resp)

response = client.cluster.get_settings(
  flat_settings: true,
  filter_path: 'persistent.archived*'
)
puts response

const response = await client.cluster.getSettings({
  flat_settings: "true",
  filter_path: "persistent.archived*",
});
console.log(response);

GET _cluster/settings?flat_settings=true&filter_path=persistent.archived*

To remove any archived cluster settings, use the following cluster update settings request.

resp = client.cluster.put_settings(
    persistent={
        "archived.*": None
    },
)
print(resp)

response = client.cluster.put_settings(
  body: {
    persistent: {
      "archived.*": nil
    }
  }
)
puts response

const response = await client.cluster.putSettings({
  persistent: {
    "archived.*": null,
  },
});
console.log(response);

PUT _cluster/settings
{
  "persistent": {
    "archived.*": null
  }
}

Elasticsearch doesn’t archive transient cluster settings or settings in elasticsearch.yml. If a node includes an unsupported setting in elasticsearch.yml, it will return an error at startup.

Archived index settings don’t affect an index’s configuration or most index operations, such as indexing or search. However, you’ll need to remove them before you can configure other settings for the index, such as index.hidden.

Use the following get index settings request to get a list indices with archived settings. If the request returns an empty object ({ }), there are no archived index settings.

resp = client.indices.get_settings(
    index="*",
    flat_settings=True,
    filter_path="**.settings.archived*",
)
print(resp)

response = client.indices.get_settings(
  index: '*',
  flat_settings: true,
  filter_path: '**.settings.archived*'
)
puts response

const response = await client.indices.getSettings({
  index: "*",
  flat_settings: "true",
  filter_path: "**.settings.archived*",
});
console.log(response);

GET */_settings?flat_settings=true&filter_path=**.settings.archived*

To remove any archived index settings, use the following indices update settings request.

resp = client.indices.put_settings(
    index="my-index",
    settings={
        "archived.*": None
    },
)
print(resp)

response = client.indices.put_settings(
  index: 'my-index',
  body: {
    "archived.*": nil
  }
)
puts response

const response = await client.indices.putSettings({
  index: "my-index",
  settings: {
    "archived.*": null,
  },
});
console.log(response);

PUT /my-index/_settings
{
  "archived.*": null
}