Get deprecation information Generally available; Added in 6.1.0

GET /{index}/_migration/deprecations
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_migration/deprecations

GET /{index}/_migration/deprecations

Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Required authorization

  • Cluster privileges: manage

Path parameters

  • index string Required

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

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • cluster_settings array[object] Required

      Cluster-level deprecation warnings.

      Hide cluster_settings attributes Show cluster_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        The level property describes the significance of the issue.

        Supported values include:

        • none
        • info
        • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
        • critical: You cannot upgrade without fixing this problem.

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • resolve_during_rolling_upgrade boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties
    • index_settings 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.

      Hide index_settings attribute Show index_settings attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          The level property describes the significance of the issue.

          Supported values include:

          • none
          • info
          • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
          • critical: You cannot upgrade without fixing this problem.

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • resolve_during_rolling_upgrade boolean Required
        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties
    • data_streams object Required
      Hide data_streams attribute Show data_streams attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          The level property describes the significance of the issue.

          Supported values include:

          • none
          • info
          • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
          • critical: You cannot upgrade without fixing this problem.

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • resolve_during_rolling_upgrade boolean Required
        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties
    • node_settings array[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.

      Hide node_settings attributes Show node_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        The level property describes the significance of the issue.

        Supported values include:

        • none
        • info
        • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
        • critical: You cannot upgrade without fixing this problem.

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • resolve_during_rolling_upgrade boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties
    • ml_settings array[object] Required

      Machine learning-related deprecation warnings.

      Hide ml_settings attributes Show ml_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        The level property describes the significance of the issue.

        Supported values include:

        • none
        • info
        • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
        • critical: You cannot upgrade without fixing this problem.

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • resolve_during_rolling_upgrade boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties
    • templates object Required

      Template warnings are sectioned off per template and include deprecations for both component templates and index templates.

      Hide templates attribute Show templates attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          The level property describes the significance of the issue.

          Supported values include:

          • none
          • info
          • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
          • critical: You cannot upgrade without fixing this problem.

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • resolve_during_rolling_upgrade boolean Required
        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties
    • ilm_policies object Required

      ILM policy warnings are sectioned off per policy.

      Hide ilm_policies attribute Show ilm_policies attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          The level property describes the significance of the issue.

          Supported values include:

          • none
          • info
          • warning: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.
          • critical: You cannot upgrade without fixing this problem.

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • resolve_during_rolling_upgrade boolean Required
        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties
GET /{index}/_migration/deprecations 
GET /_migration/deprecations 
resp = client.migration.deprecations()
const response = await client.migration.deprecations();
response = client.migration.deprecations
$resp = $client->migration()->deprecations();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_migration/deprecations"
client.migration().deprecations(d -> d);
Response examples (200)
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": [] }