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

23 days ago

main
Compare

API structure has changed

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}