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

Changelog

Last update:
Compare
57 structure changes including:
57 Modifications
Modified 57 Breaking
GET /_alias
  • Query
  • master_timeout query parameter Added
GET /_alias/{name}
  • Query
  • master_timeout query parameter Added
GET /_async_search/status/{id}
  • Query
  • keep_alive query parameter 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 /_health_report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indicators property Modified
        • file_settings property Added
GET /_health_report/{feature}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indicators property Modified
        • file_settings property Added
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 /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cluster_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • index_settings property Modified
        • * property Modified
      • data_streams property Modified
        • * property Modified
      • node_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • ml_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
GET /_nodes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_security/_authenticate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_key property Modified
        • name property Modified
          • Property is no longer required
        • creation, expiration, invalidated, realm, realm_type, username, profile_uid, metadata, role_descriptors, limited_by, _sort properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
GET /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * 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 /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties 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 /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • trigger property Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_alias
  • Query
  • master_timeout query parameter Added
GET /{index}/_alias/{name}
  • Query
  • master_timeout query parameter Added
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cluster_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • index_settings property Modified
        • * property Modified
      • data_streams property Modified
        • * property Modified
      • node_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • ml_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
HEAD /_alias/{name}
  • Query
  • master_timeout query parameter Added
HEAD /{index}/_alias/{name}
  • Query
  • master_timeout query parameter Added
POST /_async_search
  • Query
  • keep_alive, pre_filter_shard_size, scroll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
      • defaults property Modified
        • mapping property Modified
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
  • 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
        • mapping property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property 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/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Modified
      • mapping property Modified
        • total_fields property Modified
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
POST /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
POST /{index}/_async_search
  • Query
  • keep_alive, pre_filter_shard_size, scroll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
      • defaults property Modified
        • mapping property Modified
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
PUT /_settings
  • Body
  • application/json content type Modified
    • mapping property Modified
      • total_fields property Modified
        • limit, ignore_dynamic_beyond_limit properties Modified
          • Combinator is now oneOf
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • mapping property Modified
      • total_fields property Modified
        • limit, ignore_dynamic_beyond_limit properties Modified
          • Combinator is now oneOf
32 structure changes including:
32 Modifications
Modified 32 Breaking
DELETE /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
GET /_autoscaling/capacity
  • Query
  • master_timeout query parameter Added
GET /_autoscaling/policy/{name}
  • Query
  • master_timeout query parameter Added
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 /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Added
GET /_query_rules
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • rule_type_counts property Added
GET /_security/_authenticate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_key property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/_query/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
GET /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/privilege/_builtin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remote_cluster property Added
GET /_security/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster properties Added
GET /_security/role/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster properties Added
GET /_security/service
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/user/_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • names property Modified
          • Combinator is now oneOf
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Added
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
POST /_security/_query/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/api_key/grant
  • Body
  • application/json content type Modified
    • api_key property Modified
      • role_descriptors property Modified
        • object-1, array-2 alternatives Modified
POST /_security/cross_cluster/api_key
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • names property Modified
          • Combinator is now oneOf
        • allow_restricted_indices property Added
      • search property Modified
        • names property Modified
          • Combinator is now oneOf
POST /_security/role
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified
        • Combinator is now oneOf
        • names alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:IndexName, array-2 alternatives Added
    • remote_indices property Modified
      • names property Modified
        • Combinator is now oneOf
        • names alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:IndexName, array-2 alternatives Added
    • remote_cluster property Added
POST /{index}/_pit
  • Query
  • allow_partial_search_results query parameter Added
PUT /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
PUT /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
PUT /_security/api_key/{id}
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
PUT /_security/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • names property Modified
          • Combinator is now oneOf
        • allow_restricted_indices property Added
      • search property Modified
        • names property Modified
          • Combinator is now oneOf
PUT /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified
        • Combinator is now oneOf
        • names alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:IndexName, array-2 alternatives Added
    • remote_indices property Modified
      • names property Modified
        • Combinator is now oneOf
        • names alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:IndexName, array-2 alternatives Added
    • remote_cluster property Added
31 structure changes including:
31 Modifications
Modified 31 Breaking
GET /_cat/allocation
  • Query
  • local query parameter Added
GET /_cat/allocation/{node_id}
  • Query
  • local query parameter Added
GET /_cat/component_templates
  • Query
  • local query parameter Added
GET /_cat/component_templates/{name}
  • Query
  • local query parameter Added
GET /_cat/master
  • Query
  • local query parameter Added
GET /_cat/nodeattrs
  • Query
  • local query parameter Added
GET /_cat/pending_tasks
  • Query
  • local query parameter Added
GET /_cat/plugins
  • Query
  • local query parameter Added
GET /_cat/segments
  • Query
  • local query parameter Added
GET /_cat/segments/{index}
  • Query
  • local query parameter Added
GET /_cat/templates
  • Query
  • local query parameter Added
GET /_cat/templates/{name}
  • Query
  • local query parameter Added
GET /_cat/thread_pool
  • Query
  • local query parameter Added
GET /_cat/thread_pool/{thread_pool_patterns}
  • Query
  • local query parameter Added
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_tasks
  • Query
  • node_id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • nodes query parameter Added
GET /{index}/_fleet/_fleet_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_async_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_text_structure/find_structure
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest_pipeline property Modified
        • processors property Modified
POST /{index}/_async_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /{index}/_fleet/_fleet_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /_ingest/pipeline/{id}
  • Body
  • application/json content type Modified
    • on_failure property Modified
      • ip_location property Added
    • processors property Modified
      • ip_location property Added
15 structure changes including:
2 Additions
13 Modifications
Modified 13 Breaking
GET /_alias
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_alias/{name}
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
GET /_segments
  • Query
  • verbose query parameter 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
        • logsdb property Added
GET /{index}/_alias
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_alias/{name}
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
GET /{index}/_segments
  • Query
  • verbose query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
HEAD /_alias/{name}
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
HEAD /{index}/_alias/{name}
  • Query
  • local query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
POST /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
Added 2
POST /_security/cross_cluster/api_key
PUT /_security/cross_cluster/api_key/{id}