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

This documentation update aligns with the 8.18.0 release. Check out the release notes.

441 structure changes including:
5 Breaking changes
29 Additions
410 Modifications
2 Removals
Modified 410 Breaking
POST /_ml/data_frame/_evaluate
  • Body
  • application/json content type Modified
    • query model Modified
POST /_mget
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • get:GetResult, mget:MultiGetError alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • GetResult, MultiGetError alternatives Added
POST /_license/start_trial
  • Query
  • master_timeout query parameter Added
POST /_license/start_basic
  • Query
  • master_timeout, timeout query parameters Added
POST /_license
  • Query
  • master_timeout, timeout query parameters Added
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
    • mapping_addition property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure, processors properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
      • processors property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error, processor_results properties Modified
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
      • processors property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error, processor_results properties Modified
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
    • mapping_addition property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure, processors properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
POST /_inference/{task_type}/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • text_embedding_bits property Added
POST /_inference/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • text_embedding_bits property Added
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings property Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, mappings, settings properties Modified
  • Query
  • create, cause query parameters Added
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings property Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, mappings, settings properties Modified
  • Query
  • cause query parameter Added
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings property Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, mappings, settings properties Modified
  • Query
  • cause query parameter Added
POST /_forcemerge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /_flush
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /_field_caps
  • Body
  • application/json content type Modified
    • index_filter model Modified
POST /_features/_reset
  • Query
  • master_timeout query parameter Added
POST /_delete_by_query/{task_id}/_rethrottle
  • Response
  • 200 response Modified
    • application/json content type Modified
      • node_failures property Modified
        • root_cause, suppressed properties Modified
      • task_failures property Modified
        • reason property Modified
POST /_count
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings, defaults properties Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
POST /_cluster/voting_config_exclusions
  • Query
  • master_timeout query parameter Added
POST /_cluster/allocation/explain
  • Query
  • master_timeout query parameter Added
GET /{index}/_mtermvectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error property Modified
POST /_security/_query/role
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, remote_indices properties Modified
POST /_security/_query/api_key
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by, access properties Modified
POST /_searchable_snapshots/cache/clear
  • Query
  • pretty, human query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
  • Query
  • master_timeout query parameter Added
POST /_search/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /_search/scroll/{scroll_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /_search/scroll
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • retriever property Modified
      • standard property Modified
        • filter, query, sort, collapse properties Modified
      • knn property Modified
        • filter property Modified
        • rescore_vector property Added
      • rrf property Modified
        • filter, retrievers properties Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /_scripts/painless/_execute
  • Body
  • application/json content type Modified
    • context_setup property Modified
      • query model Modified
POST /_reindex
  • Body
  • application/json content type Modified
    • source property Modified
      • query model Modified
      • sort property Modified
        • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • cause property Modified
POST /_refresh
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query model Modified
POST /_query/async
  • Body
  • application/json content type Modified
    • filter model Modified
    • wait_for_completion_timeout property Added
POST /_query
  • Body
  • application/json content type Modified
    • filter model Modified
POST /_nodes/{node_id}/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
POST /_nodes/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
POST /_mtermvectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error property Modified
POST /_msearch/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /_monitoring/{type}/bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error property Modified
        • root_cause, suppressed properties Modified
POST /_monitoring/bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error property Modified
        • root_cause, suppressed properties Modified
POST /_ml/trained_models/{model_id}/deployment/_update
  • Body
  • application/json content type Modified
    • adaptive_allocations property Added
POST /_ml/trained_models/{model_id}/deployment/_start
  • Body
  • application/json content type Added
POST /_ml/datafeeds/{datafeed_id}/_update
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query model Modified
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query model Modified
    • job_config property Modified
      • datafeed_config property Modified
        • query model Modified
POST /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query model Modified
    • job_config property Modified
      • datafeed_config property Modified
        • query model Modified
GET /{index}/_msearch/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • templates, ilm_policies properties Added
GET /{index}/_mget
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • get:GetResult, mget:MultiGetError alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • GetResult, MultiGetError alternatives Added
GET /{index}/_mapping
  • Query
  • local query parameter Modified
    • Query parameter is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • item, mappings properties Modified
GET /{index}/_lifecycle/explain
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
GET /{index}/_knn_search
  • Body
  • application/json content type Modified
    • filter property Modified
      • array-2 alternative Modified
        • QueryContainer model Modified
      • query_dsl:QueryContainer alternative Removed
      • QueryContainer alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
GET /{index}/_ilm/explain
  • Query
  • timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_graph/explore
  • Body
  • application/json content type Modified
    • connections property Modified
      • query model Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • reason property Modified
GET /{index}/_flush
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /{index}/_field_usage_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • master_timeout, timeout, wait_for_active_shards query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_field_caps
  • Body
  • application/json content type Modified
    • index_filter model Modified
GET /{index}/_explain/{id}
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • explanation property Modified
        • details property Modified
GET /{index}/_eql/search
  • Body
  • application/json content type Modified
    • filter property Modified
      • array-2 alternative Modified
        • QueryContainer model Modified
      • query_dsl:QueryContainer alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • QueryContainer alternative Added
    • allow_partial_search_results, allow_partial_sequence_results, max_samples_per_key properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shard_failures property Added
  • Query
  • allow_partial_search_results, allow_partial_sequence_results query parameters Added
GET /{index}/_count
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_ccr/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • shards property Modified
  • Query
  • timeout query parameter Added
GET /{index}/_ccr/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • follower_indices property Modified
        • parameters property Modified
  • Query
  • master_timeout query parameter Added
GET /{index}/_analyze
  • Body
  • application/json content type Modified
  • Query
  • index query parameter Added
GET /{index}/_alias/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_alias
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, input, transform, trigger properties Modified
GET /_watcher/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_ccr/auto_follow/{name}/resume
  • Query
  • master_timeout query parameter Added
POST /_ccr/auto_follow/{name}/pause
  • Query
  • master_timeout query parameter Added
POST /_cache/clear
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • index query parameter Added
POST /_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
  • Query
  • include_source_on_error query parameter Added
POST /_async_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • response property Modified
        • _clusters, hits, profile, _shards properties Modified
POST /_application/search_application/{name}/_search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /_analyze
  • Body
  • application/json content type Modified
  • Query
  • index query parameter Added
POST /_aliases
  • Body
  • application/json content type Modified
    • actions property Modified
      • add property Modified
        • filter model Modified
HEAD /_index_template/{name}
  • Query
  • local, flat_settings query parameters Added
GET /{index}/_validate/query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_termvectors/{id}
  • Body
  • application/json content type Modified
    • fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added
GET /{index}/_termvectors
  • Body
  • application/json content type Modified
    • fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added
GET /{index}/_terms_enum
  • Body
  • application/json content type Modified
    • index_filter model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
      • _shards property Modified
        • failures property Modified
      • _all property Modified
        • primaries, shards, total properties Modified
GET /{index}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
      • _shards property Modified
        • failures property Modified
      • _all property Modified
        • primaries, shards, total properties Modified
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /{index}/_segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
  • Query
  • master_timeout query parameter Added
GET /{index}/_search/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • retriever property Modified
      • standard property Modified
        • filter, query, sort, collapse properties Modified
      • knn property Modified
        • filter property Modified
        • rescore_vector property Added
      • rrf property Modified
        • filter, retrievers properties Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /{index}/_rollup_search
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
GET /{index}/_reload_search_analyzers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • resource query parameter Added
GET /{index}/_refresh
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /{index}/_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query model Modified
GET /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Body
  • application/json content type Modified
    • query model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
POST /{index}/_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
  • Query
  • master_timeout query parameter Added
POST /{index}/_search/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • retriever property Modified
      • standard property Modified
        • filter, query, sort, collapse properties Modified
      • knn property Modified
        • filter property Modified
        • rescore_vector property Added
      • rrf property Modified
        • filter, retrievers properties Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /{index}/_rollup_search
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
POST /{index}/_reload_search_analyzers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • resource query parameter Added
POST /{index}/_refresh
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query model Modified
POST /{index}/_pit
  • Body
  • application/json content type Modified
    • index_filter model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • max_concurrent_shard_requests query parameter Added
POST /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Body
  • application/json content type Modified
    • query model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
POST /{index}/_mtermvectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error property Modified
POST /{index}/_msearch/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /{index}/_mget
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • get:GetResult, mget:MultiGetError alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • GetResult, MultiGetError alternatives Added
POST /{index}/_mapping
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_knn_search
  • Body
  • application/json content type Modified
    • filter property Modified
      • array-2 alternative Modified
        • QueryContainer model Modified
      • query_dsl:QueryContainer alternative Removed
      • QueryContainer alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
POST /{index}/_graph/explore
  • Body
  • application/json content type Modified
    • connections property Modified
      • query model Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • reason property Modified
POST /{index}/_forcemerge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_flush
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
POST /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
POST /{index}/_field_caps
  • Body
  • application/json content type Modified
    • index_filter model Modified
POST /{index}/_explain/{id}
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • explanation property Modified
        • details property Modified
POST /{index}/_eql/search
  • Body
  • application/json content type Modified
    • filter property Modified
      • array-2 alternative Modified
        • QueryContainer model Modified
      • query_dsl:QueryContainer alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • QueryContainer alternative Added
    • allow_partial_search_results, allow_partial_sequence_results, max_samples_per_key properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shard_failures property Added
  • Query
  • allow_partial_search_results, allow_partial_sequence_results query parameters Added
POST /{index}/_doc/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • include_source_on_error query parameter Added
POST /{index}/_doc
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • include_source_on_error query parameter Added
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
PUT /_monitoring/{type}/bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error property Modified
        • root_cause, suppressed properties Modified
PUT /_monitoring/bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error property Modified
        • root_cause, suppressed properties Modified
PUT /_ml/trained_models/{model_id}
  • Body
  • application/json content type Modified
    • definition property Modified
      • trained_model property Modified
        • ensemble property Modified
    • inference_config property Modified
      • text_classification property Modified
        • tokenization property Modified
        • vocabulary property Added
      • zero_shot_classification property Modified
        • tokenization property Modified
      • fill_mask property Modified
        • tokenization property Modified
      • ner property Modified
        • tokenization property Modified
      • pass_through property Modified
        • tokenization property Modified
      • text_embedding property Modified
        • tokenization property Modified
      • text_expansion property Modified
        • tokenization property Modified
      • question_answering property Modified
        • tokenization property Modified
      • learning_to_rank property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • inference_config property Modified
        • text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering properties Modified
        • learning_to_rank property Added
      • platform_architecture property Added
PUT /_ml/datafeeds/{datafeed_id}
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query model Modified
PUT /_ml/anomaly_detectors/{job_id}
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query model Modified
PUT /_license
  • Query
  • master_timeout, timeout query parameters Added
PUT /_ingest/pipeline/{id}
  • Body
  • application/json content type Modified
    • on_failure property Modified
      • append property Modified
        • on_failure property Modified
      • attachment property Modified
        • on_failure property Modified
      • bytes property Modified
        • on_failure property Modified
      • circle property Modified
        • on_failure property Modified
      • community_id property Modified
        • on_failure property Modified
      • convert property Modified
        • on_failure property Modified
      • csv property Modified
        • on_failure property Modified
      • date property Modified
        • on_failure property Modified
      • date_index_name property Modified
        • on_failure property Modified
      • dissect property Modified
        • on_failure property Modified
      • dot_expander property Modified
        • on_failure property Modified
      • drop property Modified
        • on_failure property Modified
      • enrich property Modified
        • on_failure property Modified
      • fail property Modified
        • on_failure property Modified
      • fingerprint property Modified
        • on_failure property Modified
      • foreach property Modified
        • on_failure property Modified
      • ip_location property Modified
        • on_failure property Modified
      • geo_grid property Modified
        • on_failure property Modified
      • geoip property Modified
        • on_failure property Modified
      • grok property Modified
        • on_failure property Modified
      • gsub property Modified
        • on_failure property Modified
      • html_strip property Modified
        • on_failure property Modified
      • inference property Modified
        • on_failure property Modified
        • input_output, ignore_missing properties Added
      • join property Modified
        • on_failure property Modified
      • json property Modified
        • on_failure property Modified
      • kv property Modified
        • on_failure property Modified
      • lowercase property Modified
        • on_failure property Modified
      • network_direction property Modified
        • on_failure property Modified
      • pipeline property Modified
        • on_failure property Modified
      • redact property Modified
        • on_failure property Modified
      • registered_domain property Modified
        • on_failure property Modified
      • remove property Modified
        • on_failure property Modified
      • rename property Modified
        • on_failure property Modified
      • reroute property Modified
        • on_failure property Modified
      • script property Modified
        • on_failure property Modified
      • set property Modified
        • on_failure property Modified
      • set_security_user property Modified
        • on_failure property Modified
      • sort property Modified
        • on_failure property Modified
      • split property Modified
        • on_failure property Modified
      • terminate property Modified
        • on_failure property Modified
      • trim property Modified
        • on_failure property Modified
      • uppercase property Modified
        • on_failure property Modified
      • urldecode property Modified
        • on_failure property Modified
      • uri_parts property Modified
        • on_failure property Modified
      • user_agent property Modified
        • on_failure property Modified
    • processors property Modified
      • append property Modified
        • on_failure property Modified
      • attachment property Modified
        • on_failure property Modified
      • bytes property Modified
        • on_failure property Modified
      • circle property Modified
        • on_failure property Modified
      • community_id property Modified
        • on_failure property Modified
      • convert property Modified
        • on_failure property Modified
      • csv property Modified
        • on_failure property Modified
      • date property Modified
        • on_failure property Modified
      • date_index_name property Modified
        • on_failure property Modified
      • dissect property Modified
        • on_failure property Modified
      • dot_expander property Modified
        • on_failure property Modified
      • drop property Modified
        • on_failure property Modified
      • enrich property Modified
        • on_failure property Modified
      • fail property Modified
        • on_failure property Modified
      • fingerprint property Modified
        • on_failure property Modified
      • foreach property Modified
        • on_failure property Modified
      • ip_location property Modified
        • on_failure property Modified
      • geo_grid property Modified
        • on_failure property Modified
      • geoip property Modified
        • on_failure property Modified
      • grok property Modified
        • on_failure property Modified
      • gsub property Modified
        • on_failure property Modified
      • html_strip property Modified
        • on_failure property Modified
      • inference property Modified
        • on_failure property Modified
        • input_output, ignore_missing properties Added
      • join property Modified
        • on_failure property Modified
      • json property Modified
        • on_failure property Modified
      • kv property Modified
        • on_failure property Modified
      • lowercase property Modified
        • on_failure property Modified
      • network_direction property Modified
        • on_failure property Modified
      • pipeline property Modified
        • on_failure property Modified
      • redact property Modified
        • on_failure property Modified
      • registered_domain property Modified
        • on_failure property Modified
      • remove property Modified
        • on_failure property Modified
      • rename property Modified
        • on_failure property Modified
      • reroute property Modified
        • on_failure property Modified
      • script property Modified
        • on_failure property Modified
      • set property Modified
        • on_failure property Modified
      • set_security_user property Modified
        • on_failure property Modified
      • sort property Modified
        • on_failure property Modified
      • split property Modified
        • on_failure property Modified
      • terminate property Modified
        • on_failure property Modified
      • trim property Modified
        • on_failure property Modified
      • uppercase property Modified
        • on_failure property Modified
      • urldecode property Modified
        • on_failure property Modified
      • uri_parts property Modified
        • on_failure property Modified
      • user_agent property Modified
        • on_failure property Modified
PUT /_inference/{task_type}/{inference_id}/_update
  • Verb went from POST to PUT (same operationId)
    Breaking
PUT /_inference/{inference_id}/_update
  • Verb went from POST to PUT (same operationId)
    Breaking
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings property Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
PUT /_enrich/policy/{name}/_execute
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • step property Added
      • task_id property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • _types:TaskId, _types:TaskId properties Removed
      • task property Added
        • TaskId, TaskId properties Added
  • Query
  • master_timeout query parameter Added
PUT /_enrich/policy/{name}
  • Body
  • application/json content type Modified
    • geo_match property Modified
      • query model Modified
    • match property Modified
      • query model Modified
    • range property Modified
      • query model Modified
  • Query
  • master_timeout query parameter Added
PUT /_data_stream/{name}/_lifecycle
  • Body
  • application/json content type Modified
    • enabled property Added
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • settings, defaults properties Modified
      • DataStreamLifecycle property Modified
        • enabled property Added
PUT /_ccr/auto_follow/{name}
  • Query
  • master_timeout query parameter Added
PUT /_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
  • Query
  • include_source_on_error query parameter Added
PUT /_application/search_application/{name}
  • Body
  • application/json content type Modified
    • name, _types:UnitMillis properties Removed
POST /{index}/_validate/query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_update_by_query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • cause property Modified
POST /{index}/_update/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • include_source_on_error query parameter Added
POST /{index}/_termvectors/{id}
  • Body
  • application/json content type Modified
    • fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added
POST /{index}/_termvectors
  • Body
  • application/json content type Modified
    • fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added
POST /{index}/_terms_enum
  • Body
  • application/json content type Modified
    • index_filter model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_split/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
POST /{index}/_shrink/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
POST /{index}/_searchable_snapshots/cache/clear
  • Query
  • pretty, human query parameters 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
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
      • ingest_pipeline property Modified
        • processors property Modified
POST /_text_structure/find_message_structure
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest_pipeline property Modified
        • processors property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
POST /_template/{name}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
    • mappings property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • settings property Modified
POST /_tasks/{task_id}/_cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • node_failures property Modified
        • root_cause, suppressed properties Modified
      • task_failures property Modified
        • reason property Modified
POST /_tasks/_cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • node_failures property Modified
        • root_cause, suppressed properties Modified
      • task_failures property Modified
        • reason property Modified
POST /_sql/translate
  • Body
  • application/json content type Modified
    • filter model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query model Modified
      • sort property Modified
        • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • Field, SortOptions, Sort alternatives Added
POST /_sql
  • Body
  • application/json content type Modified
    • filter model Modified
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • snapshot property Modified
        • shards property Modified
POST /_snapshot/{repository}/{snapshot}/_mount
  • Response
  • 200 response Modified
    • application/json content type Modified
      • snapshot property Modified
        • shards property Modified
POST /_snapshot/{repository}/{snapshot}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • snapshot property Modified
        • shards property Modified
POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role_mapping/{name}
  • Body
  • application/json content type Modified
    • rules property Modified
      • any, all properties Modified
POST /_security/role/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified
        • Removing polymorphism is always breaking
          Breaking
      • query property Modified
        • _types:IndicesPrivilegesQuery, query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • IndicesPrivilegesQuery, QueryContainer, RoleTemplateQuery alternatives Added
    • remote_indices property Modified
      • names property Modified
        • Removing polymorphism is always breaking
          Breaking
      • query property Modified
        • _types:IndicesPrivilegesQuery, query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • IndicesPrivilegesQuery, QueryContainer, RoleTemplateQuery alternatives Added
POST /_security/role
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices, remote_indices properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
POST /_security/realm/{realms}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/profile/_has_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
POST /_security/privilege/{application}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/oidc/logout
  • Body
  • application/json content type Modified
    • access_token property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
POST /_security/cross_cluster/api_key
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • query property Modified
POST /_security/api_key/{ids}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
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/api_key/_bulk_update
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
POST /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
POST /_security/_query/user
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
POST /{index}/_delete_by_query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • cause property Modified
POST /{index}/_create/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • if_primary_term, if_seq_no, include_source_on_error, op_type, require_alias, require_data_stream query parameters Added
POST /{index}/_count
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /{index}/_close
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
POST /{index}/_clone/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
POST /{index}/_ccr/unfollow
  • Query
  • master_timeout query parameter Added
POST /{index}/_ccr/resume_follow
  • Query
  • master_timeout query parameter Added
POST /{index}/_ccr/pause_follow
  • Query
  • master_timeout query parameter Added
POST /{index}/_ccr/forget_follower
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • timeout query parameter Added
POST /{index}/_cache/clear
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • index query parameter Added
POST /{index}/_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
  • Query
  • include_source_on_error query parameter Added
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • response property Modified
        • _clusters, hits, profile, _shards properties Modified
POST /{index}/_analyze
  • Body
  • application/json content type Modified
  • Query
  • index query parameter Added
POST /{index}/_aliases/{name}
  • Body
  • application/json content type Modified
    • filter model Modified
POST /{index}/_alias/{name}
  • Body
  • application/json content type Modified
    • filter model Modified
POST /{alias}/_rollover/{new_index}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
    • mappings property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
  • Query
  • lazy query parameter Added
POST /{alias}/_rollover
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
    • mappings property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
  • Query
  • lazy query parameter Added
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • simulated_actions property Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • chain, search properties Modified
      • transform property Modified
        • chain, search properties Modified
      • trigger property Modified
        • schedule property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input, result properties Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • transform, email properties Modified
    • input property Modified
      • chain property Modified
        • inputs property Modified
      • search property Modified
        • request property Modified
    • transform property Modified
      • chain property Modified
      • search property Modified
        • request property Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • simulated_actions property Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • chain, search properties Modified
      • transform property Modified
        • chain, search properties Modified
      • trigger property Modified
        • schedule property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input, result properties Modified
POST /_watcher/_start
  • Query
  • master_timeout query parameter Added
POST /_watcher/_query/watches
  • Body
  • application/json content type Modified
    • query model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_validate/query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
POST /_transform/{transform_id}/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • source property Modified
        • query model Modified
        • sort property Modified
POST /_transform/{transform_id}/_reset
  • Query
  • timeout query parameter Added
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_data_stream/{name}/_lifecycle
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • lifecycle property Modified
GET /_cat/repositories
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/recovery/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • index, h, s query parameters Added
GET /_cat/recovery
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • index, h, s query parameters Added
GET /_cat/plugins
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/pending_tasks
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/nodes
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/nodeattrs
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/ml/trained_models/{model_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/trained_models
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/datafeeds/{datafeed_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/datafeeds
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/data_frame/analytics/{id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/data_frame/analytics
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/anomaly_detectors
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/master
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/indices/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/indices
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/health
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/fielddata/{fields}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/fielddata
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/count/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/count
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/component_templates/{name}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/component_templates
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_data_stream/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • lifecycle property Modified
GET /_data_stream/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_data_stream
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • lifecycle property Modified
GET /_count
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_component_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_component_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_cluster/stats/nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_cluster/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_cluster/health/{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • active_shards_percent_as_number property Modified
        • Removing polymorphism is always breaking
          Breaking
      • active_shards_percent property Added
GET /_cluster/health
  • Response
  • 200 response Modified
    • application/json content type Modified
      • active_shards_percent_as_number property Modified
        • Removing polymorphism is always breaking
          Breaking
      • active_shards_percent property Added
GET /_cluster/allocation/explain
  • Query
  • master_timeout query parameter Added
GET /_ccr/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • auto_follow_stats property Modified
        • recent_auto_follow_errors property Modified
      • follow_stats property Modified
        • indices property Modified
  • Query
  • master_timeout, timeout query parameters Added
GET /_ccr/auto_follow/{name}
  • Query
  • master_timeout query parameter Added
GET /_ccr/auto_follow
  • Query
  • master_timeout query parameter Added
GET /_cat/thread_pool/{thread_pool_patterns}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/thread_pool
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/templates/{name}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/templates
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/tasks
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/snapshots/{repository}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/snapshots
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/shards/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/shards
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/segments/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/segments
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/allocation/{node_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
PUT /_security/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • query property Modified
PUT /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified
        • Removing polymorphism is always breaking
          Breaking
      • query property Modified
        • _types:IndicesPrivilegesQuery, query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • IndicesPrivilegesQuery, QueryContainer, RoleTemplateQuery alternatives Added
    • remote_indices property Modified
      • names property Modified
        • Removing polymorphism is always breaking
          Breaking
      • query property Modified
        • _types:IndicesPrivilegesQuery, query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • IndicesPrivilegesQuery, QueryContainer, RoleTemplateQuery alternatives Added
PUT /_security/role_mapping/{name}
  • Body
  • application/json content type Modified
    • rules property Modified
      • any, all properties Modified
PUT /_security/settings
  • Body
  • 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
PUT /_settings
  • Body
  • application/json content type Modified
  • Query
  • reopen query parameter Added
PUT /_snapshot/{repository}/{snapshot}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • snapshot property Modified
        • shards property Modified
PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
  • Query
  • timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /_synonyms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reload_analyzers_details property Modified
        • _shards property Modified
PUT /_synonyms/{set_id}/{rule_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reload_analyzers_details property Modified
        • _shards property Modified
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
    • mappings property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • settings property Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • simulated_actions property Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • chain, search properties Modified
      • transform property Modified
        • chain, search properties Modified
      • trigger property Modified
        • schedule property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input, result properties Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • transform, email properties Modified
    • input property Modified
      • chain property Modified
        • inputs property Modified
      • search property Modified
        • request property Modified
    • transform property Modified
      • chain property Modified
      • search property Modified
        • request property Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • simulated_actions property Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • chain, search properties Modified
      • transform property Modified
        • chain, search properties Modified
      • trigger property Modified
        • schedule property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input, result properties Modified
PUT /{index}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
    • mappings property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • settings property Modified
PUT /{index}/_alias/{name}
  • Body
  • application/json content type Modified
    • filter model Modified
PUT /{index}/_aliases/{name}
  • Body
  • application/json content type Modified
    • filter model Modified
PUT /{index}/_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
  • Query
  • include_source_on_error query parameter Added
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • leader_index, remote_cluster properties Modified
      • Properties are now required
        Breaking
    • max_read_request_size property Modified
      • Combinator is now oneOf
      • max_read_request_size alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ByteSize, ByteSize alternatives Added
    • max_write_buffer_size property Modified
      • Combinator is now oneOf
      • max_write_buffer_size alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ByteSize, ByteSize alternatives Added
    • max_write_request_size property Modified
      • Combinator is now oneOf
      • max_write_request_size alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ByteSize, ByteSize alternatives Added
    • data_stream_name, settings properties Added
  • Query
  • master_timeout query parameter Added
PUT /{index}/_clone/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
PUT /{index}/_create/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • if_primary_term, if_seq_no, include_source_on_error, op_type, require_alias, require_data_stream query parameters Added
PUT /{index}/_doc/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
  • Query
  • include_source_on_error query parameter Added
PUT /{index}/_mapping
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
PUT /{index}/_settings
  • Body
  • application/json content type Modified
  • Query
  • reopen query parameter Added
PUT /{index}/_shrink/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
PUT /{index}/_split/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter model Modified
GET /_cat/allocation
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/aliases/{name}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_cat/aliases
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Query
  • h, s query parameters Added
GET /_async_search/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • response property Modified
        • _clusters, hits, profile, _shards properties Modified
GET /_async_search/status/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • _clusters property Modified
        • details property Modified
GET /_application/search_application/{name}/_search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /_application/search_application
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • _types:UnitMillis property Removed
        • template, UnitMillis properties Added
GET /_analyze
  • Body
  • application/json content type Modified
  • Query
  • index query parameter Added
GET /_alias/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_alias
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
DELETE /{index}/_doc/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
DELETE /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
DELETE /_synonyms/{set_id}/{rule_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reload_analyzers_details property Modified
        • _shards property Modified
DELETE /_security/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
DELETE /_security/oauth2/token
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_details property Modified
        • root_cause, suppressed properties Modified
DELETE /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_details property Modified
        • root_cause, suppressed properties Modified
DELETE /_rollup/job/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task_failures property Modified
        • reason property Modified
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
DELETE /_ml/trained_models/{model_id}
  • Query
  • timeout query parameter Added
DELETE /_license
  • Query
  • master_timeout, timeout query parameters Added
DELETE /_enrich/policy/{name}
  • Query
  • master_timeout query parameter Added
DELETE /_cluster/voting_config_exclusions
  • Query
  • master_timeout query parameter Added
DELETE /_ccr/auto_follow/{name}
  • Query
  • master_timeout query parameter Added
PUT /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
PUT /_security/api_key/{id}
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
GET /_watcher/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_security/service/{namespace}/{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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/role_mapping/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • rules property Modified
GET /_security/role_mapping
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • rules property Modified
GET /_security/role/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices, remote_indices properties Modified
GET /_security/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices, remote_indices properties Modified
GET /_security/profile/{uid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
GET /_security/profile/_has_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • errors property Modified
        • details property Modified
GET /_security/privilege/_builtin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from string | array[string] to array[string]
          Breaking
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/_query/user
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
GET /_security/_query/role
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, remote_indices properties Modified
GET /_security/_query/api_key
  • Body
  • application/json content type Modified
    • query property Modified
      • bool model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by, access properties Modified
GET /_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
  • Query
  • master_timeout query parameter Added
GET /_search/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /_search/scroll/{scroll_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /_search/scroll
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /_search
  • Body
  • application/json content type Modified
    • collapse, post_filter, query models Modified
    • knn property Modified
      • array-2 alternative Modified
        • filter, InnerHits properties Modified
        • rescore_vector property Added
      • _types:KnnSearch alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • KnnSearch alternative Added
    • rescore property Modified
      • array-2 alternative Modified
        • query property Modified
      • _types:Rescore alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Rescore alternative Added
    • retriever property Modified
      • standard property Modified
        • filter, query, sort, collapse properties Modified
      • knn property Modified
        • filter property Modified
        • rescore_vector property Added
      • rrf property Modified
        • filter, retrievers properties Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
      • hits property Modified
        • hits property Modified
      • _clusters property Modified
        • details property Modified
      • profile property Modified
        • shards property Modified
GET /_scripts/painless/_execute
  • Body
  • application/json content type Modified
    • context_setup property Modified
      • query model Modified
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 /_refresh
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query model Modified
GET /_nodes/{node_id}/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
GET /_watcher/_query/watches
  • Body
  • application/json content type Modified
    • query model Modified
    • sort property Modified
      • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Field, SortOptions, Sort alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_validate/query
  • Body
  • application/json content type Modified
    • query model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_transform/{transform_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • checkpointing, health properties Modified
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_transform/{transform_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • create_time_string property Added
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_transform
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • create_time_string property Added
GET /_text_structure/find_message_structure
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest_pipeline property Modified
        • processors property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
GET /_text_structure/find_field_structure
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest_pipeline property Modified
        • processors property Modified
      • mappings property Modified
        • subobjects property Modified
          • Type went from boolean to string
            Breaking
GET /_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings properties Modified
GET /_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings properties Modified
GET /_tasks/{task_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error property Modified
        • root_cause, suppressed properties Modified
GET /_tasks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • node_failures property Modified
        • root_cause, suppressed properties Modified
      • task_failures property Modified
        • reason property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
      • _shards property Modified
        • failures property Modified
      • _all property Modified
        • primaries, shards, total properties Modified
GET /_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
      • _shards property Modified
        • failures property Modified
      • _all property Modified
        • primaries, shards, total properties Modified
GET /_sql/translate
  • Body
  • application/json content type Modified
    • filter model Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query model Modified
      • sort property Modified
        • _types:Field, _types:SortOptions, _types:Sort alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • Field, SortOptions, Sort alternatives Added
GET /_sql
  • Body
  • application/json content type Modified
    • filter model Modified
GET /_snapshot/{repository}/{snapshot}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • snapshots, error properties Modified
      • snapshots property Modified
        • shards property Modified
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, mappings, settings, defaults, DataStreamLifecycle properties Modified
GET /_segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_security/user/_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • names property Modified
          • Removing polymorphism is always breaking
            Breaking
        • query property Modified
      • remote_indices property Modified
        • query property 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 /_security/service/{namespace}/{service}/credential
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes_credentials property Modified
        • _nodes property Modified
GET /_nodes/{node_id}/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query model Modified
    • job_config property Modified
      • datafeed_config property Modified
        • query model Modified
GET /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query model Modified
    • job_config property Modified
      • datafeed_config property Modified
        • query model Modified
GET /_migration/system_features
  • Response
  • 200 response Modified
    • application/json content type Modified
      • features property Modified
        • indices property Modified
GET /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • templates, ilm_policies properties Added
GET /_mget
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • get:GetResult, mget:MultiGetError alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • GetResult, MultiGetError alternatives Added
GET /_mapping
  • Query
  • local query parameter Modified
    • Query parameter is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • item, mappings properties 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
    • mapping_addition property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure, processors properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
      • processors property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error, processor_results properties Modified
GET /_ingest/pipeline/{id}
  • 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
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
      • processors property Modified
        • append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error, processor_results properties Modified
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/geoip/database/{id}
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_ingest/geoip/database
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
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
    • mapping_addition property Modified
      • subobjects property Modified
        • Type went from boolean to string
          Breaking
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure, processors properties Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
GET /_index_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_flush
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /_field_caps
  • Body
  • application/json content type Modified
    • index_filter model Modified
GET /_features
  • Query
  • master_timeout query parameter Added
GET /_eql/search/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shard_failures property Added
GET /_enrich/policy/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policies property Modified
        • config property Modified
  • Query
  • master_timeout query parameter Added
GET /_enrich/policy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policies property Modified
        • config property Modified
  • Query
  • master_timeout query parameter Added
GET /_enrich/_stats
  • Query
  • master_timeout query parameter Added
GET /_data_stream/{name}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _shards property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/shutdown
  • Query
  • timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/hot_threads
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{node_id}/_repositories_metering
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/shutdown
  • Query
  • timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes/hot_threads
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_nodes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • master_timeout query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_mtermvectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • error property Modified
GET /_msearch/template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchHeader, msearch:MultisearchBody alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • MultisearchHeader, MultisearchBody alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • msearch:MultiSearchItem, _types:ErrorResponseBase alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • MultiSearchItem, ErrorResponseBase alternatives Added
GET /_ml/trained_models/{model_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models/{model_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • platform_architecture property Added
GET /_ml/trained_models/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • platform_architecture property Added
GET /_ml/memory/{node_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • human query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /_ml/memory/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
  • Query
  • human query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 2 Breaking
POST /_inference/{inference_id}/_stream
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /_inference/{task_type}/{inference_id}/_stream
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 29
GET /_migration/reindex/{index}/_status
GET /_resolve/cluster/{name}
POST /_create_from/{source}/{dest}
POST /_inference/chat_completion/{inference_id}/_stream
POST /_inference/completion/{inference_id}
POST /_inference/completion/{inference_id}/_stream
POST /_inference/rerank/{inference_id}
POST /_inference/sparse_embedding/{inference_id}
POST /_inference/text_embedding/{inference_id}
POST /_migration/reindex
POST /_migration/reindex/{index}/_cancel
POST /_query/async/{id}/stop
PUT /_create_from/{source}/{dest}
PUT /_inference/{task_type}/{alibabacloud_inference_id}
PUT /_inference/{task_type}/{amazonbedrock_inference_id}
PUT /_inference/{task_type}/{anthropic_inference_id}
PUT /_inference/{task_type}/{azureaistudio_inference_id}
PUT /_inference/{task_type}/{azureopenai_inference_id}
PUT /_inference/{task_type}/{cohere_inference_id}
PUT /_inference/{task_type}/{elasticsearch_inference_id}
PUT /_inference/{task_type}/{elser_inference_id}
PUT /_inference/{task_type}/{googleaistudio_inference_id}
PUT /_inference/{task_type}/{googlevertexai_inference_id}
PUT /_inference/{task_type}/{huggingface_inference_id}
PUT /_inference/{task_type}/{jinaai_inference_id}
PUT /_inference/{task_type}/{mistral_inference_id}
PUT /_inference/{task_type}/{openai_inference_id}
PUT /_inference/{task_type}/{voyageai_inference_id}
PUT /_inference/{task_type}/{watsonx_inference_id}

This documentation update aligns with the 8.17.4 release. Check out the release notes

6 structure changes including:
6 Modifications
Modified 6 Breaking
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
POST /_nodes/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Added
POST /_nodes/{node_id}/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Added

This documentation update aligns with the 8.17.3 release. Check out the release notes.

167 structure changes including:
167 Modifications
Modified 167 Breaking
GET /_alias
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_alias/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
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 /_count
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /_enrich/policy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policies property Modified
        • config property Modified
GET /_enrich/policy/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policies property Modified
        • config property Modified
GET /_field_caps
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
GET /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives 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 /_inference
  • Response
  • 200 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • chunking_settings property Added
GET /_inference/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • chunking_settings property Added
GET /_inference/{task_type}/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • chunking_settings property Added
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • 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
    • index_template_subtitutions property Modified
      • * property Modified
        • template property Modified
GET /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query property Modified
        • geo_grid property Added
    • job_config property Modified
      • datafeed_config property Modified
        • query property Modified
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query property Modified
        • geo_grid property Added
    • job_config property Modified
      • datafeed_config property Modified
        • query property Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
GET /_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query property Modified
GET /_scripts/painless/_execute
  • Body
  • application/json content type Modified
    • context_setup property Modified
      • query property Modified
        • geo_grid property Added
GET /_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
    • retriever property Modified
      • standard property Modified
        • filter, query properties Modified
      • knn property Modified
        • filter property Modified
      • rrf property Modified
        • filter property Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
GET /_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
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, remote_indices properties Modified
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/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices, remote_indices properties Modified
        • run_as property Modified
          • Property is no longer required
        • description property Added
GET /_security/role/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices, remote_indices properties Modified
        • run_as property Modified
          • Property is no longer required
        • description property 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/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 /_security/user/_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • query property Modified
      • remote_cluster, remote_indices properties Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, settings, defaults properties Modified
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, settings, defaults properties Modified
GET /_sql
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
GET /_sql/translate
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query property Modified
        • geo_grid property Added
GET /_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, settings, defaults properties Modified
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, settings, defaults properties Modified
GET /_validate/query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /_watcher/_query/watches
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, input, transform properties Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, settings, defaults properties Modified
GET /{index}/_alias
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_alias/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_count
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /{index}/_eql/search
  • Body
  • application/json content type Modified
    • filter property Modified
      • query_dsl:QueryContainer alternative Modified
        • geo_grid property Added
      • array-2 alternative Modified
        • geo_grid property Added
GET /{index}/_explain/{id}
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /{index}/_field_caps
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
GET /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
GET /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
GET /{index}/_graph/explore
  • Body
  • application/json content type Modified
    • connections property Modified
      • query property Modified
        • geo_grid property Added
    • query property Modified
      • geo_grid property Added
GET /{index}/_knn_search
  • Body
  • application/json content type Modified
    • filter property Modified
      • query_dsl:QueryContainer alternative Modified
        • geo_grid property Added
      • array-2 alternative Modified
        • geo_grid property Added
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
GET /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /{index}/_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query property Modified
GET /{index}/_rollup_search
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
GET /{index}/_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
    • retriever property Modified
      • standard property Modified
        • filter, query properties Modified
      • knn property Modified
        • filter property Modified
      • rrf property Modified
        • filter property Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
GET /{index}/_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, settings, defaults properties Modified
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases, settings, defaults properties Modified
GET /{index}/_terms_enum
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
GET /{index}/_validate/query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /_aliases
  • Body
  • application/json content type Modified
    • actions property Modified
      • add property Modified
        • filter property Modified
POST /_async_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
  • Query
  • keep_alive query parameter Added
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
      • defaults property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
POST /_count
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /_field_caps
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
POST /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, settings properties Modified
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, settings properties Modified
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • aliases, settings properties Modified
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
POST /_inference/{inference_id}/_update
  • Body
  • application/json content type Modified
    • chunking_settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chunking_settings property Added
POST /_inference/{task_type}/{inference_id}/_update
  • Body
  • application/json content type Modified
    • chunking_settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chunking_settings property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_subtitutions 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_subtitutions property Modified
      • * property Modified
        • template property Modified
POST /_ml/data_frame/_evaluate
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query property Modified
        • geo_grid property Added
    • job_config property Modified
      • datafeed_config property Modified
        • query property Modified
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query property Modified
        • geo_grid property Added
    • job_config property Modified
      • datafeed_config property Modified
        • query property Modified
POST /_ml/datafeeds/{datafeed_id}/_update
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query property Modified
        • geo_grid property Added
POST /_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
POST /_query
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
    • include_ccs_metadata property Added
POST /_query/async
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
    • include_ccs_metadata property Added
POST /_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query property Modified
POST /_reindex
  • Body
  • application/json content type Modified
    • source property Modified
      • query property Modified
        • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /_scripts/painless/_execute
  • Body
  • application/json content type Modified
    • context_setup property Modified
      • query property Modified
        • geo_grid property Added
POST /_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
    • retriever property Modified
      • standard property Modified
        • filter, query properties Modified
      • knn property Modified
        • filter property Modified
      • rrf property Modified
        • filter property Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
POST /_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
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, remote_indices properties Modified
POST /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
POST /_security/api_key/_bulk_update
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
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
      • search property Modified
        • query property Modified
POST /_security/role
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices, remote_indices properties Modified
POST /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • query property Modified
        • query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified
    • remote_indices property Modified
      • query property Modified
        • query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Modified
      • auto_expand_replicas property Modified
        • Combinator is now oneOf
        • auto_expand_replicas alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, _spec_utils:NullValue alternatives Added
POST /_sql
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
POST /_sql/translate
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query property Modified
        • geo_grid property Added
POST /_template/{name}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
    • settings property Modified
      • auto_expand_replicas property Modified
        • Combinator is now oneOf
        • auto_expand_replicas alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, _spec_utils:NullValue alternatives Added
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, settings, defaults properties Modified
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • aliases, settings, defaults properties Modified
POST /_transform/{transform_id}/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • source property Modified
        • query property Modified
POST /_validate/query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /_watcher/_query/watches
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • 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
      • actions property Modified
        • * property Modified
      • input property Modified
        • search property Modified
      • transform property Modified
        • search property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • transform property Modified
    • input property Modified
      • search property Modified
        • request property Modified
    • transform property Modified
      • search property Modified
        • request property Modified
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • search property Modified
      • transform property Modified
        • search property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input property Modified
POST /{alias}/_rollover
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
POST /{alias}/_rollover/{new_index}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
POST /{index}/_alias/{name}
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
POST /{index}/_aliases/{name}
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
  • Query
  • keep_alive query parameter Added
POST /{index}/_clone/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
POST /{index}/_count
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /{index}/_delete_by_query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /{index}/_eql/search
  • Body
  • application/json content type Modified
    • filter property Modified
      • query_dsl:QueryContainer alternative Modified
        • geo_grid property Added
      • array-2 alternative Modified
        • geo_grid property Added
POST /{index}/_explain/{id}
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /{index}/_field_caps
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
POST /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
POST /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
POST /{index}/_graph/explore
  • Body
  • application/json content type Modified
    • connections property Modified
      • query property Modified
        • geo_grid property Added
    • query property Modified
      • geo_grid property Added
POST /{index}/_knn_search
  • Body
  • application/json content type Modified
    • filter property Modified
      • query_dsl:QueryContainer alternative Modified
        • geo_grid property Added
      • array-2 alternative Modified
        • geo_grid property Added
POST /{index}/_mapping
  • Body
  • application/json content type Modified
    • dynamic_templates property Modified
      • Removing polymorphism is always breaking
        Breaking
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • msearch:MultisearchBody alternative Modified
      • query property Modified
        • geo_grid property Added
      • knn property Modified
        • _types:KnnSearch, array-2 alternatives Modified
      • post_filter property Modified
        • geo_grid property Added
      • rescore property Modified
        • _types:Rescore, array-2 alternatives Modified
POST /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /{index}/_pit
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
POST /{index}/_rank_eval
  • Body
  • application/json content type Modified
    • requests property Modified
      • request property Modified
        • query property Modified
POST /{index}/_rollup_search
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
POST /{index}/_search
  • Body
  • application/json content type Modified
    • knn property Modified
      • _types:KnnSearch alternative Modified
        • filter property Modified
      • array-2 alternative Modified
        • filter property Modified
    • post_filter property Modified
      • geo_grid property Added
    • query property Modified
      • geo_grid property Added
    • rescore property Modified
      • _types:Rescore alternative Modified
        • query property Modified
      • array-2 alternative Modified
        • query property Modified
    • retriever property Modified
      • standard property Modified
        • filter, query properties Modified
      • knn property Modified
        • filter property Modified
      • rrf property Modified
        • filter property Modified
      • text_similarity_reranker property Modified
        • filter property Modified
      • rule property Modified
        • filter property Modified
POST /{index}/_search_shards
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • * property Modified
POST /{index}/_shrink/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
POST /{index}/_split/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
POST /{index}/_terms_enum
  • Body
  • application/json content type Modified
    • index_filter property Modified
      • geo_grid property Added
POST /{index}/_update_by_query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failures property Modified
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /{index}/_validate/query
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
      • defaults property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
PUT /_connector/{connector_id}/_error
  • Body
  • application/json content type Modified
    • error property Modified
      • _spec_utils:NullValue alternative Modified
        • Alternative is no longer required
PUT /_connector/{connector_id}/_index_name
  • Body
  • application/json content type Modified
    • index_name property Modified
      • _spec_utils:NullValue alternative Modified
        • Alternative is no longer required
PUT /_enrich/policy/{name}
  • Body
  • application/json content type Modified
    • geo_match property Modified
      • query property Modified
        • geo_grid property Added
    • match property Modified
      • query property Modified
        • geo_grid property Added
    • range property Modified
      • query property Modified
        • geo_grid property Added
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • aliases property Modified
        • * property Modified
      • settings property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
PUT /_inference/{inference_id}
  • Body
  • application/json content type Modified
    • chunking_settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chunking_settings property Added
PUT /_inference/{task_type}/{inference_id}
  • Body
  • application/json content type Modified
    • chunking_settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • chunking_settings property Added
PUT /_ml/anomaly_detectors/{job_id}
  • Body
  • application/json content type Modified
    • datafeed_config property Modified
      • query property Modified
        • geo_grid property Added
PUT /_ml/datafeeds/{datafeed_id}
  • Body
  • application/json content type Modified
    • query property Modified
      • geo_grid property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • query property Modified
        • geo_grid property Added
PUT /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
PUT /_security/api_key/{id}
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, remote_indices properties Modified
PUT /_security/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • query property Modified
PUT /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • query property Modified
        • query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified
    • remote_indices property Modified
      • query property Modified
        • query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified
PUT /_security/settings
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
    • security-profile property Modified
      • index property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
    • security-tokens property Modified
      • index property Modified
        • auto_expand_replicas property Modified
          • Combinator is now oneOf
PUT /_settings
  • Body
  • application/json content type Modified
    • auto_expand_replicas property Modified
      • Combinator is now oneOf
      • auto_expand_replicas alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • string-1, _spec_utils:NullValue alternatives Added
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
    • settings property Modified
      • auto_expand_replicas property Modified
        • Combinator is now oneOf
        • auto_expand_replicas alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, _spec_utils:NullValue alternatives Added
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • search property Modified
      • transform property Modified
        • search property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • transform property Modified
    • input property Modified
      • search property Modified
        • request property Modified
    • transform property Modified
      • search property Modified
        • request property Modified
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • input property Modified
        • search property Modified
      • transform property Modified
        • search property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • input property Modified
PUT /{index}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
    • settings property Modified
      • auto_expand_replicas property Modified
        • Combinator is now oneOf
        • auto_expand_replicas alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, _spec_utils:NullValue alternatives Added
PUT /{index}/_alias/{name}
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
PUT /{index}/_aliases/{name}
  • Body
  • application/json content type Modified
    • filter property Modified
      • geo_grid property Added
PUT /{index}/_clone/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
PUT /{index}/_mapping
  • Body
  • application/json content type Modified
    • dynamic_templates property Modified
      • Removing polymorphism is always breaking
        Breaking
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • auto_expand_replicas property Modified
      • Combinator is now oneOf
      • auto_expand_replicas alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • string-1, _spec_utils:NullValue alternatives Added
PUT /{index}/_shrink/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified
PUT /{index}/_split/{target}
  • Body
  • application/json content type Modified
    • aliases property Modified
      • * property Modified
        • filter property Modified

This documentation update aligns with the 8.17.2 release. Check out the release notes.

63 structure changes including:
63 Modifications
Modified 63 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 /_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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
        • error, processor_results properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
        • error, processor_results properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /_ml/anomaly_detectors/{job_id}/results/records
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • causes, geo_results properties Modified
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 /_search
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
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 /_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/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • lifecycle, mapping properties Modified
GET /_xpack/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ilm property Modified
        • policy_stats property Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_search
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /{index}/_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
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 /_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * 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 /_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 /_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_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
        • lifecycle, mapping properties Modified
POST /_inference/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • rerank property Modified
        • score property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • relevance_score property Added
POST /_inference/{task_type}/{inference_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • rerank property Modified
        • score property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • relevance_score property Added
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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
        • error, processor_results 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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • docs property Modified
        • doc property Modified
        • error, processor_results properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /_ml/anomaly_detectors/{job_id}/results/records
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • causes, geo_results properties Modified
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 /_render/template
  • Body
  • application/json content type Modified
    • id property Added
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • id property Added
POST /_scripts/{id}
  • Query
  • context query parameter Added
POST /_scripts/{id}/{context}
  • Query
  • context query parameter Added
POST /_search
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
POST /_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
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 /_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 /_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}/_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
POST /{index}/_search
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
POST /{index}/_search/template
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
PUT /_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property 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
PUT /_ilm/policy/{policy}
  • Body
  • application/json content type Modified
    • policy property Modified
      • phases property Modified
        • cold, delete, frozen, hot, warm properties Modified
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • lifecycle, mapping properties Modified
PUT /_scripts/{id}
  • Query
  • context query parameter Added
PUT /_scripts/{id}/{context}
  • Query
  • context query parameter 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 /_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 /_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 /{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 /{index}/_bulk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * 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

This documentation update aligns with 8.17.1. Check out the release notes.

96 structure changes including:
25 Additions
71 Modifications
Modified 71 Breaking
GET /_rollup/job
  • Operation is now deprecated
GET /_rollup/data/{id}
  • Operation is now deprecated
GET /_rollup/data
  • Operation is now deprecated
GET /_count
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /_cat/thread_pool/{thread_pool_patterns}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/thread_pool
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/templates/{name}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/templates
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/tasks
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/snapshots/{repository}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/snapshots
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/shards/{index}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/shards
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/segments/{index}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/segments
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/repositories
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/recovery/{index}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/recovery
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/plugins
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/pending_tasks
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/nodes
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/nodeattrs
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/trained_models/{model_id}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/trained_models
  • Response
  • 200 response Modified
    • text/plain content type Added
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • _types:UnitMillis property Added
PUT /_slm/policy/{policy_id}/_execute
  • Query
  • master_timeout, timeout query parameters Added
PUT /_rollup/job/{id}
  • Operation is now deprecated
POST /{index}/_unfreeze
  • Operation is now deprecated
POST /{index}/_rollup_search
  • Operation is now deprecated
POST /{index}/_count
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • _types:UnitMillis property Added
POST /_watcher/_stop
  • Query
  • master_timeout query parameter Added
POST /_sql
  • Body
  • application/json content type Modified
    • allow_partial_search_results property Added
POST /_slm/stop
  • Query
  • master_timeout, timeout query parameters Added
POST /_slm/start
  • Query
  • master_timeout, timeout query parameters Added
POST /_slm/_execute_retention
  • Query
  • master_timeout, timeout query parameters Added
POST /_rollup/job/{id}/_stop
  • Operation is now deprecated
POST /_rollup/job/{id}/_start
  • Operation is now deprecated
POST /_count
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /{index}/_rollup_search
  • Operation is now deprecated
GET /{index}/_rollup/data
  • Operation is now deprecated
GET /{index}/_count
  • Query
  • ignore_throttled query parameter Modified
    • Query parameter is now deprecated
GET /_sql
  • Body
  • application/json content type Modified
    • allow_partial_search_results property Added
GET /_slm/status
  • Query
  • master_timeout, timeout query parameters Added
GET /_slm/stats
  • Query
  • master_timeout, timeout query parameters Added
GET /_slm/policy/{policy_id}
  • Query
  • master_timeout, timeout query parameters Added
GET /_slm/policy
  • Query
  • master_timeout, timeout query parameters Added
GET /_rollup/job/{id}
  • Operation is now deprecated
DELETE /_rollup/job/{id}
  • Operation is now deprecated
DELETE /_search/scroll/{scroll_id}
  • Path
  • scroll_id path parameter Modified
    • Path parameter is now deprecated
DELETE /_slm/policy/{policy_id}
  • Query
  • master_timeout, timeout query parameters Added
GET /_cat/aliases
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/aliases/{name}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/allocation
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/allocation/{node_id}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/component_templates
  • Response
  • 200 response Modified
    • application/json content type Modified
      • version property Modified
        • Combinator is now oneOf
        • version alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, string-2 alternatives Added
    • text/plain content type Added
GET /_cat/component_templates/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • version property Modified
        • Combinator is now oneOf
        • version alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, string-2 alternatives Added
    • text/plain content type Added
GET /_cat/count
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/count/{index}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/datafeeds/{datafeed_id}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/datafeeds
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/data_frame/analytics/{id}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/data_frame/analytics
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/ml/anomaly_detectors
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/master
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/indices/{index}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/indices
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/health
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/fielddata/{fields}
  • Response
  • 200 response Modified
    • text/plain content type Added
GET /_cat/fielddata
  • Response
  • 200 response Modified
    • text/plain content type Added
Added 25
POST /_inference/{task_type}/{inference_id}/_update
POST /_inference/{task_type}/{inference_id}/_stream
POST /_inference/{inference_id}/_update
POST /_inference/{inference_id}/_stream
POST /_application/search_application/{name}/_render_query
POST /_application/analytics/{collection_name}/event/{event_type}
GET /_watcher/settings
GET /_security/settings
GET /_query/async/{id}
GET /_lifecycle/stats
GET /_ingest/{index}/_simulate
GET /_ingest/_simulate
DELETE /_query/async/{id}
POST /_ingest/_simulate
POST /_ingest/{index}/_simulate
POST /_query/async
POST /_security/api_key/_bulk_update
POST /_security/delegate_pki
POST /_security/oidc/authenticate
POST /_security/oidc/logout
POST /_security/oidc/prepare
POST /_snapshot/{repository}/_analyze
PUT /_connector/_sync_job/{connector_sync_job_id}/_stats
PUT /_security/settings
PUT /_watcher/settings
75 structure changes including:
11 Additions
64 Modifications
Modified 64 Breaking
GET /_ml/datafeeds/{datafeed_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • datafeeds property Modified
        • timing_stats property Modified
          • Property is no longer required
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
GET /_ml/datafeeds/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • datafeeds property Modified
        • timing_stats property Modified
          • Property is no longer required
GET /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
GET /_ml/data_frame/analytics/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_frame_analytics property Modified
        • _meta property Added
GET /_ml/data_frame/analytics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_frame_analytics property Modified
        • _meta property Added
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshot_upgrades property Modified
        • node property Modified
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • analysis_limits property Modified
GET /_ml/anomaly_detectors/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • analysis_limits property Modified
GET /_ingest/geoip/database/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • databases property Modified
        • database property Modified
          • Property is no longer required
GET /_ingest/geoip/database
  • Response
  • 200 response Modified
    • application/json content type Modified
      • databases property Modified
        • database property Modified
          • Property is no longer required
GET /_cat/thread_pool/{thread_pool_patterns}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/thread_pool
  • Query
  • local, master_timeout query parameters Added
GET /_cat/templates/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
PUT /_ml/trained_models/{model_id}
  • Body
  • application/json content type Modified
    • inference_config property Modified
      • text_classification property Modified
        • tokenization property Modified
      • zero_shot_classification property Modified
        • tokenization property Modified
      • fill_mask property Modified
        • tokenization property Modified
        • vocabulary property Added
      • ner property Modified
        • tokenization property Modified
      • pass_through property Modified
        • tokenization property Modified
      • text_embedding property Modified
        • tokenization property Modified
        • vocabulary property Added
      • text_expansion property Modified
        • tokenization property Modified
        • vocabulary property Added
      • question_answering property Modified
        • tokenization property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • inference_config property Modified
        • text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering properties Modified
      • model_package property Added
PUT /_ml/data_frame/analytics/{id}
  • Body
  • application/json content type Modified
    • _meta property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Added
PUT /_ml/anomaly_detectors/{job_id}
  • Body
  • application/json content type Modified
    • analysis_limits property Modified
      • model_memory_limit property Modified
        • Combinator is now oneOf
        • model_memory_limit alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:ByteSize, _types:ByteSize alternatives Added
    • job_id property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
  • Query
  • allow_no_indices, expand_wildcards, ignore_throttled, ignore_unavailable query parameters Added
POST /_ml/trained_models/{model_id}/deployment/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assignment property Modified
        • routing_table, task_parameters properties Modified
        • adaptive_allocations, reason properties Added
POST /_ml/trained_models/{model_id}/deployment/_start
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assignment property Modified
        • routing_table, task_parameters properties Modified
        • adaptive_allocations, reason properties Added
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/_update
  • Body
  • application/json content type Modified
    • detectors property Modified
      • detector_index property Modified
        • Property is now required
          Breaking
      • by_field_name, detector_description, exclude_frequent, field_name, function, over_field_name, partition_field_name, use_null properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/anomaly_detectors/{job_id}/_data
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _types:UnitMillis property Modified
        • Name is no longer earliest_record_timestamp
        • Property is no longer required
      • _types:UnitMillis property Modified
        • Name is no longer latest_record_timestamp
        • Property is no longer required
      • _types:UnitMillis property Modified
        • Name is no longer last_data_time
        • Property is no longer required
      • _types:UnitMillis, _types:UnitMillis, _types:UnitMillis properties Added
POST /_ml/anomaly_detectors/_validate
  • Body
  • application/json content type Modified
    • analysis_limits property Modified
      • model_memory_limit property Modified
        • Combinator is now oneOf
        • model_memory_limit alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:ByteSize, _types:ByteSize alternatives Added
GET /_ml/trained_models/{model_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models/{model_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • model_package property Added
  • Query
  • include_model_definition query parameter Added
GET /_ml/trained_models/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • model_package property Added
  • Query
  • include_model_definition query parameter Added
GET /_ml/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • limits property Modified
        • max_model_memory_limit, effective_max_model_memory_limit, total_ml_memory properties Modified
          • Combinator is now oneOf
        • max_single_ml_node_processors, total_ml_processors properties Added
GET /_cat/aliases
  • Query
  • local, master_timeout query parameters Added
GET /_cat/aliases/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/allocation
  • Query
  • local, master_timeout query parameters Added
GET /_cat/allocation/{node_id}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/component_templates
  • Query
  • local, master_timeout query parameters Added
GET /_cat/component_templates/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/indices
  • Query
  • master_timeout query parameter Added
GET /_cat/indices/{index}
  • Query
  • master_timeout query parameter Added
GET /_cat/master
  • Query
  • local, master_timeout query parameters Added
GET /_cat/ml/trained_models
  • Query
  • time query parameter Added
GET /_cat/ml/trained_models/{model_id}
  • Query
  • time query parameter Added
GET /_cat/nodeattrs
  • Query
  • local, master_timeout query parameters Added
GET /_cat/templates
  • Query
  • local, master_timeout query parameters Added
GET /_cat/tasks
  • Query
  • node_id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • nodes, time, timeout, wait_for_completion query parameters Added
GET /_cat/snapshots/{repository}
  • Query
  • master_timeout, time query parameters Added
GET /_cat/snapshots
  • Query
  • master_timeout, time query parameters Added
GET /_cat/shards/{index}
  • Query
  • master_timeout, time query parameters Added
GET /_cat/shards
  • Query
  • master_timeout, time query parameters Added
GET /_cat/segments/{index}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/segments
  • Query
  • local, master_timeout query parameters Added
GET /_cat/repositories
  • Query
  • local, master_timeout query parameters Added
GET /_cat/recovery/{index}
  • Query
  • time query parameter Added
GET /_cat/recovery
  • Query
  • time query parameter Added
GET /_cat/plugins
  • Query
  • include_bootstrap, local, master_timeout query parameters Added
GET /_cat/pending_tasks
  • Query
  • local, master_timeout, time query parameters Added
GET /_cat/nodes
  • Query
  • master_timeout, time query parameters Added
Added 11
DELETE /_ingest/ip_location/database/{id}
GET /_ingest/ip_location/database
GET /_ingest/ip_location/database/{id}
GET /_text_structure/find_field_structure
GET /_text_structure/find_message_structure
POST /_text_structure/find_message_structure
PUT /_connector/_sync_job/{connector_sync_job_id}/_check_in
PUT /_connector/_sync_job/{connector_sync_job_id}/_claim
PUT /_connector/_sync_job/{connector_sync_job_id}/_error
PUT /_connector/{connector_id}/_features
PUT /_ingest/ip_location/database/{id}

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
9 structure changes including:
9 Modifications
Modified 9 Breaking
GET /_async_search/status/{id}
  • Query
  • keep_alive query parameter Added
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
      • 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 /{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
      • 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
POST /_async_search
  • Query
  • scroll query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /{index}/_async_search
  • Query
  • scroll query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking

This documentation update aligns with 8.16.1, which has the following release notes: https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-8.16.1.html

14 structure changes including:
14 Modifications
Modified 14 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 /_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
        • 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
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 /_security/cross_cluster/api_key
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • allow_restricted_indices 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/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • allow_restricted_indices property Added

This documentation update aligns with Elasticsearch version 8.16.0, which has the following release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/release-notes-8.16.0.html