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

10 days ago

main
Compare

API structure has changed

Next Change
111 structure changes including:
8 Breaking changes
23 Additions
82 Modifications
6 Removals
Modified 82 Breaking
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 /_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 /_cat/thread_pool/{thread_pool_patterns}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/thread_pool
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/templates/{name}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/templates
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/tasks
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/snapshots/{repository}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/snapshots
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/shards/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/shards
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/segments/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/segments
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/repositories
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/recovery/{index}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/recovery
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/plugins
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/pending_tasks
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/nodes
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/nodeattrs
  • 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 /_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
POST /_query
  • Query
  • allow_partial_results query parameter Added
POST /_nodes/{node_id}/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Added
POST /_nodes/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Added
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
POST /_index_template/_simulate_index/{name}
  • Query
  • create, cause query parameters Added
POST /_index_template/_simulate/{name}
  • Query
  • cause query parameter Added
POST /_index_template/_simulate
  • Query
  • cause query parameter Added
POST /_cache/clear
  • Query
  • index query parameter Added
POST /_analyze
  • Query
  • index query parameter Added
HEAD /_index_template/{name}
  • Query
  • local, flat_settings query parameters 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
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}/_reload_search_analyzers
  • Query
  • resource query parameter Added
GET /{index}/_mapping
  • Query
  • local query parameter Modified
    • Query parameter is now deprecated
GET /{index}/_field_usage_stats
  • Query
  • wait_for_active_shards query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /{index}/_analyze
  • Query
  • index query parameter Added
GET /_security/role_mapping/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • rules property Modified
GET /_security/role_mapping
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • rules property Modified
GET /_mapping
  • Query
  • local query parameter Modified
    • Query parameter is now deprecated
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • index_template_subtitutions property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • index_template_substitutions property Added
GET /_cat/aliases
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_analyze
  • Query
  • index query parameter Added
POST /_query/async
  • Body
  • application/json content type Modified
    • wait_for_completion_timeout property Added
  • Query
  • allow_partial_results query parameter Added
POST /_security/oidc/logout
  • Body
  • application/json content type Modified
    • access_token property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
POST /_security/role_mapping/{name}
  • Body
  • application/json content type Modified
    • rules property Modified
      • field property Modified
        • username, dn, groups properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
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}/_cache/clear
  • 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}/_reload_search_analyzers
  • Query
  • resource query parameter 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}/_update
  • Verb went from POST to PUT (same operationId)
    Breaking
PUT /_inference/{task_type}/{inference_id}/_update
  • Verb went from POST to PUT (same operationId)
    Breaking
PUT /_security/role_mapping/{name}
  • Body
  • application/json content type Modified
    • rules property Modified
      • field property Modified
        • username, dn, groups properties 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/ml/datafeeds/{datafeed_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/datafeeds
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/data_frame/analytics/{id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/data_frame/analytics
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/ml/anomaly_detectors
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/master
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
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/indices
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/health
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/fielddata/{fields}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/fielddata
  • 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/count
  • 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/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/allocation/{node_id}
  • Response
  • 200 response Modified
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /_cat/allocation
  • 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
Removed 6 Breaking
POST /_inference/{inference_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /_inference/{inference_id}/_stream
  • 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}/_stream
  • 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
Added 23
POST /_inference/chat_completion/{eis_inference_id}/_stream
POST /_inference/chat_completion/{inference_id}/_stream
POST /_inference/completion/{inference_id}
POST /_inference/completion/{inference_id}/_stream
POST /_inference/rerank/{inference_id}
POST /_inference/sparse_embedding/{inference_id}
POST /_inference/text_embedding/{inference_id}
PUT /_inference/{task_type}/{alibabacloud_inference_id}
PUT /_inference/{task_type}/{amazonbedrock_inference_id}
PUT /_inference/{task_type}/{anthropic_inference_id}
PUT /_inference/{task_type}/{azureaistudio_inference_id}
PUT /_inference/{task_type}/{azureopenai_inference_id}
PUT /_inference/{task_type}/{cohere_inference_id}
PUT /_inference/{task_type}/{eis_inference_id}
PUT /_inference/{task_type}/{elasticsearch_inference_id}
PUT /_inference/{task_type}/{elser_inference_id}
PUT /_inference/{task_type}/{googleaistudio_inference_id}
PUT /_inference/{task_type}/{googlevertexai_inference_id}
PUT /_inference/{task_type}/{huggingface_inference_id}
PUT /_inference/{task_type}/{jinaai_inference_id}
PUT /_inference/{task_type}/{mistral_inference_id}
PUT /_inference/{task_type}/{openai_inference_id}
PUT /_inference/{task_type}/{voyageai_inference_id}