Get deprecation information

GET /{index}/_migration/deprecations
GET /_migration/deprecations

Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version. You must address the reported issues before upgrading to the next major version. However, no action is required when upgrading within the current major version. Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version. Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.

Note

This API is designed for indirect use by the Upgrade Assistant. We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

cluster_settings object[] required: Cluster-level deprecation warnings.
index_settings map string to object required: Index warnings are sectioned off per index and can be filtered using an index-pattern in the query. This section includes warnings for the backing indices of data streams specified in the request path.
data_streams map string to object required
node_settings object[] required: Node-level deprecation warnings. Since only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.
ml_settings object[] required: Machine learning-related deprecation warnings.
templates map string to object required: Template warnings are sectioned off per template and include deprecations for both component templates and index templates.
ilm_policies map string to object required: ILM policy warnings are sectioned off per policy.

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_migration/deprecations

JavaScript Elasticsearch JavaScript Client

const response = await client.migration.deprecations();

Python Elasticsearch Python Client

resp = client.migration.deprecations()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_migration/deprecations" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.migration().deprecations(d -> d);

PHP Elasticsearch PHP Client

$resp = $client->migration()->deprecations();

Ruby Elasticsearch Ruby Client

response = client.migration.deprecations

Response

An abbreviated response from GET /_migration/deprecations.

{
  "cluster_settings": [
    {
      "level": "critical",
      "message": "Cluster name cannot contain ':'",
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name",
      "details": "This cluster is named [mycompany:logging], which contains the illegal character ':'."
    }
  ],
  "node_settings": [],
  "index_settings": {
    "logs:apache": [
      {
        "level": "warning",
        "message": "Index name cannot contain ':'",
        "url": "https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name",
        "details": "This index is named [logs:apache], which contains the illegal character ':'."
      }
    ]
  },
  "ml_settings": []
}