Change Updates

Do not miss any Elasticsearch API changes, ever again

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

RSS

Dec 20, 2024

v8
Compare

API structure has changed

75 structure changes including:
11 Additions
64 Modifications
Modified 64 Breaking
GET /_ml/datafeeds/{datafeed_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • datafeeds property Modified
        • timing_stats property Modified
          • Property is no longer required
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
GET /_ml/datafeeds/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • datafeeds property Modified
        • timing_stats property Modified
          • Property is no longer required
GET /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
GET /_ml/data_frame/analytics/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_frame_analytics property Modified
        • _meta property Added
GET /_ml/data_frame/analytics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_frame_analytics property Modified
        • _meta property Added
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshot_upgrades property Modified
        • node property Modified
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • analysis_limits property Modified
GET /_ml/anomaly_detectors/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_size_stats property Modified
GET /_ml/anomaly_detectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • analysis_limits property Modified
GET /_ingest/geoip/database/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • databases property Modified
        • database property Modified
          • Property is no longer required
GET /_ingest/geoip/database
  • Response
  • 200 response Modified
    • application/json content type Modified
      • databases property Modified
        • database property Modified
          • Property is no longer required
GET /_cat/thread_pool/{thread_pool_patterns}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/thread_pool
  • Query
  • local, master_timeout query parameters Added
GET /_cat/templates/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
PUT /_ml/trained_models/{model_id}
  • Body
  • application/json content type Modified
    • inference_config property Modified
      • text_classification property Modified
        • tokenization property Modified
      • zero_shot_classification property Modified
        • tokenization property Modified
      • fill_mask property Modified
        • tokenization property Modified
        • vocabulary property Added
      • ner property Modified
        • tokenization property Modified
      • pass_through property Modified
        • tokenization property Modified
      • text_embedding property Modified
        • tokenization property Modified
        • vocabulary property Added
      • text_expansion property Modified
        • tokenization property Modified
        • vocabulary property Added
      • question_answering property Modified
        • tokenization property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • inference_config property Modified
        • text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering properties Modified
      • model_package property Added
PUT /_ml/data_frame/analytics/{id}
  • Body
  • application/json content type Modified
    • _meta property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Added
PUT /_ml/anomaly_detectors/{job_id}
  • Body
  • application/json content type Modified
    • analysis_limits property Modified
      • model_memory_limit property Modified
        • Combinator is now oneOf
        • model_memory_limit alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:ByteSize, _types:ByteSize alternatives Added
    • job_id property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
  • Query
  • allow_no_indices, expand_wildcards, ignore_throttled, ignore_unavailable query parameters Added
POST /_ml/trained_models/{model_id}/deployment/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assignment property Modified
        • routing_table, task_parameters properties Modified
        • adaptive_allocations, reason properties Added
POST /_ml/trained_models/{model_id}/deployment/_start
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assignment property Modified
        • routing_table, task_parameters properties Modified
        • adaptive_allocations, reason properties Added
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/datafeeds/_preview
  • Body
  • application/json content type Modified
    • job_config property Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_snapshots property Modified
        • model_size_stats property Modified
POST /_ml/anomaly_detectors/{job_id}/_update
  • Body
  • application/json content type Modified
    • detectors property Modified
      • detector_index property Modified
        • Property is now required
          Breaking
      • by_field_name, detector_description, exclude_frequent, field_name, function, over_field_name, partition_field_name, use_null properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • analysis_limits property Modified
        • model_memory_limit property Modified
          • Combinator is now oneOf
POST /_ml/anomaly_detectors/{job_id}/_data
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _types:UnitMillis property Modified
        • Name is no longer earliest_record_timestamp
        • Property is no longer required
      • _types:UnitMillis property Modified
        • Name is no longer latest_record_timestamp
        • Property is no longer required
      • _types:UnitMillis property Modified
        • Name is no longer last_data_time
        • Property is no longer required
      • _types:UnitMillis, _types:UnitMillis, _types:UnitMillis properties Added
POST /_ml/anomaly_detectors/_validate
  • Body
  • application/json content type Modified
    • analysis_limits property Modified
      • model_memory_limit property Modified
        • Combinator is now oneOf
        • model_memory_limit alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • _types:ByteSize, _types:ByteSize alternatives Added
GET /_ml/trained_models/{model_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models/{model_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • model_package property Added
  • Query
  • include_model_definition query parameter Added
GET /_ml/trained_models/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_stats property Modified
        • deployment_stats property Modified
GET /_ml/trained_models
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trained_model_configs property Modified
        • inference_config property Modified
        • model_package property Added
  • Query
  • include_model_definition query parameter Added
GET /_ml/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • limits property Modified
        • max_model_memory_limit, effective_max_model_memory_limit, total_ml_memory properties Modified
          • Combinator is now oneOf
        • max_single_ml_node_processors, total_ml_processors properties Added
GET /_cat/aliases
  • Query
  • local, master_timeout query parameters Added
GET /_cat/aliases/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/allocation
  • Query
  • local, master_timeout query parameters Added
GET /_cat/allocation/{node_id}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/component_templates
  • Query
  • local, master_timeout query parameters Added
GET /_cat/component_templates/{name}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/indices
  • Query
  • master_timeout query parameter Added
GET /_cat/indices/{index}
  • Query
  • master_timeout query parameter Added
GET /_cat/master
  • Query
  • local, master_timeout query parameters Added
GET /_cat/ml/trained_models
  • Query
  • time query parameter Added
GET /_cat/ml/trained_models/{model_id}
  • Query
  • time query parameter Added
GET /_cat/nodeattrs
  • Query
  • local, master_timeout query parameters Added
GET /_cat/templates
  • Query
  • local, master_timeout query parameters Added
GET /_cat/tasks
  • Query
  • node_id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • nodes, time, timeout, wait_for_completion query parameters Added
GET /_cat/snapshots/{repository}
  • Query
  • master_timeout, time query parameters Added
GET /_cat/snapshots
  • Query
  • master_timeout, time query parameters Added
GET /_cat/shards/{index}
  • Query
  • master_timeout, time query parameters Added
GET /_cat/shards
  • Query
  • master_timeout, time query parameters Added
GET /_cat/segments/{index}
  • Query
  • local, master_timeout query parameters Added
GET /_cat/segments
  • Query
  • local, master_timeout query parameters Added
GET /_cat/repositories
  • Query
  • local, master_timeout query parameters Added
GET /_cat/recovery/{index}
  • Query
  • time query parameter Added
GET /_cat/recovery
  • Query
  • time query parameter Added
GET /_cat/plugins
  • Query
  • include_bootstrap, local, master_timeout query parameters Added
GET /_cat/pending_tasks
  • Query
  • local, master_timeout, time query parameters Added
GET /_cat/nodes
  • Query
  • master_timeout, time query parameters Added
Added 11
DELETE /_ingest/ip_location/database/{id}
GET /_ingest/ip_location/database
GET /_ingest/ip_location/database/{id}
GET /_text_structure/find_field_structure
GET /_text_structure/find_message_structure
POST /_text_structure/find_message_structure
PUT /_connector/_sync_job/{connector_sync_job_id}/_check_in
PUT /_connector/_sync_job/{connector_sync_job_id}/_claim
PUT /_connector/_sync_job/{connector_sync_job_id}/_error
PUT /_connector/{connector_id}/_features
PUT /_ingest/ip_location/database/{id}