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

8 days ago

main
Compare

API structure has changed

Next Change
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