Elasticsearch Serverless API

about 21 hours ago

Change #dd1f91b3

Breaking

Compare

This documentation update aligns with a release. Check out the latest release notes.

230 structure changes including:

2 Breaking changes

2 Additions

226 Modifications

2 Removals

Modified 226 Breaking

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 /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - 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 /_sql

Body
application/json content type Modified
- filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script 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 /_transform/_preview

Body
application/json content type Modified
- pivot property Modified
  - group_by property Modified
    - * property Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

POST /_transform/{transform_id}/_preview

Body
application/json content type Modified
- pivot property Modified
  - group_by property Modified
    - * property Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

POST /_transform/{transform_id}/_update

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - pivot property Modified
    - group_by property Modified
  - source property Modified
    - query model Modified
    - sort, runtime_mappings properties 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 /{alias}/_rollover

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter model Modified
- mappings property Modified
  - runtime property Modified
    - * property Modified

POST /{alias}/_rollover/{new_index}

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter model Modified
- mappings property Modified
  - runtime property Modified
    - * property Modified

POST /{index}/_alias/{name}

Body
application/json content type Modified
- filter model Modified

POST /{index}/_aliases/{name}

Body
application/json content type Modified
- filter model Modified

POST /{index}/_analyze

Body
application/json content type Modified

POST /{index}/_async_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters, hits, profile, _shards properties Modified

POST /{index}/_bulk

Body
application/json content type Modified
- bulk:OperationContainer, bulk:UpdateAction alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- OperationContainer, UpdateAction alternatives Added
Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - * property Modified

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}/_create/{id}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

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}/_doc

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

POST /{index}/_doc/{id}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - shard_failures property Modified
    - reason property 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}/_field_caps

Body
application/json content type Modified
- index_filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script 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}/_mapping

Body
application/json content type Modified
- runtime property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

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}/_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, SearchRequestBody 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}/_msearch/template

Body
application/json content type Modified
- msearch:MultisearchHeader, msearch_template:TemplateConfig alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- MultisearchHeader, TemplateConfig 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}/_mtermvectors

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - error property 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 /_ml/anomaly_detectors/{job_id}/_update

Response
200 response Modified
- application/json content type Modified
  - datafeed_config property Modified
    - script_fields, runtime_mappings properties Modified

POST /_ml/data_frame/_evaluate

Body
application/json content type Modified
- query model Modified

POST /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/data_frame/analytics/{id}/_update

Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query model Modified
    - runtime_mappings, script_fields properties Modified

POST /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query model Modified
    - runtime_mappings, script_fields properties Modified

POST /_ml/datafeeds/{datafeed_id}/_update

Body
application/json content type Modified
- query model Modified
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
- script_fields property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified

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, SearchRequestBody 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 /_msearch/template

Body
application/json content type Modified
- msearch:MultisearchHeader, msearch_template:TemplateConfig alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- MultisearchHeader, TemplateConfig 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 /_mtermvectors

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - error property Modified

POST /_query

Body
application/json content type Modified
- filter model Modified
Response
200 response Modified
- application/json content type Modified
  - UnitMillis, is_partial, all_columns, columns, values, _clusters, profile properties Added

POST /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query model Modified

POST /_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

POST /_reindex

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added
- 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
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - failures property Modified
    - cause property Modified

POST /_render/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource alternatives Added

POST /_render/template/{id}

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource alternatives Added

POST /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query model Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

POST /_scripts/{id}

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

POST /_scripts/{id}/{context}

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

POST /_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- retriever property Modified
  - standard property Modified
    - filter, query, sort, collapse properties Modified
  - knn property Modified
    - filter property Modified
  - rrf property Modified
    - filter, retrievers properties Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
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/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/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource 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 /_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 /_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 property Modified

POST /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query model Modified
- runtime_mappings property Modified
  - * property Modified
    - script 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

PUT /_inference/{task_type}/{jinaai_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{mistral_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{openai_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{voyageai_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{watsonx_inference_id}

Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_ingest/pipeline/{id}

Body
application/json content type Modified
- on_failure property Modified
  - append property Modified
    - if, on_failure properties Modified
  - attachment property Modified
    - if, on_failure properties Modified
  - bytes property Modified
    - if, on_failure properties Modified
  - circle property Modified
    - if, on_failure properties Modified
  - community_id property Modified
    - if, on_failure properties Modified
  - convert property Modified
    - if, on_failure properties Modified
  - csv property Modified
    - if, on_failure properties Modified
  - date property Modified
    - if, on_failure properties Modified
  - date_index_name property Modified
    - if, on_failure properties Modified
  - dissect property Modified
    - if, on_failure properties Modified
  - dot_expander property Modified
    - if, on_failure properties Modified
  - drop property Modified
    - if, on_failure properties Modified
  - enrich property Modified
    - if, on_failure properties Modified
  - fail property Modified
    - if, on_failure properties Modified
  - fingerprint property Modified
    - if, on_failure properties Modified
  - foreach property Modified
    - if, on_failure properties Modified
  - ip_location property Modified
    - if, on_failure properties Modified
  - geo_grid property Modified
    - if, on_failure properties Modified
  - geoip property Modified
    - if, on_failure properties Modified
  - grok property Modified
    - if, on_failure properties Modified
  - gsub property Modified
    - if, on_failure properties Modified
  - html_strip property Modified
    - if, on_failure properties Modified
  - inference property Modified
    - if, on_failure properties Modified
    - input_output, ignore_missing properties Added
  - join property Modified
    - if, on_failure properties Modified
  - json property Modified
    - if, on_failure properties Modified
  - kv property Modified
    - if, on_failure properties Modified
  - lowercase property Modified
    - if, on_failure properties Modified
  - network_direction property Modified
    - if, on_failure properties Modified
  - pipeline property Modified
    - if, on_failure properties Modified
  - redact property Modified
    - if, on_failure properties Modified
  - registered_domain property Modified
    - if, on_failure properties Modified
  - remove property Modified
    - if, on_failure properties Modified
  - rename property Modified
    - if, on_failure properties Modified
  - reroute property Modified
    - if, on_failure properties Modified
  - script property Modified
    - if, on_failure properties Modified
    - lang property Modified
      - Combinator is now anyOf
    - source property Modified
      - Combinator is now oneOf
  - set property Modified
    - if, on_failure properties Modified
  - set_security_user property Modified
    - if, on_failure properties Modified
  - sort property Modified
    - if, on_failure properties Modified
  - split property Modified
    - if, on_failure properties Modified
  - terminate property Modified
    - if, on_failure properties Modified
  - trim property Modified
    - if, on_failure properties Modified
  - uppercase property Modified
    - if, on_failure properties Modified
  - urldecode property Modified
    - if, on_failure properties Modified
  - uri_parts property Modified
    - if, on_failure properties Modified
  - user_agent property Modified
    - if, on_failure properties Modified
- processors property Modified
  - append property Modified
    - if, on_failure properties Modified
  - attachment property Modified
    - if, on_failure properties Modified
  - bytes property Modified
    - if, on_failure properties Modified
  - circle property Modified
    - if, on_failure properties Modified
  - community_id property Modified
    - if, on_failure properties Modified
  - convert property Modified
    - if, on_failure properties Modified
  - csv property Modified
    - if, on_failure properties Modified
  - date property Modified
    - if, on_failure properties Modified
  - date_index_name property Modified
    - if, on_failure properties Modified
  - dissect property Modified
    - if, on_failure properties Modified
  - dot_expander property Modified
    - if, on_failure properties Modified
  - drop property Modified
    - if, on_failure properties Modified
  - enrich property Modified
    - if, on_failure properties Modified
  - fail property Modified
    - if, on_failure properties Modified
  - fingerprint property Modified
    - if, on_failure properties Modified
  - foreach property Modified
    - if, on_failure properties Modified
  - ip_location property Modified
    - if, on_failure properties Modified
  - geo_grid property Modified
    - if, on_failure properties Modified
  - geoip property Modified
    - if, on_failure properties Modified
  - grok property Modified
    - if, on_failure properties Modified
  - gsub property Modified
    - if, on_failure properties Modified
  - html_strip property Modified
    - if, on_failure properties Modified
  - inference property Modified
    - if, on_failure properties Modified
    - input_output, ignore_missing properties Added
  - join property Modified
    - if, on_failure properties Modified
  - json property Modified
    - if, on_failure properties Modified
  - kv property Modified
    - if, on_failure properties Modified
  - lowercase property Modified
    - if, on_failure properties Modified
  - network_direction property Modified
    - if, on_failure properties Modified
  - pipeline property Modified
    - if, on_failure properties Modified
  - redact property Modified
    - if, on_failure properties Modified
  - registered_domain property Modified
    - if, on_failure properties Modified
  - remove property Modified
    - if, on_failure properties Modified
  - rename property Modified
    - if, on_failure properties Modified
  - reroute property Modified
    - if, on_failure properties Modified
  - script property Modified
    - if, on_failure properties Modified
    - lang property Modified
      - Combinator is now anyOf
    - source property Modified
      - Combinator is now oneOf
  - set property Modified
    - if, on_failure properties Modified
  - set_security_user property Modified
    - if, on_failure properties Modified
  - sort property Modified
    - if, on_failure properties Modified
  - split property Modified
    - if, on_failure properties Modified
  - terminate property Modified
    - if, on_failure properties Modified
  - trim property Modified
    - if, on_failure properties Modified
  - uppercase property Modified
    - if, on_failure properties Modified
  - urldecode property Modified
    - if, on_failure properties Modified
  - uri_parts property Modified
    - if, on_failure properties Modified
  - user_agent property Modified
    - if, on_failure properties Modified

PUT /_logstash/pipeline/{id}

Body
application/json content type Modified
- pipeline_settings property Modified
  - queue.max_bytes.number, queue.max_bytes.units properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - queue.max_bytes property Added

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- datafeed_config property Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - datafeed_config property Modified
    - script_fields, runtime_mappings properties Modified

PUT /_ml/data_frame/analytics/{id}

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - runtime_mappings property Modified

PUT /_ml/datafeeds/{datafeed_id}

Body
application/json content type Modified
- query model Modified
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
- script_fields property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property 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 /_scripts/{id}

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

PUT /_scripts/{id}/{context}

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

PUT /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

PUT /_security/api_key/{id}

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

PUT /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - 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 /_settings

Body
application/json content type Modified

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 /_transform/{transform_id}

Body
application/json content type Modified
- pivot property Modified
  - group_by property Modified
    - * property Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified

PUT /{index}

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter model Modified
- mappings property Modified
  - runtime property Modified
    - * property Modified
- 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

Body
application/json content type Modified
- bulk:OperationContainer, bulk:UpdateAction alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- OperationContainer, UpdateAction alternatives Added
Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - * property Modified

PUT /{index}/_create/{id}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

PUT /{index}/_doc/{id}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

PUT /{index}/_mapping

Body
application/json content type Modified
- runtime property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

PUT /{index}/_settings

Body
application/json content type 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}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query model Modified

POST /{index}/_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

POST /{index}/_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- retriever property Modified
  - standard property Modified
    - filter, query, sort, collapse properties Modified
  - knn property Modified
    - filter property Modified
  - rrf property Modified
    - filter, retrievers properties Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
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/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource 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}/_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}/_update/{id}

Body
application/json content type Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added
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
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added
Response
200 response Modified
- application/json content type Modified
  - failures property Modified
    - cause property Modified

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

PUT /_application/search_application/{name}

Body
application/json content type Modified
- template property Modified
  - script property Modified
    - source property Modified
      - Combinator is now oneOf

PUT /_bulk

Body
application/json content type Modified
- bulk:OperationContainer, bulk:UpdateAction alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- OperationContainer, UpdateAction alternatives Added
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
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings, defaults properties Modified

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

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

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings property Modified

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}/{alibabacloud_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{amazonbedrock_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{anthropic_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{azureaistudio_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{azureopenai_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{cohere_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{elasticsearch_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{elser_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{googleaistudio_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{googlevertexai_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Added

PUT /_inference/{task_type}/{huggingface_inference_id}

Body
application/json content type Modified
- chunking_settings property Modified
  - service, service_settings, task_settings properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
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

GET /_logstash/pipeline

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - pipeline_settings property Modified

GET /_logstash/pipeline/{id}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - pipeline_settings property Modified

GET /_mapping

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - item, mappings properties Modified

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 /_ml/anomaly_detectors

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - datafeed_config property Modified

GET /_ml/anomaly_detectors/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - datafeed_config property Modified

GET /_ml/data_frame/analytics

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

GET /_ml/data_frame/analytics/{id}

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

GET /_ml/datafeeds

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - script_fields, runtime_mappings properties Modified

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query model Modified
    - runtime_mappings, script_fields properties Modified

GET /_ml/datafeeds/{datafeed_id}

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - script_fields, runtime_mappings properties Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query model Modified
  - runtime_mappings property Modified
    - * property Modified
  - script_fields property Modified
    - * property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query model Modified
    - runtime_mappings, script_fields properties 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/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/{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/{model_id}/_stats

Response
200 response Modified
- application/json content type Modified
  - trained_model_stats property Modified
    - deployment_stats property Modified

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, SearchRequestBody 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 /_msearch/template

Body
application/json content type Modified
- msearch:MultisearchHeader, msearch_template:TemplateConfig alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- MultisearchHeader, TemplateConfig 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 /_mtermvectors

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - error property Modified

GET /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query model Modified

GET /_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

GET /_render/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource alternatives Added

GET /_render/template/{id}

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource alternatives Added

GET /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query model Modified
- script property Modified
  - source property Modified
    - Combinator is now oneOf
    - source alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - ScriptSource, ScriptSource alternatives Added

GET /_scripts/{id}

Response
200 response Modified
- application/json content type Modified
  - script property Modified
    - source property Modified
      - Combinator is now oneOf

GET /_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- retriever property Modified
  - standard property Modified
    - filter, query, sort, collapse properties Modified
  - knn property Modified
    - filter property Modified
  - rrf property Modified
    - filter, retrievers properties Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
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

DELETE /_security/api_key

Response
200 response Modified
- application/json content type Modified
  - error_details property Modified
    - root_cause, suppressed properties 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 /{index}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

DELETE /{index}/_doc/{id}

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

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 /_analyze

Body
application/json content type Modified

GET /_application/search_application

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - template property Modified

GET /_application/search_application/{name}

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - script 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 /_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 /_async_search/{id}

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters, hits, profile, _shards properties 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 model Modified
Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

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 /_eql/search/{id}

Response
200 response Modified
- application/json content type Modified
  - shard_failures property Modified
    - reason property Modified

GET /_field_caps

Body
application/json content type Modified
- index_filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script 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 /_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/pipeline

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - 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/{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 /{index}/_mapping

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - item, mappings properties Modified

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}/_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, SearchRequestBody 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}/_msearch/template

Body
application/json content type Modified
- msearch:MultisearchHeader, msearch_template:TemplateConfig alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- MultisearchHeader, TemplateConfig 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}/_mtermvectors

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - error property Modified

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query model Modified
- runtime_mappings property Modified
  - * property Modified
    - script 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

GET /{index}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query model Modified

GET /{index}/_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - failures property Modified

GET /{index}/_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- retriever property Modified
  - standard property Modified
    - filter, query, sort, collapse properties Modified
  - knn property Modified
    - filter property Modified
  - rrf property Modified
    - filter, retrievers properties Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
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/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource 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}/_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

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}/_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 /_aliases

Body
application/json content type Modified
- actions property Modified
  - add property Modified
    - filter model Modified

POST /_analyze

Body
application/json content type 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 /_async_search

Body
application/json content type Modified
- collapse property Modified
  - inner_hits property Modified
    - array-2 alternative Modified
    - _types:InnerHits alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - InnerHits alternative Added
- knn property Modified
  - array-2 alternative Modified
    - filter, InnerHits properties Modified
  - _types:KnnSearch alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - KnnSearch alternative Added
- 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
- script_fields property Modified
  - * property Modified
    - script 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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters, hits, profile, _shards properties Modified

POST /_bulk

Body
application/json content type Modified
- bulk:OperationContainer, bulk:UpdateAction alternatives Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- OperationContainer, UpdateAction alternatives Added
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
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings, defaults properties 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 /_field_caps

Body
application/json content type Modified
- index_filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script property Modified

POST /_index_template/_simulate

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings property Modified
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

POST /_index_template/_simulate/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings property Modified
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

POST /_index_template/_simulate_index/{name}

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

POST /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - mappings property Modified
    - runtime property Modified
  - settings property Modified

POST /_inference/chat_completion/{inference_id}/_stream

Body
application/json content type Modified
- Content type is now required
  Breaking
- messages, model, max_completion_tokens, stop, temperature, tools, top_p properties Added
- tool_choice property Added
  - CompletionToolType, CompletionToolChoice properties Added

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

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/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/template

Body
application/json content type Modified
- source property Modified
  - Combinator is now oneOf
  - source alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - ScriptSource, ScriptSource 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 /_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 /_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 property 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, role_templates properties Modified

GET /_security/role/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices, role_templates properties Modified

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /_sql

Body
application/json content type Modified
- filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script property 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 /_tasks/{task_id}

Response
200 response Modified
- application/json content type Modified
  - error property Modified
    - root_cause, suppressed properties Modified

GET /_transform

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - pivot, source properties Modified
    - create_time_string property Added

GET /_transform/_preview

Body
application/json content type Modified
- pivot property Modified
  - group_by property Modified
    - * property Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /_transform/{transform_id}

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - pivot, source properties Modified
    - create_time_string property Added

GET /_transform/{transform_id}/_preview

Body
application/json content type Modified
- pivot property Modified
  - group_by property Modified
    - * property Modified
- source property Modified
  - runtime_mappings property Modified
    - * property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /_transform/{transform_id}/_stats

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - checkpointing, health properties 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 /{index}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, 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}/_analyze

Body
application/json content type Modified

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}/_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
- runtime_mappings property Modified
  - * property Modified
    - script property Modified
Response
200 response Modified
- application/json content type Modified
  - shard_failures property Modified
    - reason property 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}/_field_caps

Body
application/json content type Modified
- index_filter model Modified
- runtime_mappings property Modified
  - * property Modified
    - script property Modified

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

Removed 2 Breaking

POST /_inference/chat_completion/{eis_inference_id}/_stream

Removing a resource is always breaking unless it was deprecated before
Breaking

PUT /_inference/{task_type}/{eis_inference_id}

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 2

POST /_inference/{task_type}/{inference_id}

POST /_inference/{inference_id}

23 days ago

Change #9db6c330

Breaking

Compare

This documentation update aligns with a release. Check out the latest release notes

63 structure changes including:

17 Additions

46 Modifications

Modified 46 Breaking

GET /_analyze

Query
index query parameter Added

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/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 /_data_stream

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - failure_store, indices properties Modified
    - index_mode property Added

GET /_data_stream/{name}

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - failure_store, indices properties Modified
    - index_mode property Added

GET /_inference

Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - chunking_settings property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /_inference/{inference_id}

Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - chunking_settings property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /_inference/{task_type}/{inference_id}

Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - chunking_settings property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /_mapping

Query
local query parameter Modified
- Query parameter is now deprecated

GET /{index}/_analyze

Query
index query parameter Added

GET /{index}/_mapping

Query
local query parameter Modified
- Query parameter is now deprecated

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}/_termvectors/{id}

Body
application/json content type Modified
- fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added

HEAD /_index_template/{name}

Query
local, flat_settings query parameters Added

POST /_analyze

Query
index query parameter Added

POST /_index_template/_simulate

Query
cause query parameter Added

POST /_index_template/_simulate/{name}

Query
cause query parameter Added

POST /_index_template/_simulate_index/{name}

Query
create, cause query parameters Added

POST /_inference/chat_completion/{inference_id}/_stream

Body
application/json content type Modified
- messages, model, max_completion_tokens, stop, temperature, tools, top_p properties Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- tool_choice property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
  - chat_completion_unified:CompletionToolType, chat_completion_unified:CompletionToolChoice properties Removed

POST /_query

Query
allow_partial_results query parameter Added

POST /{alias}/_rollover

Query
lazy query parameter Added

POST /{alias}/_rollover/{new_index}

Query
lazy query parameter Added

POST /{index}/_analyze

Query
index query parameter Added

POST /{index}/_create/{id}

Query
if_primary_term, if_seq_no, op_type, require_alias, require_data_stream query parameters 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}/_termvectors/{id}

Body
application/json content type Modified
- fields, field_statistics, offsets, payloads, positions, term_statistics, routing, version, version_type properties Added

PUT /_inference/{inference_id}

Body
application/json content type Modified
- chunking_settings property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /_inference/{task_type}/{inference_id}

Body
application/json content type Modified
- chunking_settings property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /_inference/{task_type}/{watsonx_inference_id}

Response
200 response Modified
- application/json content type Modified
  - chunking_settings property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /_settings

Query
reopen query parameter Added

PUT /{index}/_create/{id}

Query
if_primary_term, if_seq_no, op_type, require_alias, require_data_stream query parameters Added

PUT /{index}/_settings

Query
reopen query parameter 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

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

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

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

GET /_cat/count

Response
200 response Modified
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

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

GET /_cat/indices

Response
200 response Modified
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

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

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/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/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/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/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/datafeeds/{datafeed_id}

Response
200 response Modified
- text/plain content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

Added 17

PUT /_inference/{task_type}/{elasticsearch_inference_id}

PUT /_inference/{task_type}/{eis_inference_id}

PUT /_inference/{task_type}/{cohere_inference_id}

PUT /_inference/{task_type}/{azureopenai_inference_id}

PUT /_inference/{task_type}/{azureaistudio_inference_id}

PUT /_inference/{task_type}/{anthropic_inference_id}

PUT /_inference/{task_type}/{amazonbedrock_inference_id}

PUT /_inference/{task_type}/{alibabacloud_inference_id}

POST /_inference/chat_completion/{eis_inference_id}/_stream

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}

Mar 11, 2025

Change #402e56d1

Breaking

Compare

This documentation update aligns with a serverless release. Check out the release notes.

120 structure changes including:

5 Breaking changes

6 Additions

109 Modifications

5 Removals

Modified 109 Breaking

PUT /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - geo_grid property Added

POST /{alias}/_rollover/{new_index}

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter property Modified
- mappings property Modified
  - subobjects property Modified
    - Type went from boolean to string
      Breaking

POST /{alias}/_rollover

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter property Modified
- mappings property Modified
  - subobjects property Modified
    - Type went from boolean to string
      Breaking

POST /_validate/query

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

POST /_transform/{transform_id}/_update

Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - query property Modified

POST /_transform/{transform_id}/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

POST /_transform/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults properties Modified

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 /_sql

Body
application/json content type Modified
- filter property Modified
  - geo_grid property Added

POST /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - query property Modified
    - query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified

POST /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

POST /_security/_query/role

Response
200 response Modified
- application/json content type Modified
  - roles property Modified
    - indices 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 /_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 /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified
    - geo_grid property Added

POST /_reindex

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - geo_grid property Added

POST /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

POST /_query

Body
application/json content type Modified
- filter 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 /_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 /_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/_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/data_frame/_evaluate

Body
application/json content type Modified
- query property Modified
  - geo_grid 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
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /_index_template/_simulate_index/{name}

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

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
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

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
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - aliases, mappings, settings properties Modified

POST /_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - geo_grid property Added

POST /_count

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

PUT /{index}/_alias/{name}

Body
application/json content type Modified
- filter property Modified
  - geo_grid property Added

PUT /{index}

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter property Modified
- mappings property Modified
  - subobjects property Modified
    - Type went from boolean to string
      Breaking
- settings property Modified
  - number_of_shards property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
    - number-1, string-2 properties Removed
  - number_of_replicas property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
    - number-1, string-2 properties Removed

PUT /_settings

Body
application/json content type Modified
- number_of_shards property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
  - number-1, string-2 properties Removed
- number_of_replicas property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
  - number-1, string-2 properties Removed

PUT /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - query property Modified
    - query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified

PUT /_security/api_key/{id}

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

PUT /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

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 /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- datafeed_config 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
  - mappings property Modified
    - subobjects property Modified
      - Type went from boolean to string
        Breaking
  - settings property Modified
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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 /_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 property Modified
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - defaults property Modified
    - number_of_shards, number_of_replicas properties 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

POST /{index}/_update_by_query

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

POST /{index}/_terms_enum

Body
application/json content type Modified
- index_filter 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}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

POST /{index}/_pit

Body
application/json content type Modified
- index_filter property Modified
  - geo_grid property Added

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

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}/_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}/_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - geo_grid property Added

POST /{index}/_explain/{id}

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

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}/_delete_by_query

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

POST /{index}/_count

Body
application/json content type Modified
- query 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

POST /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - geo_grid property Added

POST /{index}/_alias/{name}

Body
application/json content type Modified
- filter property Modified
  - geo_grid property Added

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /_security/role/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property Modified

GET /_security/role

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property 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/_query/role

Response
200 response Modified
- application/json content type Modified
  - roles property Modified
    - indices 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 /_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 /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified
    - geo_grid property Added

GET /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request 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 /_ml/trained_models/{model_id}

Query
include_model_definition query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking

GET /_ml/trained_models

Query
include_model_definition query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking

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 /_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 /_mapping

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - item, mappings properties 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 /_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - geo_grid property Added

GET /_enrich/policy/{name}

Response
200 response Modified
- application/json content type Modified
  - policies property Modified
    - config property Modified

GET /_enrich/policy

Response
200 response Modified
- application/json content type Modified
  - policies property Modified
    - config property Modified

GET /_count

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

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 /_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

PUT /{index}/_settings

Body
application/json content type Modified
- number_of_shards property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
  - number-1, string-2 properties Removed
- number_of_replicas property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
  - number-1, string-2 properties Removed

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 property Modified
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - defaults property Modified
    - number_of_shards, number_of_replicas properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

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

POST /_aliases

Body
application/json content type Modified
- actions property Modified
  - add property Modified
    - filter property Modified

GET /{index}/_validate/query

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

GET /{index}/_terms_enum

Body
application/json content type Modified
- index_filter property Modified
  - geo_grid property Added

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, settings, defaults properties Modified

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}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property 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}/_mapping

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - item, mappings properties 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 /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, 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 /_transform/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, mappings, settings, defaults 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 properties Modified

GET /_validate/query

Body
application/json content type Modified
- query property Modified
  - geo_grid property Added

GET /{index}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - aliases, mappings, 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

Removed 5 Breaking

POST /_inference/{inference_id}

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /_inference/{inference_id}/_unified

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /_inference/{task_type}/{inference_id}

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /_inference/{task_type}/{inference_id}/_unified

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /_ml/trained_models/{model_id}/deployment/_infer

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 6

PUT /_inference/{task_type}/{watsonx_inference_id}

POST /_inference/text_embedding/{inference_id}

POST /_inference/sparse_embedding/{inference_id}

POST /_inference/rerank/{inference_id}

POST /_inference/completion/{inference_id}

POST /_inference/chat_completion/{inference_id}/_stream

Feb 25, 2025

Change #cb60ba41

Breaking

Compare

Check out the Elastic Cloud Serverless changelog

52 structure changes including:

52 Modifications

Modified 52 Breaking

DELETE /_application/analytics/{name}

Operation is now deprecated

GET /_application/analytics

Operation is now deprecated

GET /_application/analytics/{name}

Operation is now deprecated

GET /_cat/aliases

Query
h, s query parameters Added

GET /_cat/aliases/{name}

Query
h, s query parameters Added

GET /_cat/component_templates

Query
h, s query parameters Added

GET /_cat/component_templates/{name}

Query
h, s query parameters Added

GET /_cat/count

Query
h, s query parameters Added

GET /_cat/count/{index}

Query
h, s query parameters Added

GET /_cat/indices

Query
h, s query parameters Added

GET /_cat/indices/{index}

Query
h, s query parameters Added

GET /_component_template

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_component_template/{name}

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_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 /_security/role

Response
200 response Modified
- application/json content type Modified
  - * property 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
    - run_as property Modified
      - Property is no longer required
    - description property Added

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

GET /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

GET /_transform/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - settings, defaults properties Modified

GET /_transform/{transform_id}/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - settings, defaults properties Modified

GET /{index}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

POST /_component_template/{name}

Body
application/json content type Modified
- template 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 /_index_template/_simulate

Body
application/json content type Modified
- template 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
    - settings property Modified

POST /_index_template/_simulate/{name}

Body
application/json content type Modified
- template 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
    - 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
    - auto_expand_replicas property Modified
      - Combinator is now oneOf

POST /_ml/trained_models/{model_id}/deployment/_start

Body
application/json content type Added

POST /_ml/trained_models/{model_id}/deployment/_update

Body
application/json content type Modified
- adaptive_allocations property Added

POST /_reindex

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 /_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}/_delete_by_query

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}/_mapping

Body
application/json content type Modified
- dynamic_templates property Modified
  - Removing polymorphism is always breaking
    Breaking

POST /{index}/_update_by_query

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

PUT /_application/analytics/{name}

Operation is now deprecated

PUT /_component_template/{name}

Body
application/json content type Modified
- template 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 /_data_stream/{name}/_lifecycle

Body
application/json content type Modified
- Content type is no longer required

PUT /_index_template/{name}

Body
application/json content type Modified
- template 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 /_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}

Body
application/json content type 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}/_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

Feb 11, 2025

Change #fd28c5be

Breaking

Compare

This documentation update aligns with a serverless release. Check out the release notes

187 structure changes including:

4 Additions

183 Modifications

Modified 183 Breaking

DELETE /_connector/{connector_id}

Query
hard query parameter Added

POST /_reindex

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn, pinned properties Modified

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/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified
    - knn, pinned properties Modified

POST /_scripts/{id}

Query
context query parameter Added

POST /_scripts/{id}/{context}

Query
context query parameter Added

POST /_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- 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
    - search_after property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking
  - knn property Modified
    - filter property Modified
    - rescore_vector property Added
  - rrf property Modified
    - filter property Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_search/template

Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_security/_query/api_key

Body
application/json content type Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by, access properties Modified
    - _sort property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking

POST /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

POST /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - query property Modified
    - query_dsl:QueryContainer, _types:RoleTemplateQuery alternatives Modified

POST /_sql

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- allow_partial_search_results property Added

POST /_sql/translate

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn, pinned properties Modified

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}/_reset

Query
timeout query parameter Added

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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs 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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - settings property Modified
    - lifecycle, mapping properties Modified
  - defaults property Modified
    - lifecycle, mapping properties Modified

POST /_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated

POST /_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /_index_template/_simulate

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - settings property Modified
    - lifecycle, mapping properties Modified
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
    - lifecycle, mapping properties Modified
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
    - 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
  - text_embedding_bits 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
  - text_embedding_bits property Added

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

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

POST /_ml/anomaly_detectors/{job_id}/_flush

Operation is now deprecated

POST /_ml/data_frame/_evaluate

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - _source property Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required

POST /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - _source property Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required

POST /_ml/data_frame/analytics/{id}/_update

Response
200 response Modified
- application/json content type Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required
  - source property Modified
    - _source property Modified

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn, pinned properties Modified
- 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
    - knn, pinned properties Modified
- 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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn, pinned properties Modified

POST /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn, pinned properties Modified
  - knn property Modified
    - _types:KnnSearch, array-2 alternatives Modified
  - post_filter property Modified
    - knn, pinned properties Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
  - search_after property Modified
    - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
      Breaking
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /_query

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- params property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
- include_ccs_metadata property Added

POST /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

POST /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

PUT /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - settings property Modified
    - lifecycle, mapping properties Modified
  - defaults property Modified
    - lifecycle, mapping properties Modified

PUT /_enrich/policy/{name}

Body
application/json content type Modified
- geo_match property Modified
  - query property Modified
    - knn, pinned properties Modified
- match property Modified
  - query property Modified
    - knn, pinned properties Modified
- range property Modified
  - query property Modified
    - knn, pinned properties Modified
Query
master_timeout query parameter Added

PUT /_enrich/policy/{name}/_execute

Query
master_timeout query parameter Added

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - * property Modified
  - settings property Modified
    - lifecycle, mapping properties Modified

PUT /_ingest/pipeline/{id}

Body
application/json content type Modified
- on_failure property Modified
  - append property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - attachment property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - bytes property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - circle property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - community_id property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - convert property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - csv property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - date property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - date_index_name property Modified
    - if property Modified
      - Type went from string to object
        Breaking
    - date_formats property Modified
      - Property is no longer required
  - dissect property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - dot_expander property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - drop property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - enrich property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - fail property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - fingerprint property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - foreach property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - ip_location property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - geo_grid property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - geoip property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - grok property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - gsub property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - html_strip property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - inference property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - join property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - json property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - kv property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - lowercase property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - network_direction property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - pipeline property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - redact property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - registered_domain property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - remove property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - rename property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - reroute property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - script property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - set property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - set_security_user property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - sort property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - split property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - terminate property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - trim property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - uppercase property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - urldecode property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - uri_parts property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - user_agent property Modified
    - if property Modified
      - Type went from string to object
        Breaking
- processors property Modified
  - append property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - attachment property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - bytes property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - circle property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - community_id property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - convert property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - csv property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - date property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - date_index_name property Modified
    - if property Modified
      - Type went from string to object
        Breaking
    - date_formats property Modified
      - Property is no longer required
  - dissect property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - dot_expander property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - drop property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - enrich property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - fail property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - fingerprint property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - foreach property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - ip_location property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - geo_grid property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - geoip property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - grok property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - gsub property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - html_strip property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - inference property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - join property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - json property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - kv property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - lowercase property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - network_direction property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - pipeline property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - redact property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - registered_domain property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - remove property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - rename property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - reroute property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - script property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - set property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - set_security_user property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - sort property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - split property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - terminate property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - trim property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - uppercase property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - urldecode property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - uri_parts property Modified
    - if property Modified
      - Type went from string to object
        Breaking
  - user_agent property Modified
    - if property Modified
      - Type went from string to object
        Breaking

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn, pinned properties Modified

PUT /_ml/data_frame/analytics/{id}

Body
application/json content type Modified
- analyzed_fields property Modified
  - includes, excludes properties Modified
    - Properties are no longer required
- source property Modified
  - _source property Modified
    - includes, excludes properties Modified
      - Properties are no longer required
Response
200 response Modified
- application/json content type Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required
  - source property Modified
    - _source property Modified

PUT /_ml/datafeeds/{datafeed_id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn, pinned properties Modified

PUT /_query_rules/{ruleset_id}

Body
application/json content type Modified
- rules property Modified
  - _types:QueryRule alternative Modified
    - actions property Modified
  - array-2 alternative Modified
    - actions property Modified

PUT /_query_rules/{ruleset_id}/_rule/{rule_id}

Body
application/json content type Modified
- actions property Modified
  - docs property Modified
    - _index property Modified
      - Property is no longer required

PUT /_scripts/{id}

Query
context query parameter Added

PUT /_scripts/{id}/{context}

Query
context query parameter Added

PUT /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

PUT /_security/api_key/{id}

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices 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

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 /{index}

Body
application/json content type Modified
- aliases property Modified
  - * property Modified
    - filter property 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}/_alias/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

PUT /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property 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}/_create/{id}

Query
include_source_on_error query parameter Added

PUT /{index}/_doc/{id}

Query
include_source_on_error query parameter Added

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

POST /{index}/_async_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- rescore property Modified
  - _types:Rescore alternative Modified
    - query property Modified
  - array-2 alternative Modified
    - query property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits property Modified
Query
keep_alive 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}/_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated

POST /{index}/_create/{id}

Query
include_source_on_error query parameter Added

POST /{index}/_delete_by_query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_doc

Query
include_source_on_error query parameter Added

POST /{index}/_doc/{id}

Query
include_source_on_error query parameter Added

POST /{index}/_eql/search

Body
application/json content type Modified
- filter property Modified
  - query_dsl:QueryContainer alternative Modified
    - knn, pinned properties Modified
  - array-2 alternative Modified
    - knn, pinned properties Modified
Response
200 response Modified
- application/json content type Modified
  - shard_failures property Added

POST /{index}/_explain/{id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_graph/explore

Body
application/json content type Modified
- connections property Modified
  - query property Modified
    - Property is no longer required
    - knn, pinned properties Modified
  - vertices property Modified
    - include property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- vertices property Modified
  - include property Modified
    - boost property Modified
      - Property is no longer required

POST /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn, pinned properties Modified
  - knn property Modified
    - _types:KnnSearch, array-2 alternatives Modified
  - post_filter property Modified
    - knn, pinned properties Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
  - search_after property Modified
    - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
      Breaking
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_pit

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

POST /{index}/_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- 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
    - search_after property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking
  - knn property Modified
    - filter property Modified
    - rescore_vector property Added
  - rrf property Modified
    - filter property Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /{index}/_search/template

Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /{index}/_terms_enum

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_update/{id}

Query
include_source_on_error query parameter Added

POST /{index}/_update_by_query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /{index}/_validate/query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

PUT /_bulk

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - * property Modified
Query
include_source_on_error query parameter Added

GET /_cat/ml/trained_models/{model_id}

Response
200 response Modified
- text/plain content type Added

GET /_component_template

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_component_template/{name}

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_connector

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - deleted property Added
Query
include_deleted query parameter Added

GET /_connector/{connector_id}

Response
200 response Modified
- application/json content type Modified
  - deleted property Added
Query
include_deleted query parameter Added

GET /_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated

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/policy/{name}

Response
200 response Modified
- application/json content type Modified
  - policies property Modified
    - config property Modified
Query
master_timeout query parameter Added

GET /_eql/search/{id}

Response
200 response Modified
- application/json content type Modified
  - shard_failures property Added

GET /_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs 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/pipeline

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - 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

GET /_ingest/pipeline/{id}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - 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

GET /_ml/data_frame/analytics

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - analyzed_fields, source properties Modified

GET /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - _source property Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required

GET /_ml/data_frame/analytics/{id}

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - analyzed_fields, source properties Modified

GET /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - _source property Modified
  - analyzed_fields property Modified
    - includes, excludes properties Modified
      - Properties are no longer required

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn, pinned properties Modified
- 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
    - knn, pinned properties Modified
- job_config property Modified
  - datafeed_config property Modified
    - query property Modified

DELETE /_enrich/policy/{name}

Query
master_timeout query parameter Added

DELETE /_ml/trained_models/{model_id}

Query
timeout query parameter Added

DELETE /_search/scroll/{scroll_id}

Path
scroll_id path parameter Modified
- Path parameter is now deprecated

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 /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_async_search/{id}

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits property Modified

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/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/indices

Response
200 response Modified
- text/plain content type Added

GET /_cat/indices/{index}

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/ml/anomaly_detectors/{job_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/data_frame/analytics/{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/datafeeds/{datafeed_id}

Response
200 response Modified
- text/plain content type Added

GET /_cat/ml/trained_models

Response
200 response Modified
- text/plain content type Added

GET /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn, pinned properties Modified
  - knn property Modified
    - _types:KnnSearch, array-2 alternatives Modified
  - post_filter property Modified
    - knn, pinned properties Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
  - search_after property Modified
    - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
      Breaking
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative 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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated

GET /{index}/_eql/search

Body
application/json content type Modified
- filter property Modified
  - query_dsl:QueryContainer alternative Modified
    - knn, pinned properties Modified
  - array-2 alternative Modified
    - knn, pinned properties Modified
Response
200 response Modified
- application/json content type Modified
  - shard_failures property Added

GET /{index}/_explain/{id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

GET /{index}/_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

GET /{index}/_graph/explore

Body
application/json content type Modified
- connections property Modified
  - query property Modified
    - Property is no longer required
    - knn, pinned properties Modified
  - vertices property Modified
    - include property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- vertices property Modified
  - include property Modified
    - boost property Modified
      - Property is no longer required

GET /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn, pinned properties Modified
  - knn property Modified
    - _types:KnnSearch, array-2 alternatives Modified
  - post_filter property Modified
    - knn, pinned properties Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
  - search_after property Modified
    - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
      Breaking
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

GET /{index}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

GET /{index}/_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- 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
    - search_after property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking
  - knn property Modified
    - filter property Modified
    - rescore_vector property Added
  - rrf property Modified
    - filter property Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /{index}/_search/template

Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits 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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

GET /{index}/_validate/query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

POST /_aliases

Body
application/json content type Modified
- actions property Modified
  - add property Modified
    - filter property Modified

POST /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_async_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- rescore property Modified
  - _types:Rescore alternative Modified
    - query property Modified
  - array-2 alternative Modified
    - query property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits property Modified
Query
keep_alive 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

GET /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /_query_rules/{ruleset_id}

Response
200 response Modified
- application/json content type Modified
  - rules property Modified
    - actions property Modified

GET /_query_rules/{ruleset_id}/_rule/{rule_id}

Response
200 response Modified
- application/json content type Modified
  - actions property Modified
    - docs property Modified

GET /_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

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 /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified
    - knn, pinned properties Modified

GET /_search

Body
application/json content type Modified
- knn property Modified
  - _types:KnnSearch alternative Modified
    - filter property Modified
    - rescore_vector property Added
  - array-2 alternative Modified
    - filter property Modified
    - rescore_vector property Added
- post_filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- query property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- 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
    - search_after property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking
  - knn property Modified
    - filter property Modified
    - rescore_vector property Added
  - rrf property Modified
    - filter property Modified
  - text_similarity_reranker property Modified
    - filter property Modified
  - rule property Modified
    - filter property Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_search/template

Query
ignore_throttled query parameter Modified
- Query parameter is now deprecated
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_security/_query/api_key

Body
application/json content type Modified
- search_after property Modified
  - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
    Breaking
Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by, access properties Modified
    - _sort property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        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
    - _sort property Modified
      - Type went from array[number | string | boolean | null | object] to array[number | string | boolean | null]
        Breaking

GET /_security/role

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property Modified

GET /_security/role/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property Modified

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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
- allow_partial_search_results property Added

GET /_sql/translate

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn, pinned properties 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
  - knn property Modified
    - rescore_vector property Added
  - pinned property Modified
    - docs property Modified

Added 4

POST /_security/_query/role

POST /_inference/{task_type}/{inference_id}/_unified

POST /_inference/{inference_id}/_unified

GET /_security/_query/role

Dec 20, 2024

Change #30ba88e9

Breaking

Compare

11 structure changes including:

11 Modifications

Modified 11 Breaking

GET /_cat

Response
200 response Modified
- application/json content type Modified
  - Type went from array[object] to object
    Breaking

GET /_cat/aliases

Query
master_timeout query parameter Added

GET /_cat/aliases/{name}

Query
master_timeout query parameter Added

GET /_cat/component_templates

Query
master_timeout query parameter Added

GET /_cat/component_templates/{name}

Query
master_timeout query parameter Added

GET /_cat/indices

Query
master_timeout query parameter Added

GET /_cat/indices/{index}

Query
master_timeout query parameter Added

GET /_cat/ml/trained_models

Query
time query parameter Added

GET /_cat/ml/trained_models/{model_id}

Query
time query parameter Added

GET /{index}/_eql/search

Body
application/json content type Modified
- allow_partial_search_results, allow_partial_sequence_results properties Added
Query
allow_partial_search_results, allow_partial_sequence_results query parameters Added

POST /{index}/_eql/search

Body
application/json content type Modified
- allow_partial_search_results, allow_partial_sequence_results properties Added
Query
allow_partial_search_results, allow_partial_sequence_results query parameters Added

Dec 12, 2024

Change #d6b06ad8

Breaking

Compare

26 structure changes including:

26 Modifications

Modified 26 Breaking

GET /_ml/anomaly_detectors

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/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_limits 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/data_frame/analytics

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - _meta property Added

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/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/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/{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/{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/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/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/{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/{model_id}/_stats

Response
200 response Modified
- application/json content type Modified
  - trained_model_stats property Modified
    - deployment_stats property Modified

POST /_bulk

Query
list_executed_pipelines, require_data_stream query parameters Added

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/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/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/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/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 /{index}/_bulk

Query
list_executed_pipelines, require_data_stream query parameters Added

PUT /_bulk

Query
list_executed_pipelines, require_data_stream query parameters 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

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/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 /{index}/_bulk

Query
list_executed_pipelines, require_data_stream query parameters Added

Dec 5, 2024

Change #f9d8e6ca

Breaking

Compare

29 structure changes including:

29 Modifications

Modified 29

GET /_alias

Query
master_timeout query parameter Added

GET /_alias/{name}

Query
master_timeout query parameter Added

GET /_component_template

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_component_template/{name}

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_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 /_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}/_alias

Query
master_timeout query parameter Added

GET /{index}/_alias/{name}

Query
master_timeout query parameter Added

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - settings, defaults properties Modified

HEAD /_alias/{name}

Query
master_timeout query parameter Added

HEAD /{index}/_alias/{name}

Query
master_timeout query parameter Added

POST /_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 /_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

PUT /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - settings property Modified
    - mapping property Modified
  - defaults property Modified
    - mapping property Modified

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - settings property Modified
    - mapping property Modified

PUT /_settings

Body
application/json content type Modified
- mapping property Modified
  - total_fields property Modified
    - limit, ignore_dynamic_beyond_limit properties Modified
      - Combinator is now oneOf

PUT /{index}

Body
application/json content type Modified
- settings property Modified
  - mapping property Modified
    - total_fields property Modified

PUT /{index}/_settings

Body
application/json content type Modified
- mapping property Modified
  - total_fields property Modified
    - limit, ignore_dynamic_beyond_limit properties Modified
      - Combinator is now oneOf

Dec 3, 2024

Change #b60c3a79

Breaking

Compare

109 structure changes including:

109 Modifications

Modified 109 Breaking

DELETE /_scripts/{id}

Operation is no longer beta

DELETE /_search/scroll

Operation is no longer beta

DELETE /_search/scroll/{scroll_id}

Operation is no longer beta

DELETE /_security/role/{name}

Operation is no longer beta

DELETE /{index}

Operation is no longer beta

DELETE /{index}/_alias/{name}

Operation is no longer beta

DELETE /{index}/_aliases/{name}

Operation is no longer beta

DELETE /{index}/_doc/{id}

Operation is no longer beta

GET /

Operation is no longer beta

GET /_alias

Operation is no longer beta

GET /_alias/{name}

Operation is no longer beta

GET /_analyze

Operation is no longer beta

GET /_async_search/status/{id}

Query
keep_alive query parameter Added

GET /_cat

Operation is no longer beta

GET /_cat/aliases

Operation is no longer beta

GET /_cat/aliases/{name}

Operation is no longer beta

GET /_cat/count

Operation is no longer beta

GET /_cat/count/{index}

Operation is no longer beta

GET /_cat/indices

Operation is no longer beta

GET /_cat/indices/{index}

Operation is no longer beta

GET /_count

Operation is no longer beta

GET /_license

Operation is no longer beta

GET /_mapping

Operation is no longer beta

GET /_mtermvectors

Operation is no longer beta

GET /_refresh

Operation is no longer beta

GET /_render/template

Operation is no longer beta

GET /_render/template/{id}

Operation is no longer beta

GET /_scripts/{id}

Operation is no longer beta

GET /_search

Operation is no longer beta

GET /_search/scroll

Operation is no longer beta

GET /_search/scroll/{scroll_id}

Operation is no longer beta

GET /_security/_authenticate

Response
200 response Modified
- application/json content type Modified
  - api_key property Modified
    - name property Modified
      - Property is no longer required
    - creation, expiration, invalidated, realm, realm_type, username, profile_uid, metadata, role_descriptors, limited_by, _sort properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /_security/_query/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - _types:UnitMillis property Modified
      - Name is no longer creation
        Breaking
    - _types:UnitMillis property Modified
      - Name is no longer expiration
        Breaking
    - invalidated, username, realm, metadata properties Modified
      - Properties are now required
        Breaking
    - type, _types:UnitMillis, access properties Added

GET /_security/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - _types:UnitMillis property Modified
      - Name is no longer creation
        Breaking
    - _types:UnitMillis property Modified
      - Name is no longer expiration
        Breaking
    - invalidated, username, realm, metadata properties Modified
      - Properties are now required
        Breaking
    - type, _types:UnitMillis, access properties Added

GET /_security/role

Operation is no longer beta

GET /_security/role/{name}

Operation is no longer beta

GET /_settings

Operation is no longer beta

GET /_settings/{name}

Operation is no longer beta

GET /{index}

Operation is no longer beta

GET /{index}/_alias

Operation is no longer beta

GET /{index}/_alias/{name}

Operation is no longer beta

GET /{index}/_analyze

Operation is no longer beta

GET /{index}/_count

Operation is no longer beta

GET /{index}/_doc/{id}

Operation is no longer beta

GET /{index}/_explain/{id}

Operation is no longer beta

GET /{index}/_graph/explore

Operation is no longer beta

GET /{index}/_mapping

Operation is no longer beta

GET /{index}/_mtermvectors

Operation is no longer beta

GET /{index}/_refresh

Operation is no longer beta

GET /{index}/_search

Operation is no longer beta

GET /{index}/_settings

Operation is no longer beta

GET /{index}/_settings/{name}

Operation is no longer beta

GET /{index}/_source/{id}

Operation is no longer beta

GET /{index}/_termvectors

Operation is no longer beta

GET /{index}/_termvectors/{id}

Operation is no longer beta

HEAD /

Operation is no longer beta

HEAD /_alias/{name}

Operation is no longer beta

HEAD /_index_template/{name}

Operation is no longer beta

HEAD /{index}

Operation is no longer beta

HEAD /{index}/_alias/{name}

Operation is no longer beta

HEAD /{index}/_doc/{id}

Operation is no longer beta

POST /_analyze

Operation is no longer beta

POST /_async_search

Query
keep_alive, pre_filter_shard_size, scroll query parameters Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking

POST /_bulk

Operation is no longer beta

POST /_count

Operation is no longer beta

POST /_index_template/_simulate

Operation is no longer beta

POST /_index_template/_simulate/{name}

Operation is no longer beta

POST /_mtermvectors

Operation is no longer beta

POST /_query

Operation is no longer beta

POST /_refresh

Operation is no longer beta

POST /_render/template

Operation is no longer beta

POST /_render/template/{id}

Operation is no longer beta

POST /_scripts/{id}

Operation is no longer beta

POST /_scripts/{id}/{context}

Operation is no longer beta

POST /_search

Operation is no longer beta

POST /_search/scroll

Operation is no longer beta

POST /_search/scroll/{scroll_id}

Operation is no longer beta

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/role/{name}

Operation is no longer beta

POST /{index}/_alias/{name}

Operation is no longer beta

POST /{index}/_aliases/{name}

Operation is no longer beta

POST /{index}/_analyze

Operation is no longer beta

POST /{index}/_async_search

Query
keep_alive, pre_filter_shard_size, scroll query parameters Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking

POST /{index}/_bulk

Operation is no longer beta

POST /{index}/_count

Operation is no longer beta

POST /{index}/_doc

Operation is no longer beta

POST /{index}/_doc/{id}

Operation is no longer beta

POST /{index}/_explain/{id}

Operation is no longer beta

POST /{index}/_graph/explore

Operation is no longer beta

POST /{index}/_mapping

Operation is no longer beta

POST /{index}/_mtermvectors

Operation is no longer beta

POST /{index}/_pit

Query
allow_partial_search_results query parameter Added

POST /{index}/_refresh

Operation is no longer beta

POST /{index}/_search

Operation is no longer beta

POST /{index}/_termvectors

Operation is no longer beta

POST /{index}/_termvectors/{id}

Operation is no longer beta

POST /{index}/_update/{id}

Operation is no longer beta

PUT /_bulk

Operation is no longer beta

PUT /_scripts/{id}

Operation is no longer beta

PUT /_scripts/{id}/{context}

Operation is no longer beta

PUT /_security/role/{name}

Operation is no longer beta

PUT /_settings

Operation is no longer beta

PUT /{index}

Operation is no longer beta

PUT /{index}/_alias/{name}

Operation is no longer beta

PUT /{index}/_aliases/{name}

Operation is no longer beta

PUT /{index}/_bulk

Operation is no longer beta

PUT /{index}/_doc/{id}

Operation is no longer beta

PUT /{index}/_mapping

Operation is no longer beta

PUT /{index}/_settings

Operation is no longer beta

Nov 19, 2024

Change #e08e9975

Compare

14 structure changes including:

14 Modifications

Modified 14

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
    - role_descriptors, limited_by properties Modified

GET /_security/_query/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/role

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property Modified

GET /_security/role/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - indices property Modified

POST /_security/_query/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

POST /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified
    - restriction property Added

POST /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - names property Modified
    - Combinator is now oneOf
    - names alternative Removed
    - _types:IndexName, array-2 alternatives Added

PUT /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified
    - restriction property Added

PUT /_security/api_key/{id}

Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified
    - restriction property Added

PUT /_security/role/{name}

Body
application/json content type Modified
- indices property Modified
  - names property Modified
    - Combinator is now oneOf
    - names alternative Removed
    - _types:IndexName, array-2 alternatives Added

Nov 13, 2024

Change #569b3a36

Compare

15 structure changes including:

15 Modifications

Modified 15

GET /_cat/component_templates

Query
local query parameter Added

GET /_cat/component_templates/{name}

Query
local query parameter Added

GET /_ingest/pipeline

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - ip_location property Added
  - processors property Modified
    - ip_location property Added

GET /_ingest/pipeline/{id}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - ip_location property Added
  - processors property Modified
    - ip_location property Added

GET /_search

Query
min_compatible_shard_node query parameter Removed

GET /{index}/_search

Query
min_compatible_shard_node query parameter Removed

POST /_async_search

Query
min_compatible_shard_node query parameter Removed

POST /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - ip_location property Added
  - processors property Modified
    - ip_location property Added

POST /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - ip_location property Added
  - processors property Modified
    - ip_location property Added

POST /_search

Query
min_compatible_shard_node query parameter Removed

POST /{index}/_async_search

Query
min_compatible_shard_node query parameter Removed

POST /{index}/_search

Query
min_compatible_shard_node query parameter Removed

PUT /_ingest/pipeline/{id}

Body
application/json content type Modified
- on_failure property Modified
  - ip_location property Added
- processors property Modified
  - ip_location property Added

Nov 5, 2024

Change #de31a0ef

Compare

10 structure changes including:

10 Modifications

Modified 10

GET /_alias

Query
local query parameter Removed

GET /_alias/{name}

Query
local query parameter Removed

GET /_search

Body
application/json content type Modified
- retriever property Modified
  - knn property Modified
    - min_score property Added
  - rrf property Modified
    - min_score property Added
  - text_similarity_reranker, rule properties Added

GET /{index}/_alias

Query
local query parameter Removed

GET /{index}/_alias/{name}

Query
local query parameter Removed

GET /{index}/_search

Body
application/json content type Modified
- retriever property Modified
  - knn property Modified
    - min_score property Added
  - rrf property Modified
    - min_score property Added
  - text_similarity_reranker, rule properties Added

HEAD /_alias/{name}

Query
local query parameter Removed

HEAD /{index}/_alias/{name}

Query
local query parameter Removed

POST /_search

Body
application/json content type Modified
- retriever property Modified
  - knn property Modified
    - min_score property Added
  - rrf property Modified
    - min_score property Added
  - text_similarity_reranker, rule properties Added

POST /{index}/_search

Body
application/json content type Modified
- retriever property Modified
  - knn property Modified
    - min_score property Added
  - rrf property Modified
    - min_score property Added
  - text_similarity_reranker, rule properties Added

Oct 25, 2024

Change #d9b2ae81

Compare

29 structure changes including:

1 Addition

28 Modifications

Modified 28

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

PUT /_data_stream/{name}/_lifecycle

Body
application/json content type Modified
- Content type is now required
- enabled property Added

PUT /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

PUT /_application/search_application/{name}

Body
application/json content type Modified
- name, _types:UnitMillis properties Removed

POST /{index}/_eql/search

Body
application/json content type Modified
- max_samples_per_key property Added

POST /_transform/{transform_id}/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - _types:DataStreamLifecycle property Modified

POST /_transform/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - _types:DataStreamLifecycle property Modified

POST /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

POST /_index_template/_simulate/{name}

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

POST /_index_template/_simulate

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

POST /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - _types:DataStreamLifecycle property Modified
    - enabled property Added

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - _types:DataStreamLifecycle property Modified

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - _types:DataStreamLifecycle property Modified

GET /{index}/_lifecycle/explain

Response
200 response Modified
- application/json content type Modified
  - indices property Modified
    - * property Modified

GET /{index}/_eql/search

Body
application/json content type Modified
- max_samples_per_key property Added

GET /{index}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - _types:DataStreamLifecycle property Modified

GET /_transform/{transform_id}/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - _types:DataStreamLifecycle property Modified

GET /_transform/_preview

Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - _types:DataStreamLifecycle property Modified

GET /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - _types:DataStreamLifecycle property Modified

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - _types:DataStreamLifecycle 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 /_data_stream/{name}/_lifecycle

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - lifecycle property Modified

GET /_data_stream/{name}

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - lifecycle property Modified

GET /_data_stream

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - lifecycle 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 /_application/search_application

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - template property Added

Added 1

POST /_query_rules/{ruleset_id}/_test

Oct 21, 2024

Change #e6d3b6a5

Compare

18 structure changes including:

18 Modifications

Modified 18

GET /_analyze

Body
application/json content type Modified
- char_filter, filter properties Modified
  - Type went from array[string | object] to array
- tokenizer property Removed
  - analysis:Tokenizer property Removed
  - property Removed
    - analysis:CharGroupTokenizer, analysis:ClassicTokenizer, analysis:EdgeNGramTokenizer, analysis:KeywordTokenizer, analysis:LetterTokenizer, analysis:LowercaseTokenizer, analysis:NGramTokenizer, analysis:PathHierarchyTokenizer, analysis:PatternTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:StandardTokenizer, analysis:ThaiTokenizer, analysis:UaxEmailUrlTokenizer, analysis:WhitespaceTokenizer, analysis:IcuTokenizer, analysis:KuromojiTokenizer, analysis:NoriTokenizer properties Removed

GET /_connector

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - filtering property Modified

GET /_connector/_sync_job

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - connector property Modified

GET /_connector/_sync_job/{connector_sync_job_id}

Response
200 response Modified
- application/json content type Modified
  - connector property Modified
    - filtering property Modified

GET /_connector/{connector_id}

Response
200 response Modified
- application/json content type Modified
  - filtering property Modified
    - active, draft properties Modified

GET /_ml/anomaly_detectors

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config property Modified

GET /_ml/anomaly_detectors/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config property Modified

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /{index}/_analyze

Body
application/json content type Modified
- char_filter, filter properties Modified
  - Type went from array[string | object] to array
- tokenizer property Removed
  - analysis:Tokenizer property Removed
  - property Removed
    - analysis:CharGroupTokenizer, analysis:ClassicTokenizer, analysis:EdgeNGramTokenizer, analysis:KeywordTokenizer, analysis:LetterTokenizer, analysis:LowercaseTokenizer, analysis:NGramTokenizer, analysis:PathHierarchyTokenizer, analysis:PatternTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:StandardTokenizer, analysis:ThaiTokenizer, analysis:UaxEmailUrlTokenizer, analysis:WhitespaceTokenizer, analysis:IcuTokenizer, analysis:KuromojiTokenizer, analysis:NoriTokenizer properties Removed

POST /_analyze

Body
application/json content type Modified
- char_filter, filter properties Modified
  - Type went from array[string | object] to array
- tokenizer property Removed
  - analysis:Tokenizer property Removed
  - property Removed
    - analysis:CharGroupTokenizer, analysis:ClassicTokenizer, analysis:EdgeNGramTokenizer, analysis:KeywordTokenizer, analysis:LetterTokenizer, analysis:LowercaseTokenizer, analysis:NGramTokenizer, analysis:PathHierarchyTokenizer, analysis:PatternTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:StandardTokenizer, analysis:ThaiTokenizer, analysis:UaxEmailUrlTokenizer, analysis:WhitespaceTokenizer, analysis:IcuTokenizer, analysis:KuromojiTokenizer, analysis:NoriTokenizer properties Removed

POST /_ml/anomaly_detectors/_estimate_model_memory

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified

POST /_ml/anomaly_detectors/{job_id}/_update

Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /{index}/_analyze

Body
application/json content type Modified
- char_filter, filter properties Modified
  - Type went from array[string | object] to array
- tokenizer property Removed
  - analysis:Tokenizer property Removed
  - property Removed
    - analysis:CharGroupTokenizer, analysis:ClassicTokenizer, analysis:EdgeNGramTokenizer, analysis:KeywordTokenizer, analysis:LetterTokenizer, analysis:LowercaseTokenizer, analysis:NGramTokenizer, analysis:PathHierarchyTokenizer, analysis:PatternTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:StandardTokenizer, analysis:ThaiTokenizer, analysis:UaxEmailUrlTokenizer, analysis:WhitespaceTokenizer, analysis:IcuTokenizer, analysis:KuromojiTokenizer, analysis:NoriTokenizer properties Removed

PUT /_connector/{connector_id}/_filtering

Body
application/json content type Modified
- filtering property Modified
  - active property Modified
    - advanced_snippet property Modified
  - draft property Modified
    - advanced_snippet property Modified
- advanced_snippet property Modified
  - value property Modified
    - * property Removed

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified
Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

Oct 16, 2024

Change #9b1fa37d

Compare

This documentation refresh adds API status details such as when they were first added.

29 structure changes including:

6 Additions

19 Modifications

4 Removals

Modified 19

PUT /_ingest/pipeline/{id}

Operation is now Added in 5.0.0
Operation is no longer beta
Body
application/json content type Modified
- on_failure property Modified
  - date property Modified
    - output_format property Added
  - grok property Modified
    - ecs_compatibility property Added
  - community_id, fingerprint, network_direction, registered_domain, terminate properties Added
- processors property Modified
  - date property Modified
    - output_format property Added
  - grok property Modified
    - ecs_compatibility property Added
  - community_id, fingerprint, network_direction, registered_domain, terminate properties Added

PUT /_inference/{task_type}/{inference_id}

Operation is now Technical preview
Operation is no longer beta
Body
application/json content type Modified
- task_settings property Modified
  - Property is no longer required
Response
200 response Modified
- application/json content type Modified
  - task_settings property Modified
    - Property is no longer required

PUT /_inference/{inference_id}

Operation is now Technical preview
Operation is no longer beta
Body
application/json content type Modified
- task_settings property Modified
  - Property is no longer required
Response
200 response Modified
- application/json content type Modified
  - task_settings property Modified
    - Property is no longer required

POST /_security/api_key

Operation is now Added in 6.7.0
Operation is no longer beta
Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

POST /_security/_query/api_key

Operation is now Added in 7.15.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

POST /_ingest/pipeline/{id}/_simulate

Operation is now Added in 5.0.0
Operation is no longer beta
Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added
  - processors property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added

POST /_ingest/pipeline/_simulate

Operation is now Added in 5.0.0
Operation is no longer beta
Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added
  - processors property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added

GET /_security/api_key

Operation is now Added in 6.7.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/_query/api_key

Operation is now Added in 7.15.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/_authenticate

Operation is now Added in 5.5.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - api_key property Modified
    - role_descriptors, limited_by properties Modified

GET /_ingest/pipeline/{id}/_simulate

Operation is now Added in 5.0.0
Operation is no longer beta
Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added
  - processors property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added

GET /_ingest/pipeline/{id}

Operation is now Added in 5.0.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/_simulate

Operation is now Added in 5.0.0
Operation is no longer beta
Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added
  - processors property Modified
    - date, grok properties Modified
    - community_id, fingerprint, network_direction, registered_domain, terminate properties Added

GET /_ingest/pipeline

Operation is now Added in 5.0.0
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_inference/{task_type}/{inference_id}

Operation is now Technical preview
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - task_settings property Modified
      - Property is no longer required

GET /_inference/{inference_id}

Operation is now Technical preview
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - task_settings property Modified
      - Property is no longer required

GET /_inference

Operation is now Technical preview
Operation is no longer beta
Response
200 response Modified
- application/json content type Modified
  - endpoints property Modified
    - task_settings property Modified
      - Property is no longer required

PUT /_security/api_key

Operation is now Added in 6.7.0
Operation is no longer beta
Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

PUT /_security/api_key/{id}

Operation is now Added in 8.4.0
Operation is no longer beta
Body
application/json content type Modified
- role_descriptors property Modified
  - * property Modified
    - indices property Modified

Removed 4

DELETE /_data_stream/{name}/_lifecycle

GET /_enrich/_stats

POST /_template/{name}

PUT /_template/{name}

Added 6

PUT /_security/role/{name}

POST /_security/role/{name}

GET /_security/role/{name}

GET /_security/role

GET /_security/privilege/_builtin

DELETE /_security/role/{name}

Oct 4, 2024

Change #25dc2218

Breaking

Compare

The APIs are grouped differently now: we've added tags that align more closely with the old documentation.

57 structure changes including:

55 Modifications

2 Removals

Modified 55

GET /_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:KeywordMarkerTokenFilter alternative Modified
    - keywords property Modified
      - Combinator is now oneOf
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required
  - analysis:KeywordTokenizer alternative Modified
    - buffer_size property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required

GET /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /_async_search/{id}

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits, profile properties Modified

GET /_ingest/pipeline

Response
200 response Modified
- application/json content type Modified
  - * property Modified
    - on_failure, processors properties Modified

GET /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - redact property Modified
  - processors property Modified
    - redact property Modified
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - doc, 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/{id}/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - redact property Modified
  - processors property Modified
    - redact property Modified
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - doc, processor_results properties Modified

GET /_ml/anomaly_detectors

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config property Modified

GET /_ml/anomaly_detectors/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config property Modified

GET /_ml/calendars/{calendar_id}/events

Response
200 response Modified
- application/json content type Modified
  - events property Modified
    - skip_result, skip_model_update, force_time_shift properties Added

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /_msearch

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - Property is no longer required

GET /_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /{index}/_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:KeywordMarkerTokenFilter alternative Modified
    - keywords property Modified
      - Combinator is now oneOf
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required
  - analysis:KeywordTokenizer alternative Modified
    - buffer_size property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required

GET /{index}/_msearch

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /{index}/_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - Property is no longer required

GET /{index}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

GET /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:KeywordMarkerTokenFilter alternative Modified
    - keywords property Modified
      - Combinator is now oneOf
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required
  - analysis:KeywordTokenizer alternative Modified
    - buffer_size property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required

POST /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /_async_search

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits, profile properties Modified

POST /_index_template/_simulate

Body
application/json content type Modified
- data_stream property Modified
  - allow_custom_routing property Added

POST /_index_template/_simulate/{name}

Body
application/json content type Modified
- data_stream property Modified
  - allow_custom_routing property Added

POST /_index_template/{name}

Body
application/json content type Modified
- data_stream property Modified
  - allow_custom_routing property Added

POST /_ingest/pipeline/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - redact property Modified
  - processors property Modified
    - redact property Modified
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - doc, processor_results properties Modified

POST /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- pipeline property Modified
  - on_failure property Modified
    - redact property Modified
  - processors property Modified
    - redact property Modified
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - doc, processor_results properties Modified

POST /_ml/anomaly_detectors/_estimate_model_memory

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified

POST /_ml/anomaly_detectors/{job_id}/_update

Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/calendars/{calendar_id}/events

Body
application/json content type Modified
- events property Modified
  - skip_result, skip_model_update, force_time_shift properties Added
Response
200 response Modified
- application/json content type Modified
  - events property Modified
    - skip_result, skip_model_update, force_time_shift properties Added

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_msearch

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - Property is no longer required

POST /_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /{index}/_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:KeywordMarkerTokenFilter alternative Modified
    - keywords property Modified
      - Combinator is now oneOf
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required
  - analysis:KeywordTokenizer alternative Modified
    - buffer_size property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - max_gram, min_gram properties Modified
      - Properties are no longer required

POST /{index}/_async_search

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits, profile properties Modified

POST /{index}/_msearch

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /{index}/_refresh

Response
200 response Modified
- application/json content type Modified
  - _shards property Modified
    - Property is no longer required

POST /{index}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

POST /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
  - profile property Modified
    - shards property Modified

PUT /_index_template/{name}

Body
application/json content type Modified
- data_stream property Modified
  - allow_custom_routing property Added

PUT /_ingest/pipeline/{id}

Body
application/json content type Modified
- on_failure property Modified
  - redact property Modified
    - trace_redact property Added
- processors property Modified
  - redact property Modified
    - trace_redact property Added

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified
Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

Removed 2

GET /_data_stream/_stats

GET /_data_stream/{name}/_stats

Sep 19, 2024

Change #365e912a

Breaking

Compare

This update qualifies operations as "beta" for now though they continue to be in "technical preview". It also cleans up some query and tokenizer objects that were not fully displayed.

349 structure changes including:

349 Modifications

Modified 349 Breaking

DELETE /_application/analytics/{name}

Operation is now beta

DELETE /_async_search/{id}

Operation is now beta

DELETE /_component_template/{name}

Operation is now beta

DELETE /_data_stream/{name}

Operation is now beta

DELETE /_data_stream/{name}/_lifecycle

Operation is now beta

DELETE /_enrich/policy/{name}

Operation is now beta

DELETE /_eql/search/{id}

Operation is now beta

DELETE /_index_template/{name}

Operation is now beta

DELETE /_inference/{inference_id}

Operation is now beta

DELETE /_inference/{task_type}/{inference_id}

Operation is now beta

DELETE /_ingest/pipeline/{id}

Operation is now beta

DELETE /_logstash/pipeline/{id}

Operation is now beta

DELETE /_ml/anomaly_detectors/{job_id}

Operation is now beta

DELETE /_ml/calendars/{calendar_id}

Operation is now beta

DELETE /_ml/calendars/{calendar_id}/events/{event_id}

Operation is now beta

DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}

Operation is now beta

DELETE /_ml/data_frame/analytics/{id}

Operation is now beta

DELETE /_ml/datafeeds/{datafeed_id}

Operation is now beta

DELETE /_ml/filters/{filter_id}

Operation is now beta

DELETE /_ml/trained_models/{model_id}

Operation is now beta

DELETE /_ml/trained_models/{model_id}/model_aliases/{model_alias}

Operation is now beta

DELETE /_pit

Operation is now beta

DELETE /_query_rules/{ruleset_id}

Operation is now beta

DELETE /_query_rules/{ruleset_id}/_rule/{rule_id}

Operation is now beta

DELETE /_scripts/{id}

Operation is now beta

DELETE /_search/scroll

Operation is now beta

DELETE /_search/scroll/{scroll_id}

Operation is now beta

DELETE /_security/api_key

Operation is now beta

DELETE /_sql/async/delete/{id}

Operation is now beta

DELETE /_synonyms/{id}

Operation is now beta

DELETE /_synonyms/{set_id}/{rule_id}

Operation is now beta

DELETE /_transform/{transform_id}

Operation is now beta

DELETE /{index}

Operation is now beta

DELETE /{index}/_alias/{name}

Operation is now beta

DELETE /{index}/_aliases/{name}

Operation is now beta

DELETE /{index}/_doc/{id}

Operation is now beta

GET /

Operation is now beta

GET /_alias

Operation is now beta

GET /_alias/{name}

Operation is now beta

GET /_analyze

Operation is now beta
Body
application/json content type Modified
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:ClassicTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:ThaiTokenizer alternatives Added

GET /_application/analytics

Operation is now beta

GET /_application/analytics/{name}

Operation is now beta

GET /_async_search/status/{id}

Operation is now beta

GET /_async_search/{id}

Operation is now beta

GET /_cat

Operation is now beta

GET /_cat/aliases

Operation is now beta

GET /_cat/aliases/{name}

Operation is now beta

GET /_cat/component_templates

Operation is now beta

GET /_cat/component_templates/{name}

Operation is now beta

GET /_cat/count

Operation is now beta

GET /_cat/count/{index}

Operation is now beta

GET /_cat/indices

Operation is now beta

GET /_cat/indices/{index}

Operation is now beta

GET /_cat/ml/anomaly_detectors

Operation is now beta

GET /_cat/ml/anomaly_detectors/{job_id}

Operation is now beta

GET /_cat/ml/data_frame/analytics

Operation is now beta

GET /_cat/ml/data_frame/analytics/{id}

Operation is now beta

GET /_cat/ml/datafeeds

Operation is now beta

GET /_cat/ml/datafeeds/{datafeed_id}

Operation is now beta

GET /_cat/ml/trained_models

Operation is now beta

GET /_cat/ml/trained_models/{model_id}

Operation is now beta

GET /_cat/transforms

Operation is now beta

GET /_cat/transforms/{transform_id}

Operation is now beta

GET /_component_template

Operation is now beta

GET /_component_template/{name}

Operation is now beta

GET /_count

Operation is now beta

GET /_data_stream

Operation is now beta

GET /_data_stream/_stats

Operation is now beta

GET /_data_stream/{name}

Operation is now beta

GET /_data_stream/{name}/_lifecycle

Operation is now beta

GET /_data_stream/{name}/_stats

Operation is now beta

GET /_enrich/_stats

Operation is now beta

GET /_enrich/policy

Operation is now beta

GET /_enrich/policy/{name}

Operation is now beta

GET /_eql/search/status/{id}

Operation is now beta

GET /_eql/search/{id}

Operation is now beta

GET /_field_caps

Operation is now beta

GET /_index_template

Operation is now beta

GET /_index_template/{name}

Operation is now beta

GET /_inference

Operation is now beta

GET /_inference/{inference_id}

Operation is now beta

GET /_inference/{task_type}/{inference_id}

Operation is now beta

GET /_info/{target}

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - ingest property Modified
    - pipelines, total properties Modified

GET /_ingest/pipeline

Operation is now beta

GET /_ingest/pipeline/_simulate

Operation is now beta

GET /_ingest/pipeline/{id}

Operation is now beta

GET /_ingest/pipeline/{id}/_simulate

Operation is now beta

GET /_ingest/processor/grok

Operation is now beta

GET /_license

Operation is now beta

GET /_logstash/pipeline

Operation is now beta

GET /_logstash/pipeline/{id}

Operation is now beta

GET /_mapping

Operation is now beta

GET /_mget

Operation is now beta

GET /_ml/anomaly_detectors

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config, datafeed_config properties Modified

GET /_ml/anomaly_detectors/_stats

Operation is now beta

GET /_ml/anomaly_detectors/{job_id}

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config, datafeed_config properties Modified

GET /_ml/anomaly_detectors/{job_id}/_stats

Operation is now beta

GET /_ml/anomaly_detectors/{job_id}/results/overall_buckets

Operation is now beta

GET /_ml/calendars

Operation is now beta

GET /_ml/calendars/{calendar_id}

Operation is now beta

GET /_ml/calendars/{calendar_id}/events

Operation is now beta

GET /_ml/data_frame/analytics

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/_preview

Operation is now beta
Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

GET /_ml/data_frame/analytics/_stats

Operation is now beta

GET /_ml/data_frame/analytics/{id}

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/{id}/_preview

Operation is now beta
Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

GET /_ml/data_frame/analytics/{id}/_stats

Operation is now beta

GET /_ml/datafeeds

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - query property Modified

GET /_ml/datafeeds/_preview

Operation is now beta
Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /_ml/datafeeds/_stats

Operation is now beta

GET /_ml/datafeeds/{datafeed_id}

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - query property Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Operation is now beta
Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

GET /_ml/datafeeds/{datafeed_id}/_stats

Operation is now beta

GET /_ml/filters

Operation is now beta

GET /_ml/filters/{filter_id}

Operation is now beta

GET /_ml/trained_models

Operation is now beta

GET /_ml/trained_models/_stats

Operation is now beta

GET /_ml/trained_models/{model_id}

Operation is now beta

GET /_ml/trained_models/{model_id}/_stats

Operation is now beta

GET /_msearch

Operation is now beta

GET /_msearch/template

Operation is now beta

GET /_mtermvectors

Operation is now beta

GET /_query_rules

Operation is now beta

GET /_query_rules/{ruleset_id}

Operation is now beta

GET /_query_rules/{ruleset_id}/_rule/{rule_id}

Operation is now beta

GET /_rank_eval

Operation is now beta

GET /_refresh

Operation is now beta

GET /_render/template

Operation is now beta

GET /_render/template/{id}

Operation is now beta

GET /_resolve/index/{name}

Operation is now beta

GET /_scripts/painless/_execute

Operation is now beta

GET /_scripts/{id}

Operation is now beta

GET /_search

Operation is now beta

GET /_search/scroll

Operation is now beta

GET /_search/scroll/{scroll_id}

Operation is now beta

GET /_search/template

Operation is now beta

GET /_security/_authenticate

Operation is now beta

GET /_security/_query/api_key

Operation is now beta

GET /_security/api_key

Operation is now beta

GET /_security/user/_has_privileges

Operation is now beta

GET /_security/user/{user}/_has_privileges

Operation is now beta

GET /_settings

Operation is now beta

GET /_settings/{name}

Operation is now beta

GET /_sql

Operation is now beta

GET /_sql/async/status/{id}

Operation is now beta

GET /_sql/async/{id}

Operation is now beta

GET /_sql/translate

Operation is now beta

GET /_synonyms

Operation is now beta

GET /_synonyms/{id}

Operation is now beta

GET /_synonyms/{set_id}/{rule_id}

Operation is now beta

GET /_tasks/{task_id}

Operation is now beta

GET /_transform

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/_preview

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

GET /_transform/{transform_id}

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/{transform_id}/_preview

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

GET /_transform/{transform_id}/_stats

Operation is now beta

GET /_validate/query

Operation is now beta

GET /{index}

Operation is now beta

GET /{index}/_alias

Operation is now beta

GET /{index}/_alias/{name}

Operation is now beta

GET /{index}/_analyze

Operation is now beta
Body
application/json content type Modified
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:ClassicTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:ThaiTokenizer alternatives Added

GET /{index}/_count

Operation is now beta

GET /{index}/_doc/{id}

Operation is now beta

GET /{index}/_eql/search

Operation is now beta

GET /{index}/_explain/{id}

Operation is now beta

GET /{index}/_field_caps

Operation is now beta

GET /{index}/_graph/explore

Operation is now beta

GET /{index}/_lifecycle/explain

Operation is now beta

GET /{index}/_mapping

Operation is now beta

GET /{index}/_mget

Operation is now beta

GET /{index}/_msearch

Operation is now beta

GET /{index}/_msearch/template

Operation is now beta

GET /{index}/_mtermvectors

Operation is now beta

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Operation is now beta

GET /{index}/_rank_eval

Operation is now beta

GET /{index}/_refresh

Operation is now beta

GET /{index}/_search

Operation is now beta

GET /{index}/_search/template

Operation is now beta

GET /{index}/_settings

Operation is now beta

GET /{index}/_settings/{name}

Operation is now beta

GET /{index}/_source/{id}

Operation is now beta

GET /{index}/_terms_enum

Operation is now beta

GET /{index}/_termvectors

Operation is now beta

GET /{index}/_termvectors/{id}

Operation is now beta

GET /{index}/_validate/query

Operation is now beta

HEAD /

Operation is now beta

HEAD /_alias/{name}

Operation is now beta

HEAD /_component_template/{name}

Operation is now beta

HEAD /_index_template/{name}

Operation is now beta

HEAD /{index}

Operation is now beta

HEAD /{index}/_alias/{name}

Operation is now beta

HEAD /{index}/_doc/{id}

Operation is now beta

HEAD /{index}/_source/{id}

Operation is now beta

POST /_aliases

Operation is now beta

POST /_analyze

Operation is now beta
Body
application/json content type Modified
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:ClassicTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:ThaiTokenizer alternatives Added

POST /_async_search

Operation is now beta

POST /_bulk

Operation is now beta

POST /_component_template/{name}

Operation is now beta

POST /_count

Operation is now beta

POST /_data_stream/_migrate/{name}

Operation is now beta

POST /_data_stream/_modify

Operation is now beta

POST /_field_caps

Operation is now beta

POST /_index_template/_simulate

Operation is now beta

POST /_index_template/_simulate/{name}

Operation is now beta

POST /_index_template/_simulate_index/{name}

Operation is now beta

POST /_index_template/{name}

Operation is now beta

POST /_inference/{inference_id}

Operation is now beta

POST /_inference/{task_type}/{inference_id}

Operation is now beta

POST /_ingest/pipeline/_simulate

Operation is now beta

POST /_ingest/pipeline/{id}/_simulate

Operation is now beta

POST /_mget

Operation is now beta

POST /_ml/anomaly_detectors/_estimate_model_memory

Operation is now beta
Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified

POST /_ml/anomaly_detectors/{job_id}/_close

Operation is now beta

POST /_ml/anomaly_detectors/{job_id}/_flush

Operation is now beta

POST /_ml/anomaly_detectors/{job_id}/_open

Operation is now beta

POST /_ml/anomaly_detectors/{job_id}/_reset

Operation is now beta

POST /_ml/anomaly_detectors/{job_id}/_update

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - query property Modified

POST /_ml/anomaly_detectors/{job_id}/results/overall_buckets

Operation is now beta

POST /_ml/calendars

Operation is now beta

POST /_ml/calendars/{calendar_id}

Operation is now beta

POST /_ml/calendars/{calendar_id}/events

Operation is now beta

POST /_ml/data_frame/_evaluate

Operation is now beta

POST /_ml/data_frame/analytics/_preview

Operation is now beta
Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

POST /_ml/data_frame/analytics/{id}/_preview

Operation is now beta
Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

POST /_ml/data_frame/analytics/{id}/_start

Operation is now beta

POST /_ml/data_frame/analytics/{id}/_stop

Operation is now beta

POST /_ml/data_frame/analytics/{id}/_update

Operation is now beta
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - query property Modified

POST /_ml/datafeeds/_preview

Operation is now beta
Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/datafeeds/{datafeed_id}/_preview

Operation is now beta
Body
application/json content type Modified
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified

POST /_ml/datafeeds/{datafeed_id}/_start

Operation is now beta

POST /_ml/datafeeds/{datafeed_id}/_stop

Operation is now beta

POST /_ml/datafeeds/{datafeed_id}/_update

Operation is now beta

POST /_ml/filters/{filter_id}/_update

Operation is now beta

POST /_ml/trained_models/{model_id}/_infer

Operation is now beta

POST /_ml/trained_models/{model_id}/deployment/_infer

Operation is now beta

POST /_ml/trained_models/{model_id}/deployment/_start

Operation is now beta

POST /_ml/trained_models/{model_id}/deployment/_stop

Operation is now beta

POST /_msearch

Operation is now beta

POST /_msearch/template

Operation is now beta

POST /_mtermvectors

Operation is now beta

POST /_query

Operation is now beta

POST /_rank_eval

Operation is now beta

POST /_refresh

Operation is now beta

POST /_reindex

Operation is now beta

POST /_render/template

Operation is now beta

POST /_render/template/{id}

Operation is now beta

POST /_scripts/painless/_execute

Operation is now beta

POST /_scripts/{id}

Operation is now beta

POST /_scripts/{id}/{context}

Operation is now beta

POST /_search

Operation is now beta

POST /_search/scroll

Operation is now beta

POST /_search/scroll/{scroll_id}

Operation is now beta

POST /_search/template

Operation is now beta

POST /_security/_query/api_key

Operation is now beta

POST /_security/api_key

Operation is now beta

POST /_security/user/_has_privileges

Operation is now beta

POST /_security/user/{user}/_has_privileges

Operation is now beta

POST /_sql

Operation is now beta

POST /_sql/close

Operation is now beta

POST /_sql/translate

Operation is now beta

POST /_template/{name}

Operation is now beta

POST /_transform/_preview

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

POST /_transform/{transform_id}/_preview

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

POST /_transform/{transform_id}/_reset

Operation is now beta

POST /_transform/{transform_id}/_schedule_now

Operation is now beta

POST /_transform/{transform_id}/_start

Operation is now beta

POST /_transform/{transform_id}/_stop

Operation is now beta

POST /_transform/{transform_id}/_update

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

POST /_validate/query

Operation is now beta

POST /{alias}/_rollover

Operation is now beta

POST /{alias}/_rollover/{new_index}

Operation is now beta

POST /{index}/_alias/{name}

Operation is now beta

POST /{index}/_aliases/{name}

Operation is now beta

POST /{index}/_analyze

Operation is now beta
Body
application/json content type Modified
- tokenizer property Modified
  - analysis:EdgeNGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:NGramTokenizer alternative Modified
    - token_chars property Modified
      - Property is no longer required
  - analysis:ClassicTokenizer, analysis:SimplePatternTokenizer, analysis:SimplePatternSplitTokenizer, analysis:ThaiTokenizer alternatives Added

POST /{index}/_async_search

Operation is now beta

POST /{index}/_bulk

Operation is now beta

POST /{index}/_count

Operation is now beta

POST /{index}/_create/{id}

Operation is now beta

POST /{index}/_delete_by_query

Operation is now beta

POST /{index}/_doc

Operation is now beta

POST /{index}/_doc/{id}

Operation is now beta

POST /{index}/_eql/search

Operation is now beta

POST /{index}/_explain/{id}

Operation is now beta

POST /{index}/_field_caps

Operation is now beta

POST /{index}/_graph/explore

Operation is now beta

POST /{index}/_mapping

Operation is now beta

POST /{index}/_mget

Operation is now beta

POST /{index}/_msearch

Operation is now beta

POST /{index}/_msearch/template

Operation is now beta

POST /{index}/_mtermvectors

Operation is now beta

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Operation is now beta

POST /{index}/_pit

Operation is now beta

POST /{index}/_rank_eval

Operation is now beta

POST /{index}/_refresh

Operation is now beta

POST /{index}/_search

Operation is now beta

POST /{index}/_search/template

Operation is now beta

POST /{index}/_terms_enum

Operation is now beta

POST /{index}/_termvectors

Operation is now beta

POST /{index}/_termvectors/{id}

Operation is now beta

POST /{index}/_update/{id}

Operation is now beta

POST /{index}/_update_by_query

Operation is now beta

POST /{index}/_validate/query

Operation is now beta

PUT /_application/analytics/{name}

Operation is now beta

PUT /_bulk

Operation is now beta

PUT /_component_template/{name}

Operation is now beta

PUT /_connector/{connector_id}/_check_in

Operation is now beta

PUT /_connector/{connector_id}/_error

Operation is now beta

PUT /_connector/{connector_id}/_filtering/_activate

Operation is now beta

PUT /_connector/{connector_id}/_filtering/_validation

Operation is now beta

PUT /_connector/{connector_id}/_status

Operation is now beta

PUT /_data_stream/{name}

Operation is now beta

PUT /_data_stream/{name}/_lifecycle

Operation is now beta

PUT /_enrich/policy/{name}

Operation is now beta

PUT /_enrich/policy/{name}/_execute

Operation is now beta

PUT /_index_template/{name}

Operation is now beta

PUT /_inference/{inference_id}

Operation is now beta

PUT /_inference/{task_type}/{inference_id}

Operation is now beta

PUT /_ingest/pipeline/{id}

Operation is now beta

PUT /_logstash/pipeline/{id}

Operation is now beta

PUT /_ml/anomaly_detectors/{job_id}

Operation is now beta
Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified
Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - query property Modified

PUT /_ml/calendars/{calendar_id}

Operation is now beta

PUT /_ml/calendars/{calendar_id}/jobs/{job_id}

Operation is now beta

PUT /_ml/data_frame/analytics/{id}

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - query property Modified

PUT /_ml/datafeeds/{datafeed_id}

Operation is now beta

PUT /_ml/filters/{filter_id}

Operation is now beta

PUT /_ml/trained_models/{model_id}

Operation is now beta

PUT /_ml/trained_models/{model_id}/definition/{part}

Operation is now beta

PUT /_ml/trained_models/{model_id}/model_aliases/{model_alias}

Operation is now beta

PUT /_ml/trained_models/{model_id}/vocabulary

Operation is now beta

PUT /_query_rules/{ruleset_id}

Operation is now beta

PUT /_query_rules/{ruleset_id}/_rule/{rule_id}

Operation is now beta

PUT /_scripts/{id}

Operation is now beta

PUT /_scripts/{id}/{context}

Operation is now beta

PUT /_security/api_key

Operation is now beta

PUT /_security/api_key/{id}

Operation is now beta

PUT /_settings

Operation is now beta

PUT /_synonyms/{id}

Operation is now beta

PUT /_synonyms/{set_id}/{rule_id}

Operation is now beta

PUT /_template/{name}

Operation is now beta

PUT /_transform/{transform_id}

Operation is now beta
Body
application/json content type Modified
- source property Modified
  - query property Modified
    - bool, boosting, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, wildcard, wrapper, type properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - common, text_expansion, weighted_tokens properties Removed

PUT /{index}

Operation is now beta

PUT /{index}/_alias/{name}

Operation is now beta

PUT /{index}/_aliases/{name}

Operation is now beta

PUT /{index}/_block/{block}

Operation is now beta

PUT /{index}/_bulk

Operation is now beta

PUT /{index}/_create/{id}

Operation is now beta

PUT /{index}/_doc/{id}

Operation is now beta

PUT /{index}/_mapping

Operation is now beta

PUT /{index}/_settings

Operation is now beta

Sep 10, 2024

Change #62ce10b8

Breaking

Compare

111 structure changes including:

111 Modifications

Modified 111 Breaking

GET /_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:PhoneticTokenFilter alternative Modified
    - languageset, name_type, rule_type properties Modified

GET /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_async_search/status/{id}

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_async_search/{id}

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters property Modified

GET /_cat/indices

Response
200 response Modified
- application/json content type Modified
  - dataset.size property Added

GET /_cat/indices/{index}

Response
200 response Modified
- application/json content type Modified
  - dataset.size property Added

GET /_component_template

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_component_template/{name}

Response
200 response Modified
- application/json content type Modified
  - component_templates property Modified
    - component_template property Modified

GET /_data_stream

Query
verbose query parameter Added

GET /_data_stream/{name}

Query
verbose query parameter Added

GET /_enrich/_stats

Response
200 response Modified
- application/json content type Modified
  - cache_stats property Modified
    - hits_time_in_millis, misses_time_in_millis, size_in_bytes properties Added

GET /_eql/search/{id}

Response
200 response Modified
- application/json content type Modified
  - took property Modified

GET /_field_caps

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

GET /_index_template

Response
200 response Modified
- application/json content type Modified
  - index_templates property Modified
    - index_template property Modified

GET /_index_template/{name}

Response
200 response Modified
- application/json content type Modified
  - index_templates property Modified
    - index_template property Modified

GET /_info/{target}

Response
200 response Modified
- application/json content type Modified
  - ingest property Modified
    - pipelines, total properties Modified

GET /_ingest/pipeline

Response
200 response Modified
- application/json content type Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added

GET /_ingest/pipeline/_simulate

Body
application/json content type Modified
- docs property Modified
  - Property is now required
    Breaking
- pipeline property Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - processor_results property Modified
    - tag, processor_type, status properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - error property Added

GET /_ingest/pipeline/{id}

Response
200 response Modified
- application/json content type Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added

GET /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- docs property Modified
  - Property is now required
    Breaking
- pipeline property Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - processor_results property Modified
    - tag, processor_type, status properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - error property Added

GET /_mapping

Response
200 response Modified
- application/json content type Modified
  - item property Modified
    - runtime property Modified
  - mappings property Modified
    - runtime property Modified

GET /_ml/anomaly_detectors

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config, datafeed_config properties Modified

GET /_ml/anomaly_detectors/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - analysis_config, datafeed_config properties Modified

GET /_ml/data_frame/analytics

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

GET /_ml/data_frame/analytics/{id}

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

GET /_ml/datafeeds

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - runtime_mappings property Modified

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - runtime_mappings property Modified
    - fields property Added
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

GET /_ml/datafeeds/{datafeed_id}

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - runtime_mappings property Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - runtime_mappings property Modified
    - fields property Added
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

GET /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - runtime_mappings property Modified
    - fields property Added

GET /_resolve/index/{name}

Query
ignore_unavailable, allow_no_indices query parameters Added

GET /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified

GET /_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
- rank property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_search/template

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - mappings property Modified
    - runtime property Modified

GET /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - mappings property Modified
    - runtime property Modified

GET /_sql

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

GET /_transform

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/_preview

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - mappings property Modified

GET /_transform/{transform_id}

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/{transform_id}/_preview

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - mappings property Modified

GET /{index}

Response
200 response Modified
- application/json content type Modified
  - mappings property Modified
    - runtime property Modified

GET /{index}/_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:PhoneticTokenFilter alternative Modified
    - languageset, name_type, rule_type properties Modified

GET /{index}/_eql/search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - took property Modified

GET /{index}/_field_caps

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

GET /{index}/_mapping

Response
200 response Modified
- application/json content type Modified
  - item property Modified
    - runtime property Modified
  - mappings property Modified
    - runtime property Modified

GET /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - runtime_mappings property Modified
    - fields property Added

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

GET /{index}/_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
- rank property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - mappings property Modified
    - runtime property Modified

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - mappings property Modified
    - runtime property Modified

POST /_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:PhoneticTokenFilter alternative Modified
    - languageset, name_type, rule_type properties Modified

POST /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /_async_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters property Modified

POST /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified

POST /_field_caps

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

POST /_index_template/_simulate

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - mappings property Modified

POST /_index_template/_simulate/{name}

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified
Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - mappings property Modified

POST /_index_template/_simulate_index/{name}

Response
200 response Modified
- application/json content type Modified
  - template property Modified
    - mappings property Modified

POST /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified

POST /_ingest/pipeline/_simulate

Body
application/json content type Modified
- docs property Modified
  - Property is now required
    Breaking
- pipeline property Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - processor_results property Modified
    - tag, processor_type, status properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - error property Added

POST /_ingest/pipeline/{id}/_simulate

Body
application/json content type Modified
- docs property Modified
  - Property is now required
    Breaking
- pipeline property Modified
  - on_failure property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - processors property Modified
    - append, user_agent properties Modified
    - dot_expander, geoip properties Modified
    - geo_grid, html_strip, redact, uri_parts properties Added
  - deprecated property Added
Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - processor_results property Modified
    - tag, processor_type, status properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - error property Added

POST /_ml/anomaly_detectors/_estimate_model_memory

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified

POST /_ml/anomaly_detectors/{job_id}/_update

Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

POST /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/data_frame/analytics/{id}/_update

Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - runtime_mappings property Modified

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - runtime_mappings property Modified
    - fields property Added
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

POST /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - runtime_mappings property Modified
    - fields property Added
- job_config property Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

POST /_ml/datafeeds/{datafeed_id}/_update

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - runtime_mappings property Modified
    - fields property Added

POST /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - runtime_mappings property Modified
    - fields property Added

POST /_reindex

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - took property Modified

POST /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified

POST /_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
- rank property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /_search/template

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /_sql

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

POST /_template/{name}

Body
application/json content type Modified
- mappings property Modified
  - runtime property Modified
    - fields property Added

POST /_transform/_preview

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - mappings property Modified

POST /_transform/{transform_id}/_preview

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - mappings property Modified

POST /_transform/{transform_id}/_update

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - runtime_mappings property Modified

POST /{alias}/_rollover

Body
application/json content type Modified
- conditions property Modified
  - max_age_millis property Modified
- mappings property Modified
  - runtime property Modified
    - fields property Added

POST /{alias}/_rollover/{new_index}

Body
application/json content type Modified
- conditions property Modified
  - max_age_millis property Modified
- mappings property Modified
  - runtime property Modified
    - fields property Added

POST /{index}/_analyze

Body
application/json content type Modified
- filter property Modified
  - analysis:PhoneticTokenFilter alternative Modified
    - languageset, name_type, rule_type properties Modified

POST /{index}/_async_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - _clusters property Modified

POST /{index}/_delete_by_query

Response
200 response Modified
- application/json content type Modified
  - throttled_millis, throttled_until_millis, took properties Modified

POST /{index}/_eql/search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - took property Modified

POST /{index}/_field_caps

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

POST /{index}/_mapping

Body
application/json content type Modified
- runtime property Modified
  - fields property Added

POST /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - runtime_mappings property Modified
    - fields property Added

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added

POST /{index}/_pit

Response
200 response Modified
- application/json content type Modified
  - _shards property Added
Body
application/json content type Added

POST /{index}/_search

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
- rank property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - _clusters property Modified
    - details property Modified

POST /{index}/_update_by_query

Response
200 response Modified
- application/json content type Modified
  - took, throttled_millis, throttled_until_millis properties Modified

PUT /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - mappings property Modified
    - runtime property Modified

PUT /_ingest/pipeline/{id}

Body
application/json content type Modified
- on_failure property Modified
  - append property Modified
    - value property Modified
      - Combinator is now oneOf
  - dot_expander property Modified
    - override property Added
  - geoip property Modified
    - download_database_on_pipeline_creation property Added
  - user_agent property Modified
    - options property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - properties, extract_device_type properties Added
  - geo_grid, html_strip, redact, uri_parts properties Added
- processors property Modified
  - append property Modified
    - value property Modified
      - Combinator is now oneOf
  - dot_expander property Modified
    - override property Added
  - geoip property Modified
    - download_database_on_pipeline_creation property Added
  - user_agent property Modified
    - options property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - properties, extract_device_type properties Added
  - geo_grid, html_strip, redact, uri_parts properties Added
- deprecated property Added

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- analysis_config property Modified
  - categorization_analyzer property Modified
    - _types:CategorizationAnalyzerDefinition alternative Modified
- datafeed_config property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - analysis_config property Modified
    - categorization_analyzer property Modified
  - datafeed_config property Modified
    - runtime_mappings property Modified

PUT /_ml/data_frame/analytics/{id}

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - runtime_mappings property Modified

PUT /_ml/datafeeds/{datafeed_id}

Body
application/json content type Modified
- runtime_mappings property Modified
  - fields property Added
Response
200 response Modified
- application/json content type Modified
  - runtime_mappings property Modified
    - fields property Added

PUT /_template/{name}

Body
application/json content type Modified
- mappings property Modified
  - runtime property Modified
    - fields property Added

PUT /_transform/{transform_id}

Body
application/json content type Modified
- source property Modified
  - runtime_mappings property Modified
    - fields property Added

PUT /{index}

Body
application/json content type Modified
- mappings property Modified
  - runtime property Modified
    - fields property Added

PUT /{index}/_mapping

Body
application/json content type Modified
- runtime property Modified
  - fields property Added

Aug 23, 2024

Change #b7b8d4d2

Breaking

Compare

167 structure changes including:

1 Breaking change

166 Modifications

1 Removal

Modified 166 Breaking

DELETE /_connector/{connector_id}

Query
delete_sync_jobs query parameter Modified
- Query parameter is no longer required

DELETE /_data_stream/{name}

Query
master_timeout query parameter Added

GET /_alias

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified

GET /_alias/{name}

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified

GET /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_async_search/{id}

Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits 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 /_connector

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - configuration, features, filtering properties Modified
    - error, index_name properties Modified
      - Combinator is now oneOf
    - service_type property Modified
      - Property is no longer required
    - api_key_secret_id, sync_cursor properties Added

GET /_connector/_sync_job

Query
job_type query parameter Modified
- Full types went from array[string] to string | array[string]
Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - connector property Modified

GET /_connector/_sync_job/{connector_sync_job_id}

Response
200 response Modified
- application/json content type Modified
  - connector property Modified
    - configuration property Modified
    - sync_cursor property Added

GET /_connector/{connector_id}

Response
200 response Modified
- application/json content type Modified
  - configuration property Modified
    - default_value, options, type properties Modified
    - tooltip property Modified
      - Combinator is now oneOf
    - ui_restrictions, validations properties Modified
      - Properties are no longer required
    - value property Modified
      - Removing polymorphism is always breaking
        Breaking
  - error property Modified
    - Combinator is now oneOf
    - string alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - string-1, string-2 alternatives Added
  - features property Modified
    - filtering_advanced_config, filtering_rules properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - native_connector_api_keys property Added
  - filtering property Modified
    - domain property Modified
      - Property is no longer required
  - index_name property Modified
    - Combinator is now oneOf
    - string-2 alternative Added
  - service_type property Modified
    - Property is no longer required
  - api_key_secret_id, sync_cursor properties Added

GET /_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

GET /_data_stream

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - indices, lifecycle properties Modified
    - failure_store, rollover_on_write properties Added
Query
master_timeout query parameter Added

GET /_data_stream/_stats

Response
200 response Modified
- application/json content type Modified
  - total_store_sizes property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added

GET /_data_stream/{name}

Response
200 response Modified
- application/json content type Modified
  - data_streams property Modified
    - indices, lifecycle properties Modified
    - failure_store, rollover_on_write properties Added
Query
master_timeout query parameter Added

GET /_data_stream/{name}/_lifecycle

Query
master_timeout query parameter Added

GET /_data_stream/{name}/_stats

Response
200 response Modified
- application/json content type Modified
  - total_store_sizes property Modified
    - _types:ByteSize, _types:ByteSize alternatives 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
  - knn property Modified
    - k property Added

GET /_index_template

Response
200 response Modified
- application/json content type Modified
  - index_templates property Modified
    - index_template property Modified

GET /_index_template/{name}

Response
200 response Modified
- application/json content type Modified
  - index_templates property Modified
    - index_template property Modified

GET /_mget

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - get:GetResult alternative Modified

GET /_ml/anomaly_detectors

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - datafeed_config property Modified

GET /_ml/anomaly_detectors/{job_id}

Response
200 response Modified
- application/json content type Modified
  - jobs property Modified
    - datafeed_config property Modified

GET /_ml/data_frame/analytics

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

GET /_ml/data_frame/analytics/{id}

Response
200 response Modified
- application/json content type Modified
  - data_frame_analytics property Modified
    - source property Modified

GET /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

GET /_ml/datafeeds

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - query property Modified

GET /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query property Modified

GET /_ml/datafeeds/{datafeed_id}

Response
200 response Modified
- application/json content type Modified
  - datafeeds property Modified
    - query property Modified

GET /_ml/datafeeds/{datafeed_id}/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn property Modified
- job_config property Modified
  - datafeed_config property Modified
    - query property Modified

GET /_ml/trained_models/_stats

Response
200 response Modified
- application/json content type Modified
  - trained_model_stats property Modified
    - deployment_stats, inference_stats, model_size_stats properties Modified

GET /_ml/trained_models/{model_id}/_stats

Response
200 response Modified
- application/json content type Modified
  - trained_model_stats property Modified
    - deployment_stats, inference_stats, model_size_stats properties Modified

GET /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn property Modified
  - knn property Modified
    - _types:KnnSearch alternative Modified
    - array-2 alternative Modified
  - post_filter property Modified
    - knn property Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified
Query
include_named_queries_score query parameter Added

GET /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative 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
    - knn property Modified

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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k 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
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
Query
include_named_queries_score query parameter Added

GET /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /_security/_authenticate

Response
200 response Modified
- application/json content type Modified
  - api_key property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/_query/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_security/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

GET /_settings

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

GET /_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

GET /_sql

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added

GET /_sql/translate

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn property Modified

GET /_transform

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/_preview

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, settings, defaults properties Modified

GET /_transform/{transform_id}

Response
200 response Modified
- application/json content type Modified
  - transforms property Modified
    - source property Modified

GET /_transform/{transform_id}/_preview

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
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
  - knn property Modified
    - k property Added

GET /{index}

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

GET /{index}/_alias

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified

GET /{index}/_alias/{name}

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified

GET /{index}/_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

GET /{index}/_doc/{id}

Response
200 response Modified
- application/json content type Modified
  - _ignored property Added

GET /{index}/_eql/search

Body
application/json content type Modified
- filter property Modified
  - query_dsl:QueryContainer alternative Modified
    - knn property Modified
  - array-2 alternative Modified
    - knn property Modified

GET /{index}/_explain/{id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

GET /{index}/_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - k property Added

GET /{index}/_graph/explore

Body
application/json content type Modified
- connections property Modified
  - query property Modified
    - knn property Modified
- query property Modified
  - knn property Modified
    - k property Added

GET /{index}/_lifecycle/explain

Response
200 response Modified
- application/json content type Modified
  - indices property Modified
    - lifecycle property Modified

GET /{index}/_mget

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - get:GetResult alternative Modified

GET /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn property Modified
  - knn property Modified
    - _types:KnnSearch alternative Modified
    - array-2 alternative Modified
  - post_filter property Modified
    - knn property Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified
Query
include_named_queries_score query parameter Added

GET /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

GET /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

GET /{index}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k 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
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
Query
include_named_queries_score query parameter Added

GET /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

GET /{index}/_settings

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

GET /{index}/_settings/{name}

Response
200 response Modified
- application/json content type Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

GET /{index}/_terms_enum

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - k property Added

GET /{index}/_validate/query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /_aliases

Body
application/json content type Modified
- actions property Modified
  - add property Modified
    - filter property Modified

POST /_application/search_application/{name}/_search

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits 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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k property Added
- rescore property Modified
  - _types:Rescore alternative Modified
    - query property Modified
  - array-2 alternative Modified
    - query property Modified
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits property Modified

POST /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

POST /_connector

Body
application/json content type Modified
- index_name property Modified
  - Removing polymorphism is always breaking
    Breaking
Response
200 response Modified
- application/json content type Modified
  - result property Added

POST /_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /_data_stream/_migrate/{name}

Query
master_timeout, timeout query parameters Added

POST /_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - k property Added

POST /_index_template/_simulate

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
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
    - filter property Modified
  - settings property Modified
    - translog property Modified
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
    - filter property Modified
  - settings property Modified
    - translog property Modified

POST /_mget

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - get:GetResult alternative Modified

POST /_ml/anomaly_detectors/{job_id}/_update

Response
200 response Modified
- application/json content type Modified
  - datafeed_config property Modified
    - query property Modified

POST /_ml/data_frame/_evaluate

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /_ml/data_frame/analytics/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

POST /_ml/data_frame/analytics/{id}/_preview

Body
application/json content type Modified
- config property Modified
  - source property Modified
    - query property Modified

POST /_ml/data_frame/analytics/{id}/_update

Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - query property Modified

POST /_ml/datafeeds/_preview

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn property Modified
- 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
    - knn property Modified
- 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
  - knn property Modified
    - k property Added
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn property Modified

POST /_ml/trained_models/{model_id}/_infer

Response
200 response Modified
- application/json content type Modified
  - inference_results property Modified
    - predicted_value property Modified

POST /_ml/trained_models/{model_id}/deployment/_infer

Response
200 response Modified
- application/json content type Modified
  - inference_results property Modified
    - predicted_value property Modified

POST /_ml/trained_models/{model_id}/deployment/_start

Response
200 response Modified
- application/json content type Modified
  - assignment property Modified
    - task_parameters property Modified

POST /_ml/trained_models/{model_id}/deployment/_update

Response
200 response Modified
- application/json content type Modified
  - assignment property Modified
    - task_parameters property Modified

POST /_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn property Modified
  - knn property Modified
    - _types:KnnSearch alternative Modified
    - array-2 alternative Modified
  - post_filter property Modified
    - knn property Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified
Query
include_named_queries_score query parameter Added

POST /_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /_query

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added
- tables 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
    - knn property Modified

POST /_scripts/painless/_execute

Body
application/json content type Modified
- context_setup property Modified
  - query property Modified
    - knn property Modified

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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k 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
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
Query
include_named_queries_score query parameter Added

POST /_search/scroll

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_search/scroll/{scroll_id}

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /_security/_query/api_key

Response
200 response Modified
- application/json content type Modified
  - api_keys property Modified
    - role_descriptors, limited_by properties Modified

POST /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - indices property Modified
    - query property Modified

POST /_sql

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added

POST /_sql/translate

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn property Modified

POST /_template/{name}

Body
application/json content type Modified
- aliases property Modified
  - filter property Modified
    - knn property Modified
- settings property Modified
  - translog property Modified
    - flush_threshold_size, retention properties Modified

POST /_transform/_preview

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, settings, defaults properties Modified

POST /_transform/{transform_id}/_preview

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
Response
200 response Modified
- application/json content type Modified
  - generated_dest_index property Modified
    - aliases, settings, defaults properties Modified

POST /_transform/{transform_id}/_update

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
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
  - knn property Modified
    - k property Added

POST /{alias}/_rollover

Body
application/json content type Modified
- aliases property Modified
  - filter property Modified
    - knn property Modified
- conditions property Modified
  - max_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - min_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - max_primary_shard_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - min_primary_shard_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added

POST /{alias}/_rollover/{new_index}

Body
application/json content type Modified
- aliases property Modified
  - filter property Modified
    - knn property Modified
- conditions property Modified
  - max_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - min_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - max_primary_shard_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - min_primary_shard_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added

POST /{index}/_alias/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added

POST /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k 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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k property Added
- rescore property Modified
  - _types:Rescore alternative Modified
    - query property Modified
  - array-2 alternative Modified
    - query property Modified
Response
200 response Modified
- application/json content type Modified
  - response property Modified
    - hits property Modified

POST /{index}/_count

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /{index}/_delete_by_query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /{index}/_eql/search

Body
application/json content type Modified
- filter property Modified
  - query_dsl:QueryContainer alternative Modified
    - knn property Modified
  - array-2 alternative Modified
    - knn property Modified

POST /{index}/_explain/{id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /{index}/_field_caps

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - k property Added

POST /{index}/_graph/explore

Body
application/json content type Modified
- connections property Modified
  - query property Modified
    - knn property Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /{index}/_mget

Response
200 response Modified
- application/json content type Modified
  - docs property Modified
    - get:GetResult alternative Modified

POST /{index}/_msearch

Body
application/json content type Modified
- msearch:MultisearchBody alternative Modified
  - query property Modified
    - knn property Modified
  - knn property Modified
    - _types:KnnSearch alternative Modified
    - array-2 alternative Modified
  - post_filter property Modified
    - knn property Modified
  - rescore property Modified
    - _types:Rescore, array-2 alternatives Modified
Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified
Query
include_named_queries_score query parameter Added

POST /{index}/_msearch/template

Response
200 response Modified
- application/json content type Modified
  - responses property Modified
    - msearch:MultiSearchItem alternative Modified

POST /{index}/_mvt/{field}/{zoom}/{x}/{y}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

POST /{index}/_rank_eval

Body
application/json content type Modified
- requests property Modified
  - request property Modified
    - query property Modified

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
  - knn property Modified
    - k property Added
- query property Modified
  - knn property Modified
    - k 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
Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified
Query
include_named_queries_score query parameter Added

POST /{index}/_search/template

Response
200 response Modified
- application/json content type Modified
  - hits property Modified
    - hits property Modified

POST /{index}/_terms_enum

Body
application/json content type Modified
- index_filter property Modified
  - knn property Modified
    - k property Added

POST /{index}/_update_by_query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added
Query
q query parameter Added

POST /{index}/_validate/query

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added

PUT /_component_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified
  - defaults property Modified
    - translog property Modified

PUT /_connector

Body
application/json content type Modified
- index_name property Modified
  - Removing polymorphism is always breaking
    Breaking
Response
200 response Modified
- application/json content type Modified
  - id property Added

PUT /_connector/{connector_id}

Body
application/json content type Modified
- index_name property Modified
  - Removing polymorphism is always breaking
    Breaking
Response
200 response Modified
- application/json content type Modified
  - id property Added

PUT /_connector/{connector_id}/_api_key_id

Body
application/json content type Modified
- api_key_id, api_key_secret_id properties Modified
  - Removing polymorphism is always breaking
    Breaking

PUT /_connector/{connector_id}/_configuration

Body
application/json content type Modified
- configuration property Modified
  - default_value property Modified
    - _types:ScalarValue, _types:ScalarValue, _types:ScalarValue, _types:ScalarValue, _types:ScalarValue alternatives Added
  - options property Modified
    - value property Modified
  - tooltip property Modified
    - Combinator is now oneOf
    - string alternative Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - string-1, string-2 alternatives Added
  - type property Modified
  - ui_restrictions, validations properties Modified
    - Properties are no longer required
  - value property Modified
    - Removing polymorphism is always breaking
      Breaking

PUT /_connector/{connector_id}/_filtering

Body
application/json content type Modified
- filtering property Modified
  - domain property Modified
    - Property is no longer required

PUT /_connector/{connector_id}/_name

Body
application/json content type Modified
- name property Modified
  - Property is no longer required

PUT /_data_stream/{name}

Query
master_timeout, timeout query parameters Added

PUT /_enrich/policy/{name}

Body
application/json content type Modified
- geo_match property Modified
  - query property Modified
    - knn property Modified
- match property Modified
  - query property Modified
    - knn property Modified
- range property Modified
  - query property Modified
    - knn property Modified

PUT /_index_template/{name}

Body
application/json content type Modified
- template property Modified
  - aliases property Modified
    - filter property Modified
  - settings property Modified
    - translog property Modified

PUT /_ml/anomaly_detectors/{job_id}

Body
application/json content type Modified
- datafeed_config property Modified
  - query property Modified
    - knn property Modified
Response
200 response Modified
- application/json content type Modified
  - datafeed_config property Modified
    - query property Modified

PUT /_ml/data_frame/analytics/{id}

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified
Response
200 response Modified
- application/json content type Modified
  - source property Modified
    - query property Modified

PUT /_ml/datafeeds/{datafeed_id}

Body
application/json content type Modified
- query property Modified
  - knn property Modified
    - k property Added
Response
200 response Modified
- application/json content type Modified
  - query property Modified
    - knn property Modified

PUT /_ml/trained_models/{model_id}

Response
200 response Modified
- application/json content type Modified
  - model_size_bytes property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added

PUT /_security/api_key

Body
application/json content type Modified
- role_descriptors property Modified
  - indices property Modified
    - query property Modified

PUT /_security/api_key/{id}

Body
application/json content type Modified
- role_descriptors property Modified
  - indices property Modified
    - query property Modified

PUT /_settings

Body
application/json content type Modified
- translog property Modified
  - flush_threshold_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - retention property Modified
    - size property Modified

PUT /_synonyms/{id}

Body
application/json content type Modified
- synonyms_set property Modified
  - Combinator is now oneOf
  - array alternative Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - _types:SynonymRule alternative Added
  - array-2 alternative Added

PUT /_template/{name}

Body
application/json content type Modified
- aliases property Modified
  - filter property Modified
    - knn property Modified
- settings property Modified
  - translog property Modified
    - flush_threshold_size, retention properties Modified

PUT /_transform/{transform_id}

Body
application/json content type Modified
- source property Modified
  - query property Modified
    - knn property Modified

PUT /{index}

Body
application/json content type Modified
- aliases property Modified
  - filter property Modified
    - knn property Modified
- settings property Modified
  - translog property Modified
    - flush_threshold_size, retention properties Modified

PUT /{index}/_alias/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added

PUT /{index}/_aliases/{name}

Body
application/json content type Modified
- filter property Modified
  - knn property Modified
    - k property Added

PUT /{index}/_settings

Body
application/json content type Modified
- translog property Modified
  - flush_threshold_size property Modified
    - _types:ByteSize, _types:ByteSize alternatives Added
  - retention property Modified
    - size property Modified

Removed 1 Breaking

PUT /_connector/{connector_id}/_last_sync

Removing a resource is always breaking unless it was deprecated before
Breaking

Jul 18, 2024

Change #dc9d47a3

Compare

Do not miss any Elasticsearch Serverless API changes, ever again

Changelog

Elasticsearch Serverless API structure has changed

API structure has changed

API structure has changed

Elasticsearch Serverless API documentation update

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created