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.

info 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

Cluster privileges: manage

Path Parameters

index string IndexName optional

Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.

Leave it out to use /_migration/deprecations.

Response

application/json

Examples

An abbreviated response from GET /_migration/deprecations.

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

{
  "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": []
}