Change Updates

Do not miss any Elasticsearch API changes, ever again

Subscribe to the Elasticsearch API changelog to be up to date on recent changes.

RSS

Jan 31, 2025

main
Compare

API structure has changed

79 structure changes including:
6 Breaking changes
7 Additions
67 Modifications
5 Removals
Modified 67 Breaking
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • lifecycle property Modified
        • prefer_ilm property Added
      • mapping property Modified
        • ignore_malformed property Modified
          • Combinator is now oneOf
        • source property Added
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Modified
      • lifecycle property Modified
        • prefer_ilm property Added
      • mapping property Modified
        • ignore_malformed property Modified
          • Combinator is now oneOf
        • source property Added
POST /_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
POST /_scripts/{id}/{context}
  • Query
  • context query parameter Added
POST /_scripts/{id}
  • Query
  • context query parameter Added
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • id property Added
POST /_render/template
  • Body
  • application/json content type Modified
    • id property Added
POST /_query/async
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columns, id, is_running properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Added
    • index_template_subtitutions property Modified
      • * property Modified
        • template property Modified
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Added
    • index_template_subtitutions property Modified
      • * property Modified
        • template property Modified
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
      • defaults property Modified
        • lifecycle, mapping properties Modified
POST /_async_search
  • Query
  • keep_alive query parameter Added
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Modified
      • lifecycle property Modified
        • prefer_ilm property Added
      • mapping property Modified
        • ignore_malformed property Modified
          • Combinator is now oneOf
        • source property Added
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • result property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • email property Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • result property Modified
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • lifecycle property Modified
        • prefer_ilm property Added
      • mapping property Modified
        • ignore_malformed property Modified
          • Combinator is now oneOf
        • source property Added
PUT /_settings
  • Body
  • application/json content type Modified
    • lifecycle property Modified
      • prefer_ilm property Added
        • boolean-1, string-2 properties Added
    • mapping property Modified
      • ignore_malformed property Modified
        • Combinator is now oneOf
        • ignore_malformed alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • boolean-1, string-2 alternatives Added
      • source property Added
PUT /_security/settings
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Modified
        • lifecycle, mapping properties Modified
    • security-profile property Modified
      • index property Modified
        • lifecycle, mapping properties Modified
    • security-tokens property Modified
      • index property Modified
        • lifecycle, mapping properties Modified
PUT /_scripts/{id}/{context}
  • Query
  • context query parameter Added
PUT /_scripts/{id}
  • Query
  • context query parameter Added
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
PUT /_ilm/policy/{policy}
  • Body
  • application/json content type Modified
    • policy property Modified
      • phases property Modified
        • cold, delete, frozen, hot, warm properties Modified
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
      • defaults property Modified
        • lifecycle, mapping properties Modified
POST /{index}/_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
POST /{index}/_async_search
  • Query
  • keep_alive query parameter Added
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • result property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • email property Modified
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • result property Modified
POST /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • lifecycle property Modified
      • prefer_ilm property Added
        • boolean-1, string-2 properties Added
    • mapping property Modified
      • ignore_malformed property Modified
        • Combinator is now oneOf
        • ignore_malformed alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • boolean-1, string-2 alternatives Added
      • source property Added
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • lifecycle property Modified
        • prefer_ilm property Added
      • mapping property Modified
        • ignore_malformed property Modified
          • Combinator is now oneOf
        • source property Added
GET /_component_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_component_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_ilm/policy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • policy property Modified
GET /_ilm/policy/{policy}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • policy property Modified
GET /_index_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Added
    • index_template_subtitutions property Modified
      • * property Modified
        • template property Modified
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Added
    • index_template_subtitutions property Modified
      • * property Modified
        • template property Modified
GET /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • templates, ilm_policies properties Added
GET /_query/async/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columns, is_running properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /_render/template
  • Body
  • application/json content type Modified
    • id property Added
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • id property Added
GET /_resolve/cluster
  • Path went from /_resolve/cluster/{name} to /_resolve/cluster (same operationId)
    Breaking
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
  • timeout query parameter Added
  • Path
  • name path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • templates, ilm_policies properties Added
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /_xpack/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ilm property Modified
        • policy_stats property Modified
      • frozen_indices property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /_xpack
  • Response
  • 200 response Modified
    • application/json content type Modified
      • features property Modified
        • frozen_indices property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions property Modified
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • lifecycle, mapping properties Modified
GET /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /_security/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • security property Modified
        • index property Modified
      • security-profile property Modified
        • index property Modified
      • security-tokens property Modified
        • index property Modified
GET /_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
Removed 5 Breaking
GET /_migration/reindex/{index}/_status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /_create_from/{source}/{dest}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /_migration/reindex
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /_migration/reindex/{index}/_cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /_create_from/{source}/{dest}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
PUT /_create_from/{source}/{dest}
POST /_query/async/{id}/stop
POST /_migration/reindex/{index}/_cancel
POST /_migration/reindex
POST /_create_from/{source}/{dest}
GET /_resolve/cluster/{name}
GET /_migration/reindex/{index}/_status