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

27 days ago

main
Compare

API structure has changed

The breaking changes in this change summary reflect a change the documentation, not in the behaviour of the APIs. The index settings documentation is the source of truth for those values and the API documentation now links to it.

38 structure changes including:
38 Modifications
Modified 38 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 /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions 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
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
GET /_security/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • security property Modified
        • index property Added
      • security-profile property Modified
        • index property Added
      • security-tokens property Modified
        • index property Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Added
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
POST /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Added
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
PUT /_connector/{connector_id}/_error
  • Body
  • application/json content type Modified
    • error property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_index_name
  • Body
  • application/json content type Modified
    • index_name property Modified
      • NullValue alternative Modified
        • Alternative is now required
PUT /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
PUT /_security/settings
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Added
    • security-profile property Modified
      • index property Added
    • security-tokens property Modified
      • index property Added
PUT /_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • mode, soft_deletes, sort, number_of_routing_shards, check_on_startup, codec, load_fixed_bitset_filters_eagerly, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, uuid, version, max_slices_per_scroll, translog, query_string, top_metrics_max_size, analysis, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • routing_path property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, array-2 properties Removed
      • number_of_shards property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
      • number_of_replicas property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
      • routing_partition_size property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • Stringifiedinteger, Stringifiedinteger properties Removed
      • hidden property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • auto_expand_replicas property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, NullValue properties Removed
      • creation_date property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • UnitMillis, StringifiedEpochTimeUnitMillis properties Removed
      • creation_date_string property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • DateTime, UnitMillis properties Removed
      • verified_before_close property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • format property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, number-2 properties Removed
      • priority property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added