Change Updates

Do not miss any Elasticsearch Serverless API changes, ever again

Subscribe to the Elasticsearch Serverless API changelog to be up to date on recent changes.

RSS

Mar 11, 2025

main
Compare

API structure has changed

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