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

10 days ago

v8
Compare

API structure has changed

This documentation update aligns with the 8.17.0 release. Refer to the Elasticsearch Release Notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/release-notes-8.17.0.html

59 structure changes including:
59 Modifications
Modified 59 Breaking
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 /_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 /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • rule property Added
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by, access 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, access 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 /_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 /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Added
GET /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • rule property 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
POST /_async_search
  • Query
  • keep_alive, pre_filter_shard_size query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_bulk
  • Query
  • list_executed_pipelines, require_data_stream query parameters Added
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 /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • rule property Added
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by, access 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
      • 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 /_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 /{index}/_async_search
  • Query
  • keep_alive, pre_filter_shard_size query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /{index}/_bulk
  • Query
  • list_executed_pipelines, require_data_stream query parameters Added
POST /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • rule property Added
PUT /_bulk
  • Query
  • list_executed_pipelines, require_data_stream query parameters Added
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 /_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
      • 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
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 /{index}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /{index}/_bulk
  • Query
  • list_executed_pipelines, require_data_stream query parameters Added
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