Get deprecation information | Elasticsearch API documentation (v9)

Path parameters

indexstring 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_settingsarray[object] Required
  Cluster-level deprecation warnings.
  Hide cluster_settings attributes Show cluster_settings attributes object
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- index_settingsobject 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
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- data_streamsobject Required
  Hide data_streams attribute Show data_streams attribute object
  *array[object] Additional properties
  Hide * attributes Show * attributes object
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- node_settingsarray[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
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- ml_settingsarray[object] Required
  Machine learning-related deprecation warnings.
  Hide ml_settings attributes Show ml_settings attributes object
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- templatesobject 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
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties
- ilm_policiesobject 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
  detailsstring
  Optional details about the deprecation warning.
  levelstring Required
  Values are none, info, warning, or critical.
  messagestring Required
  Descriptive information about the deprecation warning.
  urlstring Required
  A link to the breaking change documentation, where you can find more information about this change.
  resolve_during_rolling_upgradeboolean Required
  _metaobject
  Hide _meta attribute Show _meta attribute object
  *object Additional properties

GET /{index}/_migration/deprecations

GET /_migration/deprecations

curl \
 --request GET 'http://api.example.com/{index}/_migration/deprecations' \
 --header "Authorization: $API_KEY"

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