Change Updates

Do not miss any Elastic APIs Hub changes, ever again

Subscribe to the Elastic APIs Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
1 structure change including:
1 Addition
Added 1
POST /api/observability_ai_assistant/chat/complete
Elastic Cloud Serverless API
12 structure changes including:
12 Modifications
Modified 12
GET /api/v1/serverless/projects/elasticsearch
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • traffic_filters property Added
  • Query
  • traffic_filter query parameter Added
GET /api/v1/serverless/projects/elasticsearch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
GET /api/v1/serverless/projects/observability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • traffic_filters property Added
  • Query
  • traffic_filter query parameter Added
GET /api/v1/serverless/projects/observability/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
GET /api/v1/serverless/projects/security
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • traffic_filters property Added
  • Query
  • traffic_filter query parameter Added
GET /api/v1/serverless/projects/security/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
PATCH /api/v1/serverless/projects/elasticsearch/{id}
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
PATCH /api/v1/serverless/projects/observability/{id}
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
PATCH /api/v1/serverless/projects/security/{id}
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • traffic_filters property Added
POST /api/v1/serverless/projects/elasticsearch
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • traffic_filters property Added
POST /api/v1/serverless/projects/observability
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • traffic_filters property Added
POST /api/v1/serverless/projects/security
  • Body
  • application/json content type Modified
    • traffic_filters property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • traffic_filters property Added
Elasticsearch API

This update aligns with the Elasticsearch 8.18.3 release. Check out the release notes.

It also includes clarifications about the availability of each API.

796 structure changes including:
796 Modifications
Modified 796 Breaking
DELETE /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
DELETE /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
DELETE /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
DELETE /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
DELETE /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_cluster/voting_config_exclusions
  • Operation is no longer Added in 7.0.0
  • Operation is now Generally available; Added in 7.0.0
DELETE /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
DELETE /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
DELETE /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
DELETE /_dangling/{index_uuid}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
DELETE /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
DELETE /_index_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
DELETE /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
DELETE /_license
  • Operation is now Generally available
DELETE /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
DELETE /_ml/_delete_expired_data
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/_delete_expired_data/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/anomaly_detectors/{job_id}/_forecast
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/calendars/{calendar_id}/events/{event_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
DELETE /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
DELETE /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
DELETE /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
DELETE /_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
DELETE /_query/async/{id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
DELETE /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
DELETE /_scripts/{id}
  • Operation is now Generally available
DELETE /_search/scroll
  • Operation is now Generally available
DELETE /_search/scroll/{scroll_id}
  • Operation is now Generally available
DELETE /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
DELETE /_security/oauth2/token
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_security/privilege/{application}/{name}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
DELETE /_security/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_security/role/{name}
  • Operation is now Generally available
DELETE /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_security/user/{username}
  • Operation is now Generally available
DELETE /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
DELETE /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
DELETE /_snapshot/{repository}/{snapshot}
  • Operation is now Generally available
DELETE /_sql/async/delete/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
DELETE /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_template/{name}
  • Operation is now Generally available
DELETE /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
DELETE /_watcher/watch/{id}
  • Operation is now Generally available
DELETE /{index}
  • Operation is now Generally available
DELETE /{index}/_alias/{name}
  • Operation is now Generally available
DELETE /{index}/_aliases/{name}
  • Operation is now Generally available
DELETE /{index}/_doc/{id}
  • Operation is now Generally available
GET /
  • Operation is now Generally available
GET /_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_analyze
  • Operation is now Generally available
GET /_application/analytics
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
GET /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
GET /_application/search_application
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_application/search_application/{name}/_search
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_async_search/status/{id}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_autoscaling/capacity
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_cat
  • Operation is now Generally available
GET /_cat/aliases
  • Operation is now Generally available
GET /_cat/aliases/{name}
  • Operation is now Generally available
GET /_cat/allocation
  • Operation is now Generally available
GET /_cat/allocation/{node_id}
  • Operation is now Generally available
GET /_cat/component_templates
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available; Added in 5.1.0
GET /_cat/component_templates/{name}
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available; Added in 5.1.0
GET /_cat/count
  • Operation is now Generally available
GET /_cat/count/{index}
  • Operation is now Generally available
GET /_cat/fielddata
  • Operation is now Generally available
GET /_cat/fielddata/{fields}
  • Operation is now Generally available
GET /_cat/health
  • Operation is now Generally available
GET /_cat/indices
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/indices/{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/master
  • Operation is now Generally available
GET /_cat/ml/anomaly_detectors
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/data_frame/analytics
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/datafeeds
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/trained_models
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available; Added in 8.0.0
GET /_cat/ml/trained_models/{model_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available; Added in 8.0.0
GET /_cat/nodeattrs
  • Operation is now Generally available
GET /_cat/nodes
  • Operation is now Generally available
GET /_cat/pending_tasks
  • Operation is now Generally available
GET /_cat/plugins
  • Operation is now Generally available
GET /_cat/recovery
  • Operation is now Generally available
GET /_cat/recovery/{index}
  • Operation is now Generally available
GET /_cat/repositories
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/segments
  • Operation is now Generally available
GET /_cat/segments/{index}
  • Operation is now Generally available
GET /_cat/shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/shards/{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/snapshots
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/snapshots/{repository}
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/tasks
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 5.0.0
GET /_cat/templates
  • Operation is no longer Added in 5.2.0
  • Operation is now Generally available; Added in 5.2.0
GET /_cat/templates/{name}
  • Operation is no longer Added in 5.2.0
  • Operation is now Generally available; Added in 5.2.0
GET /_cat/thread_pool
  • Operation is now Generally available
GET /_cat/thread_pool/{thread_pool_patterns}
  • Operation is now Generally available
GET /_cat/transforms
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/transforms/{transform_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_ccr/auto_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_ccr/stats
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_cluster/allocation/explain
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • note property Modified
        • Property is now Generally available; Added in 7.14.0
GET /_cluster/health
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/health/{index}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/pending_tasks
  • Operation is now Generally available
GET /_cluster/settings
  • Operation is now Generally available
GET /_cluster/state
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/state/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/state/{metric}/{index}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • indices property Modified
        • analysis, mappings properties Modified
      • nodes property Modified
        • count, os properties Modified
GET /_cluster/stats/nodes/{node_id}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • indices property Modified
        • analysis, mappings properties Modified
      • nodes property Modified
        • count, os properties Modified
GET /_component_template
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/_sync_job
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_count
  • Operation is now Generally available
GET /_dangling
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_data_stream
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available; Added in 7.10.0
GET /_data_stream/_stats
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available; Added in 7.10.0
GET /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_data_stream/{name}/_stats
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_enrich/_stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cache_stats property Modified
        • Property is now Generally available; Added in 7.16.0
GET /_enrich/policy
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_eql/search/status/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_features
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
GET /_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /_flush
  • Operation is now Generally available
GET /_health_report
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
GET /_health_report/{feature}
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
GET /_ilm/policy
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_ilm/status
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_index_template
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_inference
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_info/{target}
  • Operation is no longer Added in 8.9.0
  • Operation is now Generally available; Added in 8.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • http property Modified
        • routes property Modified
          • Property is no longer Added in 8.12.0
          • Property is now Generally available; Added in 8.12.0
      • ingest property Modified
        • pipelines property Modified
GET /_ingest/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/geoip/database
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/geoip/stats
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ingest/ip_location/database
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/pipeline
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, user_agent properties Modified
GET /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, user_agent properties Modified
GET /_ingest/processor/grok
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_ingest/{index}/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_license
  • Operation is now Generally available
GET /_license/basic_status
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_license/trial_status
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_lifecycle/stats
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
GET /_logstash/pipeline
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_mapping
  • Operation is now Generally available
GET /_mapping/field/{fields}
  • Operation is now Generally available
GET /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_migration/deprecations
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_migration/reindex/{index}/_status
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
GET /_migration/system_features
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
GET /_ml/anomaly_detectors
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_ml/anomaly_detectors/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_ml/anomaly_detectors/{job_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
GET /_ml/anomaly_detectors/{job_id}/results/buckets
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/categories
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/categories/{category_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/influencers
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_ml/anomaly_detectors/{job_id}/results/records
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/data_frame/analytics
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ml/data_frame/analytics/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ml/data_frame/analytics/{id}/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/datafeeds
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
GET /_ml/datafeeds/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
GET /_ml/datafeeds/{datafeed_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/filters
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/info
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_ml/memory/_stats
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ml/memory/{node_id}/_stats
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ml/trained_models
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/{model_id}/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
GET /_mtermvectors
  • Operation is now Generally available
GET /_nodes
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/hot_threads
  • Operation is now Generally available
GET /_nodes/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_nodes/stats
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/stats/{metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/stats/{metric}/{index_metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/usage
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage/{metric}
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/_repositories_metering
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/hot_threads
  • Operation is now Generally available
GET /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_nodes/{node_id}/stats
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/stats/{metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/usage
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/usage/{metric}
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_query/async/{id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_query_rules
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_recovery
  • Operation is now Generally available
GET /_refresh
  • Operation is now Generally available
GET /_remote/info
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_render/template
  • Operation is now Generally available
GET /_render/template/{id}
  • Operation is now Generally available
GET /_resolve/cluster
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_resolve/cluster/{name}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_resolve/index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_rollup/data
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_rollup/data/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_rollup/job
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_script_context
  • Operation is now Generally available
GET /_script_language
  • Operation is now Generally available
GET /_scripts/painless/_execute
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_scripts/{id}
  • Operation is now Generally available
GET /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
    • retriever property Modified
      • standard property Modified
        • _name property Added
      • knn property Modified
        • _name property Added
      • rrf property Modified
        • _name property Added
      • text_similarity_reranker property Modified
        • _name property Added
      • rule property Modified
        • ruleset_ids property Modified
          • Combinator is now oneOf
        • _name property Added
      • rescorer, linear, pinned properties Added
GET /_search/scroll
  • Operation is now Generally available
GET /_search/scroll/{scroll_id}
  • Operation is now Generally available
GET /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
GET /_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_searchable_snapshots/cache/stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.13.0
GET /_searchable_snapshots/stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_searchable_snapshots/{node_id}/cache/stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.13.0
GET /_security/_authenticate
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Modified
        • type property Modified
          • Property is now Generally available; Added in 7.14.0
GET /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
GET /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
GET /_security/_query/user
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
GET /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
GET /_security/enroll/kibana
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
GET /_security/enroll/node
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
GET /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/privilege/_builtin
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remote_cluster property Modified
        • Property is now Generally available; Added in 8.15.0
GET /_security/privilege/{application}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/privilege/{application}/{name}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/profile/_has_privileges
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
GET /_security/profile/_suggest
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_security/profile/{uid}
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_security/role
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
        • global property Modified
          • Property is now Generally available; Added in 8.0.0
GET /_security/role/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
        • global property Modified
          • Property is now Generally available; Added in 8.0.0
GET /_security/role_mapping
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_security/saml/metadata/{realm_name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_security/service
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}/credential
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes_credentials property Modified
        • _nodes property Modified
GET /_security/settings
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • security property Modified
        • index property Added
      • security-profile property Modified
        • index property Added
      • security-tokens property Modified
        • index property Added
GET /_security/user
  • Operation is now Generally available
GET /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/user/_privileges
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_security/user/{username}
  • Operation is now Generally available
GET /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_segments
  • Operation is now Generally available
GET /_settings
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_settings/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_shard_stores
  • Operation is now Generally available
GET /_slm/policy
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
GET /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
GET /_slm/stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_stats property Modified
        • Type went from array[string] to array[object]
          Breaking
        • SnapshotPolicyStats property Added
GET /_slm/status
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
GET /_snapshot
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
GET /_snapshot/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
GET /_snapshot/{repository}/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • responses property Modified
        • snapshots property Modified
      • snapshots property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
      • total, remaining properties Modified
        • Properties are now Generally available; Added in 7.15.0
GET /_snapshot/{repository}/{snapshot}/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_sql/async/status/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /_sql/async/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_ssl/certificates
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_stats/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_synonyms
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_tasks
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
GET /_tasks/{task_id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 5.0.0
GET /_template
  • Operation is now Generally available
GET /_template/{name}
  • Operation is now Generally available
GET /_text_structure/find_field_structure
  • Operation is now Generally available
GET /_text_structure/find_message_structure
  • Operation is now Generally available
GET /_text_structure/test_grok_pattern
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_transform
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}/_stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_watcher/_query/watches
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_watcher/settings
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Added
GET /_watcher/stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/stats/{metric}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/watch/{id}
  • Operation is no longer Added in 5.6.0
  • Operation is now Generally available; Added in 5.6.0
GET /_xpack
  • Operation is now Generally available
GET /_xpack/usage
  • Operation is now Generally available
GET /{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_analyze
  • Operation is now Generally available
GET /{index}/_ccr/info
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
GET /{index}/_ccr/stats
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /{index}/_count
  • Operation is now Generally available
GET /{index}/_doc/{id}
  • Operation is now Generally available
GET /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /{index}/_explain/{id}
  • Operation is now Generally available
GET /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
GET /{index}/_field_usage_stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.15.0
GET /{index}/_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_fleet/_fleet_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
GET /{index}/_fleet/global_checkpoints
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /{index}/_flush
  • Operation is now Generally available
GET /{index}/_graph/explore
  • Operation is now Generally available
GET /{index}/_ilm/explain
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /{index}/_knn_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.0.0
  • Body
  • application/json content type Modified
    • array-2 property Modified
      • Property is now Generally available; Added in 8.2.0
GET /{index}/_lifecycle/explain
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /{index}/_mapping
  • Operation is now Generally available
GET /{index}/_mapping/field/{fields}
  • Operation is now Generally available
GET /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_migration/deprecations
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
GET /{index}/_mtermvectors
  • Operation is now Generally available
GET /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /{index}/_recovery
  • Operation is now Generally available
GET /{index}/_refresh
  • Operation is now Generally available
GET /{index}/_reload_search_analyzers
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /{index}/_rollup/data
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.4.0
GET /{index}/_rollup_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
GET /{index}/_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /{index}/_searchable_snapshots/stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /{index}/_segments
  • Operation is now Generally available
GET /{index}/_settings
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_shard_stores
  • Operation is now Generally available
GET /{index}/_source/{id}
  • Operation is now Generally available
GET /{index}/_stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_stats/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
GET /{index}/_termvectors
  • Operation is now Generally available
GET /{index}/_termvectors/{id}
  • Operation is now Generally available
GET /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
HEAD /
  • Operation is now Generally available
HEAD /_alias/{name}
  • Operation is now Generally available
HEAD /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
HEAD /_index_template/{name}
  • Operation is now Generally available
HEAD /_template/{name}
  • Operation is now Generally available
HEAD /{index}
  • Operation is now Generally available
HEAD /{index}/_alias/{name}
  • Operation is now Generally available
HEAD /{index}/_doc/{id}
  • Operation is now Generally available
HEAD /{index}/_source/{id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_aliases
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_analyze
  • Operation is now Generally available
POST /_application/search_application/{name}/_render_query
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.9.0
POST /_application/search_application/{name}/_search
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
POST /_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /_bulk
  • Operation is now Generally available
POST /_cache/clear
  • Operation is now Generally available
POST /_ccr/auto_follow/{name}/pause
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_ccr/auto_follow/{name}/resume
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_cluster/allocation/explain
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • note property Modified
        • Property is now Generally available; Added in 7.14.0
POST /_cluster/reroute
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /_cluster/voting_config_exclusions
  • Operation is no longer Added in 7.0.0
  • Operation is now Generally available; Added in 7.0.0
POST /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
POST /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
POST /_connector/_sync_job
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
POST /_count
  • Operation is now Generally available
POST /_create_from/{source}/{dest}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
  • Body
  • application/json content type Modified
    • settings_override property Added
POST /_dangling/{index_uuid}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_data_stream/_migrate/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_data_stream/_modify
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
POST /_data_stream/_promote/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_delete_by_query/{task_id}/_rethrottle
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_features/_reset
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.12.0
POST /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
POST /_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /_flush
  • Operation is now Generally available
POST /_forcemerge
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
POST /_ilm/migrate_to_data_tiers
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_ilm/move/{index}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /_ilm/start
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /_ilm/stop
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /_index_template/_simulate
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate_index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
POST /_inference/chat_completion/{inference_id}/_stream
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
POST /_inference/completion/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/completion/{inference_id}/_stream
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
POST /_inference/rerank/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/sparse_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/text_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_ingest/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, user_agent properties Modified
POST /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, user_agent properties Modified
POST /_ingest/{index}/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_license
  • Operation is now Generally available
POST /_license/start_basic
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_license/start_trial
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_migration/reindex
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
POST /_migration/reindex/{index}/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
POST /_migration/system_features
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
POST /_ml/anomaly_detectors/_estimate_model_memory
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
POST /_ml/anomaly_detectors/{job_id}/_close
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_data
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_flush
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_forecast
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_ml/anomaly_detectors/{job_id}/_open
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_reset
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_ml/anomaly_detectors/{job_id}/_update
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/buckets
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/categories
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/categories/{category_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/influencers
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_ml/anomaly_detectors/{job_id}/results/records
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/data_frame/_evaluate
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_ml/data_frame/analytics/{id}/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_ml/data_frame/analytics/{id}/_start
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_stop
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_update
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/datafeeds/{datafeed_id}/_start
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_ml/datafeeds/{datafeed_id}/_stop
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/datafeeds/{datafeed_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_ml/filters/{filter_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_ml/set_upgrade_mode
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
POST /_ml/trained_models/{model_id}/_infer
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
POST /_ml/trained_models/{model_id}/deployment/_infer
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
POST /_ml/trained_models/{model_id}/deployment/_start
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
POST /_ml/trained_models/{model_id}/deployment/_stop
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
POST /_ml/trained_models/{model_id}/deployment/_update
  • Operation is no longer Added in 8.6.0
  • Operation is now Generally available; Added in 8.6.0
POST /_ml/trained_models/{model_id}/deployment/cache/_clear
  • Operation is no longer Added in 8.5.0
  • Operation is now Generally available; Added in 8.5.0
POST /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /_mtermvectors
  • Operation is now Generally available
POST /_nodes/reload_secure_settings
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_nodes/{node_id}/reload_secure_settings
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_query
  • Operation is now Generally available; Added in 8.11.0
POST /_query/async
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
  • Body
  • application/json content type Modified
    • keep_alive, keep_on_completion properties Added
  • Query
  • keep_alive, keep_on_completion, wait_for_completion_timeout query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_query/async/{id}/stop
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
POST /_query_rules/{ruleset_id}/_test
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
POST /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_refresh
  • Operation is now Generally available
POST /_reindex
  • Operation is no longer Added in 2.3.0
  • Operation is now Generally available; Added in 2.3.0
POST /_reindex/{task_id}/_rethrottle
  • Operation is no longer Added in 2.4.0
  • Operation is now Generally available; Added in 2.4.0
POST /_render/template
  • Operation is now Generally available
POST /_render/template/{id}
  • Operation is now Generally available
POST /_rollup/job/{id}/_start
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_rollup/job/{id}/_stop
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_scripts/painless/_execute
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_scripts/{id}
  • Operation is now Generally available
POST /_scripts/{id}/{context}
  • Operation is now Generally available
POST /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /_search/scroll
  • Operation is now Generally available
POST /_search/scroll/{scroll_id}
  • Operation is now Generally available
POST /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
POST /_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
POST /_searchable_snapshots/cache/clear
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.10.0
POST /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
POST /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/_query/user
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
POST /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available; Added in 7.16.0
POST /_security/api_key/_bulk_update
  • Operation is no longer Added in 8.5.0
  • Operation is now Generally available; Added in 8.5.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/api_key/grant
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Body
  • application/json content type Modified
    • api_key property Modified
      • role_descriptors property Modified
        • object-1, array-2 alternatives Modified
POST /_security/api_key/{ids}/_clear_cache
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/cross_cluster/api_key
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • allow_restricted_indices property Modified
          • Property is now Generally available
POST /_security/delegate_pki
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /_security/oauth2/token
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_security/oidc/authenticate
  • Operation is now Generally available
POST /_security/oidc/logout
  • Operation is now Generally available
POST /_security/oidc/prepare
  • Operation is now Generally available
POST /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_security/privilege/{application}/_clear_cache
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/profile/_activate
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/_has_privileges
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
POST /_security/profile/_suggest
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_data
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_disable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_enable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/realm/{realms}/_clear_cache
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/role/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • global property Modified
      • Property is now Generally available
    • indices property Modified
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_indices property Modified
      • Property is now Generally available; Added in 8.14.0
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_cluster property Modified
      • Property is now Generally available; Added in 8.15.0
POST /_security/role/{name}/_clear_cache
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_security/saml/authenticate
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/complete_logout
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_security/saml/invalidate
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/logout
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/prepare
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/service/{namespace}/{service}/credential/token
  • Operation is now Generally available
POST /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is now Generally available
POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_security/user/_password
  • Operation is now Generally available
POST /_security/user/{username}
  • Operation is now Generally available
POST /_security/user/{username}/_disable
  • Operation is now Generally available
POST /_security/user/{username}/_enable
  • Operation is now Generally available
POST /_security/user/{username}/_password
  • Operation is now Generally available
POST /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_slm/_execute_retention
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_slm/start
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
POST /_slm/stop
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
POST /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
POST /_snapshot/{repository}/_analyze
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
POST /_snapshot/{repository}/_cleanup
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /_snapshot/{repository}/_verify
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
POST /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accepted property Modified
        • Property is now Generally available; Added in 7.15.0
      • snapshot property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
POST /_snapshot/{repository}/{snapshot}/_mount
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /_snapshot/{repository}/{snapshot}/_restore
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Body
  • application/json content type Modified
    • index_settings property Added
POST /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_sql/close
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_tasks/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
POST /_tasks/{task_id}/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
POST /_template/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Added
POST /_text_structure/find_message_structure
  • Operation is now Generally available
POST /_text_structure/find_structure
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_text_structure/test_grok_pattern
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
POST /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/_upgrade
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
POST /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/{transform_id}/_reset
  • Operation is no longer Added in 8.1.0
  • Operation is now Generally available; Added in 8.1.0
POST /_transform/{transform_id}/_schedule_now
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
POST /_transform/{transform_id}/_start
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_transform/{transform_id}/_stop
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_transform/{transform_id}/_update
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • unattended property Modified
          • Property is now Generally available; Added in 8.5.0
POST /_update_by_query/{task_id}/_rethrottle
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_watcher/_query/watches
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
POST /_watcher/_start
  • Operation is now Generally available
POST /_watcher/_stop
  • Operation is now Generally available
POST /_watcher/watch/_execute
  • Operation is now Generally available
POST /_watcher/watch/{id}
  • Operation is now Generally available
POST /_watcher/watch/{id}/_execute
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_ack
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_ack/{action_id}
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_activate
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_deactivate
  • Operation is now Generally available
POST /{alias}/_rollover
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{alias}/_rollover/{new_index}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_alias/{name}
  • Operation is now Generally available
POST /{index}/_aliases/{name}
  • Operation is now Generally available
POST /{index}/_analyze
  • Operation is now Generally available
POST /{index}/_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_bulk
  • Operation is now Generally available
POST /{index}/_cache/clear
  • Operation is now Generally available
POST /{index}/_ccr/forget_follower
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
POST /{index}/_ccr/pause_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_ccr/resume_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_ccr/unfollow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_clone/{target}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /{index}/_close
  • Operation is now Generally available
POST /{index}/_count
  • Operation is now Generally available
POST /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_delete_by_query
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • query model Modified
POST /{index}/_disk_usage
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.15.0
POST /{index}/_doc
  • Operation is now Generally available
POST /{index}/_doc/{id}
  • Operation is now Generally available
POST /{index}/_downsample/{target_index}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.5.0
POST /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /{index}/_explain/{id}
  • Operation is now Generally available
POST /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
POST /{index}/_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_fleet/_fleet_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
POST /{index}/_flush
  • Operation is now Generally available
POST /{index}/_forcemerge
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
POST /{index}/_graph/explore
  • Operation is now Generally available
POST /{index}/_ilm/remove
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /{index}/_ilm/retry
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /{index}/_knn_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.0.0
  • Body
  • application/json content type Modified
    • array-2 property Modified
      • Property is now Generally available; Added in 8.2.0
POST /{index}/_mapping
  • Operation is now Generally available
POST /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • MultisearchBody alternative Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_mtermvectors
  • Operation is now Generally available
POST /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
POST /{index}/_open
  • Operation is now Generally available
POST /{index}/_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /{index}/_refresh
  • Operation is now Generally available
POST /{index}/_reload_search_analyzers
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /{index}/_rollup_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
POST /{index}/_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
POST /{index}/_searchable_snapshots/cache/clear
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.10.0
POST /{index}/_shrink/{target}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_split/{target}
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /{index}/_termvectors
  • Operation is now Generally available
POST /{index}/_termvectors/{id}
  • Operation is now Generally available
POST /{index}/_unfreeze
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /{index}/_update/{id}
  • Operation is now Generally available
POST /{index}/_update_by_query
  • Operation is no longer Added in 2.4.0
  • Operation is now Generally available; Added in 2.4.0
POST /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
PUT /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
PUT /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
PUT /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
PUT /_bulk
  • Operation is now Generally available
PUT /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
PUT /_cluster/settings
  • Operation is now Generally available
PUT /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
PUT /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_api_key_id
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_check_in
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_configuration
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_error
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • error property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_filtering
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_filtering/_activate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_filtering/_validation
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_index_name
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
  • Body
  • application/json content type Modified
    • index_name property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_name
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_native
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_pipeline
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_scheduling
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_service_type
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_status
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_create_from/{source}/{dest}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
  • Body
  • application/json content type Modified
    • settings_override property Added
PUT /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
PUT /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
PUT /_enrich/policy/{name}/_execute
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
PUT /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
PUT /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
PUT /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{inference_id}/_update
  • Operation is no longer Added in 8.17.0
  • Operation is now Generally available; Added in 8.17.0
PUT /_inference/{task_type}/{alibabacloud_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_inference/{task_type}/{amazonbedrock_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
PUT /_inference/{task_type}/{anthropic_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_inference/{task_type}/{azureaistudio_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
PUT /_inference/{task_type}/{azureopenai_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
PUT /_inference/{task_type}/{cohere_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
PUT /_inference/{task_type}/{elasticsearch_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
PUT /_inference/{task_type}/{elser_inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{task_type}/{googleaistudio_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{googlevertexai_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{huggingface_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
PUT /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{task_type}/{inference_id}/_update
  • Operation is no longer Added in 8.17.0
  • Operation is now Generally available; Added in 8.17.0
PUT /_inference/{task_type}/{jinaai_inference_id}
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
PUT /_inference/{task_type}/{mistral_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{openai_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
PUT /_inference/{task_type}/{voyageai_inference_id}
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available; Added in 8.19.0
PUT /_inference/{task_type}/{watsonx_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /_license
  • Operation is now Generally available
PUT /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
PUT /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
PUT /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
PUT /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
PUT /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
PUT /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
PUT /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
PUT /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
PUT /_ml/trained_models/{model_id}/definition/{part}
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
PUT /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
PUT /_ml/trained_models/{model_id}/vocabulary
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
  • Body
  • application/json content type Modified
    • merges property Modified
      • Property is now Generally available; Added in 8.2.0
    • scores property Modified
      • Property is now Generally available; Added in 8.9.0
PUT /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
PUT /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
PUT /_scripts/{id}
  • Operation is now Generally available
PUT /_scripts/{id}/{context}
  • Operation is now Generally available
PUT /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available; Added in 7.16.0
PUT /_security/api_key/{id}
  • Operation is no longer Added in 8.4.0
  • Operation is now Generally available; Added in 8.4.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
PUT /_security/cross_cluster/api_key/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • allow_restricted_indices property Modified
          • Property is now Generally available
PUT /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
PUT /_security/profile/{uid}/_data
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/profile/{uid}/_disable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/profile/{uid}/_enable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/role/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • global property Modified
      • Property is now Generally available
    • indices property Modified
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_indices property Modified
      • Property is now Generally available; Added in 8.14.0
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_cluster property Modified
      • Property is now Generally available; Added in 8.15.0
PUT /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
PUT /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is now Generally available
PUT /_security/settings
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Added
    • security-profile property Modified
      • index property Added
    • security-tokens property Modified
      • index property Added
PUT /_security/user/_password
  • Operation is now Generally available
PUT /_security/user/{username}
  • Operation is now Generally available
PUT /_security/user/{username}/_disable
  • Operation is now Generally available
PUT /_security/user/{username}/_enable
  • Operation is now Generally available
PUT /_security/user/{username}/_password
  • Operation is now Generally available
PUT /_settings
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /_slm/policy/{policy_id}/_execute
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
PUT /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accepted property Modified
        • Property is now Generally available; Added in 7.15.0
      • snapshot property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
PUT /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_template/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Added
PUT /_transform/{transform_id}
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
PUT /_watcher/settings
  • Operation is now Generally available
PUT /_watcher/watch/_execute
  • Operation is now Generally available
PUT /_watcher/watch/{id}
  • Operation is now Generally available
PUT /_watcher/watch/{id}/_execute
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_ack
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_ack/{action_id}
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_activate
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_deactivate
  • Operation is now Generally available
PUT /{index}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}/_alias/{name}
  • Operation is now Generally available
PUT /{index}/_aliases/{name}
  • Operation is now Generally available
PUT /{index}/_block/{block}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
PUT /{index}/_bulk
  • Operation is now Generally available
PUT /{index}/_ccr/follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • mode, soft_deletes, sort, number_of_routing_shards, check_on_startup, codec, load_fixed_bitset_filters_eagerly, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, uuid, version, max_slices_per_scroll, translog, query_string, top_metrics_max_size, analysis, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • routing_path property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, array-2 properties Removed
      • 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
      • routing_partition_size property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • Stringifiedinteger, Stringifiedinteger properties Removed
      • hidden property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • auto_expand_replicas property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, NullValue properties Removed
      • creation_date property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • UnitMillis, StringifiedEpochTimeUnitMillis properties Removed
      • creation_date_string property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • DateTime, UnitMillis properties Removed
      • verified_before_close property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • format property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, number-2 properties Removed
      • priority property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
PUT /{index}/_clone/{target}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /{index}/_doc/{id}
  • Operation is now Generally available
PUT /{index}/_mapping
  • Operation is now Generally available
PUT /{index}/_settings
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /{index}/_shrink/{target}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /{index}/_split/{target}
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
Kibana Serverless API

This documentation update aligns with a release. Check out the release notes.

20 structure changes including:
9 Breaking changes
4 Additions
7 Modifications
9 Removals
Modified 7 Breaking
GET /api/entity_analytics/monitoring/privileges/health
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ok property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • error property Added
      • status property Added
        • Security_Entity_Analytics_API_EngineStatus, string-2 properties Added
GET /api/entity_analytics/monitoring/users/list
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
GET /api/fleet/remote_synced_integrations/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • warning property Modified
          • Type went from string to object
            Breaking
      • warning property Modified
        • Type went from string to object
          Breaking
        • message, title properties Added
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • warning property Modified
          • Type went from string to object
            Breaking
      • warning property Modified
        • Type went from string to object
          Breaking
        • message, title properties Added
POST /api/detection_engine/rules/_bulk_action
  • Body
  • application/json content type Modified
    • Security_Detections_API_BulkEditRules alternative Modified
      • edit property Modified
        • Security_Detections_API_BulkActionEditPayloadSetAlertSuppression, Security_Detections_API_BulkActionEditPayloadSetAlertSuppressionForThreshold, Security_Detections_API_BulkActionEditPayloadDeleteAlertSuppression alternatives Added
    • Security_Detections_API_BulkManualRuleFillGaps alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Security_Detections_API_BulkEditActionResponse alternative Modified
        • attributes property Modified
POST /api/entity_analytics/monitoring/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
PUT /api/entity_analytics/monitoring/users/{id}
  • Body
  • application/json content type Modified
    • labels property Modified
      • monitoring property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • user property Modified
      • is_privileged property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
Removed 9 Breaking
PUT /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/migrate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/entity_analytics/monitoring/users/_json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/entity_analytics/monitoring/users/_csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/entity_analytics/monitoring/users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboards/dashboard
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
POST /api/entity_analytics/privileged_user_monitoring/pad/install
POST /api/entity_analytics/monitoring/users/_csv
GET /api/entity_analytics/privileged_user_monitoring/pad/status
DELETE /api/security_ai_assistant/current_user/conversations
22 structure changes including:
9 Breaking changes
5 Additions
8 Modifications
9 Removals
Modified 8 Breaking
GET /api/entity_analytics/monitoring/privileges/health
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ok property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • error property Added
      • status property Added
        • Security_Entity_Analytics_API_EngineStatus, string-2 properties Added
GET /api/entity_analytics/monitoring/users/list
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
GET /api/fleet/remote_synced_integrations/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • warning property Modified
          • Type went from string to object
            Breaking
      • warning property Modified
        • Type went from string to object
          Breaking
        • message, title properties Added
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • warning property Modified
          • Type went from string to object
            Breaking
      • warning property Modified
        • Type went from string to object
          Breaking
        • message, title properties Added
POST /api/detection_engine/rules/_bulk_action
  • Body
  • application/json content type Modified
    • Security_Detections_API_BulkEditRules alternative Modified
      • edit property Modified
        • Security_Detections_API_BulkActionEditPayloadSetAlertSuppression, Security_Detections_API_BulkActionEditPayloadSetAlertSuppressionForThreshold, Security_Detections_API_BulkActionEditPayloadDeleteAlertSuppression alternatives Added
    • Security_Detections_API_BulkManualRuleFillGaps alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Security_Detections_API_BulkEditActionResponse alternative Modified
        • attributes property Modified
POST /api/entity_analytics/monitoring/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
POST /api/security/session/_invalidate
  • Operation is no longer Technical Preview
PUT /api/entity_analytics/monitoring/users/{id}
  • Body
  • application/json content type Modified
    • labels property Modified
      • monitoring property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • user property Modified
      • is_privileged property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
        • monitoring property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • user property Modified
        • is_privileged property Added
Removed 9 Breaking
PUT /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/migrate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/entity_analytics/monitoring/users/_json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/entity_analytics/monitoring/users/_csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/entity_analytics/monitoring/users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboards/dashboard
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/dashboards/dashboard/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
PUT /api/synthetics/private_locations/{id}
POST /api/entity_analytics/privileged_user_monitoring/pad/install
POST /api/entity_analytics/monitoring/users/_csv
GET /api/entity_analytics/privileged_user_monitoring/pad/status
DELETE /api/security_ai_assistant/current_user/conversations
Elastic Cloud Serverless API
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/v1/serverless/regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • country_code property Modified
        • Property is now required
          Breaking
GET /api/v1/serverless/regions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • country_code property Modified
        • Property is now required
          Breaking
Elastic Cloud Serverless API
2 structure changes including:
2 Modifications
Modified 2
GET /api/v1/serverless/regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • country_code property Added
GET /api/v1/serverless/regions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • country_code property Added
Kibana API

This update aligns with the Kibana 8.18.3 release. Check out the release notes.

1 structure change including:
1 Modification
Modified 1
POST /api/security/session/_invalidate
  • Operation is no longer Technical Preview
Elasticsearch API

This documentation update includes more examples in a variety of languages for each API.

82 structure changes including:
82 Modifications
Modified 82 Breaking
GET /_data_stream/{name}/_settings
  • Operation is no longer Generally available
  • Operation is now Generally available; Added in 9.1.0
GET /_enrich/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • executing_policies property Modified
        • task property Modified
GET /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_ml/anomaly_detectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • blocked property Modified
GET /_ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • blocked property Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_query/async/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _clusters property Modified
        • details property Modified
GET /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_scripts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
GET /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_sql/translate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_tasks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
      • tasks property Modified
        • TaskInfos alternative Modified
          • Type went from object to array[object]
            Breaking
GET /_tasks/{task_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • parent_task_id property Modified
          • Removing polymorphism is always breaking
            Breaking
GET /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, condition properties Modified
GET /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
GET /{index}/_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
GET /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_async_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_delete_by_query/{task_id}/_rethrottle
  • Path
  • task_id path parameter Modified
    • Type went from string | number to string
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
      • tasks property Modified
        • TaskInfos alternative Modified
          • Type went from object to array[object]
            Breaking
POST /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _clusters property Modified
        • details property Modified
POST /_query/async
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _clusters property Modified
        • details property Modified
POST /_query/async/{id}/stop
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _clusters property Modified
        • details property Modified
POST /_reindex
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
POST /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_sql/translate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_tasks/_cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
      • tasks property Modified
        • TaskInfos alternative Modified
          • Type went from object to array[object]
            Breaking
POST /_tasks/{task_id}/_cancel
  • Path
  • task_id path parameter Modified
    • Type went from string | number to string
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
      • tasks property Modified
        • TaskInfos alternative Modified
          • Type went from object to array[object]
            Breaking
POST /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_delete_by_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
POST /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /{index}/_update/{id}
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_update_by_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
PUT /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
PUT /_data_stream/{name}/_settings
  • Operation is no longer Generally available
  • Operation is now Generally available; Added in 9.1.0
PUT /_enrich/policy/{name}/_execute
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
PUT /_inference/{task_type}/{huggingface_inference_id}
  • Body
  • application/json content type Modified
    • task_settings property Added
PUT /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
Elasticsearch Serverless API

This documentation update includes more examples in a variety of languages for each API.

53 structure changes including:
53 Modifications
Modified 53 Breaking
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_ml/anomaly_detectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • blocked property Modified
GET /_ml/anomaly_detectors/{job_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • blocked property Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_scripts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
GET /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
GET /_sql/translate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /_tasks/{task_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • parent_task_id property Modified
          • Removing polymorphism is always breaking
            Breaking
GET /{index}/_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
GET /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
GET /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_async_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _clusters property Modified
        • details property Modified
POST /_reindex
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
POST /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /_sql/translate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_delete_by_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
POST /{index}/_mget
  • Body
  • application/json content type Modified
    • docs property Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • _source property Modified
        • SourceFilter alternative Modified
POST /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • _source property Modified
POST /{index}/_update/{id}
  • Body
  • application/json content type Modified
    • _source property Modified
      • SourceFilter alternative Modified
        • exclude_vectors property Added
POST /{index}/_update_by_query
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
PUT /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
PUT /_enrich/policy/{name}/_execute
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task property Modified
        • Removing polymorphism is always breaking
          Breaking
PUT /_inference/{task_type}/{huggingface_inference_id}
  • Body
  • application/json content type Modified
    • task_settings property Added
PUT /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
      • _source property Modified
        • SourceFilter alternative Modified
Elasticsearch API

This update includes documentation improvements such as Console examples and more detailed API lifecycle details.

800 structure changes including:
2 Additions
798 Modifications
Modified 798 Breaking
POST /_query/async/{id}/stop
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
POST /_query_rules/{ruleset_id}/_test
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
POST /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_refresh
  • Operation is now Generally available
POST /_reindex
  • Operation is no longer Added in 2.3.0
  • Operation is now Generally available; Added in 2.3.0
POST /_reindex/{task_id}/_rethrottle
  • Operation is no longer Added in 2.4.0
  • Operation is now Generally available; Added in 2.4.0
POST /_render/template
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_render/template/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_rollup/job/{id}/_start
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_rollup/job/{id}/_stop
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_scripts/painless/_execute
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /_scripts/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}/{context}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /_search/scroll
  • Operation is now Generally available
POST /_search/scroll/{scroll_id}
  • Operation is now Generally available
POST /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
POST /_searchable_snapshots/cache/clear
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.10.0
POST /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
POST /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/_query/user
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
POST /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available; Added in 7.16.0
POST /_security/api_key/_bulk_update
  • Operation is no longer Added in 8.5.0
  • Operation is now Generally available; Added in 8.5.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/api_key/grant
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Body
  • application/json content type Modified
    • api_key property Modified
      • role_descriptors property Modified
        • object-1, array-2 alternatives Modified
POST /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_ml/data_frame/analytics/{id}/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_ml/data_frame/analytics/{id}/_start
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_stop
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/{id}/_update
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/datafeeds/{datafeed_id}/_start
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_ml/datafeeds/{datafeed_id}/_stop
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/datafeeds/{datafeed_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_ml/filters/{filter_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_ml/set_upgrade_mode
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
POST /_ml/trained_models/{model_id}/_infer
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
POST /_ml/trained_models/{model_id}/deployment/_start
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
POST /_ml/trained_models/{model_id}/deployment/_stop
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
POST /_ml/trained_models/{model_id}/deployment/_update
  • Operation is no longer Added in 8.6.0
  • Operation is now Generally available; Added in 8.6.0
POST /_ml/trained_models/{model_id}/deployment/cache/_clear
  • Operation is no longer Added in 8.5.0
  • Operation is now Generally available; Added in 8.5.0
POST /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_mtermvectors
  • Operation is now Generally available
POST /_nodes/reload_secure_settings
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_nodes/{node_id}/reload_secure_settings
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_query
  • Operation is now Generally available; Added in 8.11.0
POST /_query/async
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
  • Body
  • application/json content type Modified
    • keep_alive, keep_on_completion properties Added
  • Query
  • keep_alive, keep_on_completion, wait_for_completion_timeout query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_security/service/{namespace}/{service}/credential/token
  • Operation is now Generally available
POST /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is now Generally available
POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
  • Operation is now Generally available
POST /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_security/user/_password
  • Operation is now Generally available
POST /_security/user/{username}
  • Operation is now Generally available
POST /_security/user/{username}/_disable
  • Operation is now Generally available
POST /_security/user/{username}/_enable
  • Operation is now Generally available
POST /_security/user/{username}/_password
  • Operation is now Generally available
POST /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_slm/_execute_retention
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_slm/start
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
POST /_slm/stop
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
POST /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
POST /_snapshot/{repository}/_analyze
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
POST /_snapshot/{repository}/_cleanup
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /_snapshot/{repository}/_verify
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
POST /_snapshot/{repository}/_verify_integrity
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.16.0
POST /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accepted property Modified
        • Property is now Generally available; Added in 7.15.0
      • snapshot property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
POST /_snapshot/{repository}/{snapshot}/_mount
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /_snapshot/{repository}/{snapshot}/_restore
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
POST /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_sql/close
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_tasks/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
POST /_security/api_key/{ids}/_clear_cache
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /_security/cross_cluster/api_key
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • allow_restricted_indices property Modified
          • Property is now Generally available
POST /_security/delegate_pki
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /_security/oauth2/token
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_security/oidc/authenticate
  • Operation is now Generally available
POST /_security/oidc/logout
  • Operation is now Generally available
POST /_security/oidc/prepare
  • Operation is now Generally available
POST /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
POST /_security/privilege/{application}/_clear_cache
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_security/profile/_activate
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/_has_privileges
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
POST /_security/profile/_suggest
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_data
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_disable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/profile/{uid}/_enable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
POST /_security/realm/{realms}/_clear_cache
  • Operation is now Generally available
POST /_security/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
POST /_security/role/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • global property Modified
      • Property is now Generally available
    • indices property Modified
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_indices property Modified
      • Property is now Generally available; Added in 8.14.0
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_cluster property Modified
      • Property is now Generally available; Added in 8.15.0
POST /_security/role/{name}/_clear_cache
  • Operation is now Generally available
POST /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
POST /_security/saml/authenticate
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/complete_logout
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_security/saml/invalidate
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/logout
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_security/saml/prepare
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /_cache/clear
  • Operation is now Generally available
POST /_ccr/auto_follow/{name}/pause
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_ccr/auto_follow/{name}/resume
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_cluster/allocation/explain
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • note property Modified
        • Property is now Generally available; Added in 7.14.0
POST /_cluster/reroute
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /_cluster/voting_config_exclusions
  • Operation is no longer Added in 7.0.0
  • Operation is now Generally available; Added in 7.0.0
POST /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
POST /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
POST /_connector/_sync_job
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
POST /_count
  • Operation is now Generally available
POST /_create_from/{source}/{dest}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
POST /_dangling/{index_uuid}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_data_stream/_migrate/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_data_stream/_modify
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
POST /_data_stream/_promote/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_delete_by_query/{task_id}/_rethrottle
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_features/_reset
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.12.0
POST /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
POST /_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /_flush
  • Operation is now Generally available
POST /_forcemerge
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
POST /_ilm/migrate_to_data_tiers
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_ilm/move/{index}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /{index}/_searchable_snapshots/stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /{index}/_segments
  • Operation is now Generally available
GET /{index}/_settings
  • Operation is now Generally available
GET /{index}/_settings/{name}
  • Operation is now Generally available
GET /{index}/_shard_stores
  • Operation is now Generally available
GET /{index}/_source/{id}
  • Operation is now Generally available
GET /{index}/_stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_stats/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
GET /{index}/_termvectors
  • Operation is now Generally available
GET /{index}/_termvectors/{id}
  • Operation is now Generally available
GET /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
HEAD /
  • Operation is now Generally available
HEAD /_alias/{name}
  • Operation is now Generally available
HEAD /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
HEAD /_index_template/{name}
  • Operation is now Generally available
HEAD /_template/{name}
  • Operation is now Generally available
HEAD /{index}
  • Operation is now Generally available
HEAD /{index}/_alias/{name}
  • Operation is now Generally available
HEAD /{index}/_doc/{id}
  • Operation is now Generally available
HEAD /{index}/_source/{id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_aliases
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_analyze
  • Operation is now Generally available
POST /_application/search_application/{name}/_render_query
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.9.0
POST /_application/search_application/{name}/_search
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
POST /_ml/anomaly_detectors/_estimate_model_memory
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
POST /_ml/anomaly_detectors/{job_id}/_close
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_data
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_flush
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_forecast
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_ml/anomaly_detectors/{job_id}/_open
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/_reset
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
POST /_ml/anomaly_detectors/{job_id}/_update
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/buckets
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/categories
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/categories/{category_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/influencers
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_ml/anomaly_detectors/{job_id}/results/records
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
POST /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /_ml/data_frame/_evaluate
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ml/data_frame/analytics/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /_ilm/start
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /_ilm/stop
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /_index_template/_simulate
  • Operation is now Generally available
POST /_index_template/_simulate/{name}
  • Operation is now Generally available
POST /_index_template/_simulate_index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /_inference/chat_completion/{inference_id}/_stream
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
POST /_inference/completion/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/completion/{inference_id}/_stream
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
POST /_inference/rerank/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/sparse_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/text_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
POST /_ingest/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
POST /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
POST /_ingest/{index}/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_license
  • Operation is now Generally available
POST /_license/start_basic
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
POST /_license/start_trial
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_migration/reindex
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
POST /_migration/reindex/{index}/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
POST /_migration/system_features
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
PUT /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{task_type}/{inference_id}/_update
  • Operation is no longer Added in 8.17.0
  • Operation is now Generally available; Added in 8.17.0
PUT /_inference/{task_type}/{jinaai_inference_id}
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available; Added in 8.18.0
PUT /_inference/{task_type}/{mistral_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{openai_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
PUT /_inference/{task_type}/{voyageai_inference_id}
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available; Added in 8.19.0
PUT /_inference/{task_type}/{watsonx_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /_license
  • Operation is now Generally available
PUT /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
PUT /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
PUT /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
PUT /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
PUT /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
PUT /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
PUT /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
PUT /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
PUT /_ml/trained_models/{model_id}/definition/{part}
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
PUT /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
PUT /_ml/trained_models/{model_id}/vocabulary
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
  • Body
  • application/json content type Modified
    • merges property Modified
      • Property is now Generally available; Added in 8.2.0
    • scores property Modified
      • Property is now Generally available; Added in 8.9.0
PUT /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
PUT /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_connector/{connector_id}/_pipeline
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_scheduling
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_service_type
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_status
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_create_from/{source}/{dest}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
PUT /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
PUT /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_data_stream/{name}/_options
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available; Added in 8.19.0
PUT /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
PUT /_enrich/policy/{name}/_execute
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
PUT /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
PUT /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
PUT /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{inference_id}/_update
  • Operation is no longer Added in 8.17.0
  • Operation is now Generally available; Added in 8.17.0
PUT /_inference/{task_type}/{alibabacloud_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_inference/{task_type}/{amazonbedrock_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
PUT /_inference/{task_type}/{anthropic_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available; Added in 8.16.0
PUT /_inference/{task_type}/{azureaistudio_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
PUT /_inference/{task_type}/{azureopenai_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
PUT /_inference/{task_type}/{cohere_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
PUT /_inference/{task_type}/{elasticsearch_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
PUT /_inference/{task_type}/{elser_inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
PUT /_inference/{task_type}/{googleaistudio_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{googlevertexai_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
PUT /_inference/{task_type}/{huggingface_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
  • Body
  • application/json content type Modified
    • service_settings property Modified
      • model_id property Added
PUT /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
PUT /_template/{name}
  • Operation is now Generally available
PUT /_transform/{transform_id}
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
PUT /_watcher/settings
  • Operation is now Generally available
PUT /_watcher/watch/_execute
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_watcher/watch/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
PUT /_watcher/watch/{id}/_execute
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_watcher/watch/{watch_id}/_ack
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_ack/{action_id}
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_activate
  • Operation is now Generally available
PUT /_watcher/watch/{watch_id}/_deactivate
  • Operation is now Generally available
PUT /{index}
  • Operation is now Generally available
PUT /{index}/_alias/{name}
  • Operation is now Generally available
PUT /{index}/_aliases/{name}
  • Operation is now Generally available
PUT /{index}/_block/{block}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
PUT /{index}/_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /{index}/_ccr/follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
PUT /{index}/_clone/{target}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /{index}/_doc/{id}
  • Operation is now Generally available
PUT /{index}/_mapping
  • Operation is now Generally available
PUT /{index}/_settings
  • Operation is now Generally available
PUT /{index}/_shrink/{target}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
PUT /{index}/_split/{target}
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
PUT /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
PUT /_scripts/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}/{context}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available; Added in 7.16.0
PUT /_security/api_key/{id}
  • Operation is no longer Added in 8.4.0
  • Operation is now Generally available; Added in 8.4.0
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
PUT /_security/cross_cluster/api_key/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • access property Modified
      • search property Modified
        • allow_restricted_indices property Modified
          • Property is now Generally available
PUT /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
PUT /_security/profile/{uid}/_data
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/profile/{uid}/_disable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/profile/{uid}/_enable
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
PUT /_security/role/{name}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • global property Modified
      • Property is now Generally available
    • indices property Modified
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_indices property Modified
      • Property is now Generally available; Added in 8.14.0
      • allow_restricted_indices property Modified
        • Property is now Generally available
    • remote_cluster property Modified
      • Property is now Generally available; Added in 8.15.0
PUT /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
PUT /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is now Generally available
PUT /_security/settings
  • Operation is now Generally available
PUT /_security/user/_password
  • Operation is now Generally available
PUT /_security/user/{username}
  • Operation is now Generally available
PUT /_security/user/{username}/_disable
  • Operation is now Generally available
PUT /_security/user/{username}/_enable
  • Operation is now Generally available
PUT /_security/user/{username}/_password
  • Operation is now Generally available
PUT /_settings
  • Operation is now Generally available
PUT /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /_slm/policy/{policy_id}/_execute
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
PUT /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
PUT /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accepted property Modified
        • Property is now Generally available; Added in 7.15.0
      • snapshot property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /{alias}/_rollover
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{alias}/_rollover/{new_index}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_alias/{name}
  • Operation is now Generally available
POST /{index}/_aliases/{name}
  • Operation is now Generally available
POST /{index}/_analyze
  • Operation is now Generally available
POST /{index}/_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /{index}/_cache/clear
  • Operation is now Generally available
POST /{index}/_ccr/forget_follower
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
POST /{index}/_ccr/pause_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_ccr/resume_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_ccr/unfollow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /{index}/_clone/{target}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
POST /{index}/_close
  • Operation is now Generally available
POST /{index}/_count
  • Operation is now Generally available
POST /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_delete_by_query
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_disk_usage
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.15.0
POST /{index}/_doc
  • Operation is now Generally available
POST /{index}/_doc/{id}
  • Operation is now Generally available
POST /{index}/_downsample/{target_index}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.5.0
POST /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
POST /{index}/_explain/{id}
  • Operation is now Generally available
POST /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
POST /{index}/_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /_tasks/{task_id}/_cancel
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
POST /_template/{name}
  • Operation is now Generally available
POST /_text_structure/find_message_structure
  • Operation is now Generally available
POST /_text_structure/find_structure
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
POST /_text_structure/test_grok_pattern
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
POST /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
POST /_transform/_upgrade
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
POST /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
POST /_transform/{transform_id}/_reset
  • Operation is no longer Added in 8.1.0
  • Operation is now Generally available; Added in 8.1.0
POST /_transform/{transform_id}/_schedule_now
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
POST /_transform/{transform_id}/_start
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_transform/{transform_id}/_stop
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
POST /_transform/{transform_id}/_update
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • unattended property Modified
          • Property is now Generally available; Added in 8.5.0
POST /_update_by_query/{task_id}/_rethrottle
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
POST /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /_watcher/_query/watches
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_watcher/_start
  • Operation is now Generally available
POST /_watcher/_stop
  • Operation is now Generally available
POST /_watcher/watch/_execute
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/watch/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
POST /_watcher/watch/{id}/_execute
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/watch/{watch_id}/_ack
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_ack/{action_id}
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_activate
  • Operation is now Generally available
POST /_watcher/watch/{watch_id}/_deactivate
  • Operation is now Generally available
POST /{index}/_termvectors
  • Operation is now Generally available
POST /{index}/_termvectors/{id}
  • Operation is now Generally available
POST /{index}/_update/{id}
  • Operation is now Generally available
POST /{index}/_update_by_query
  • Operation is no longer Added in 2.4.0
  • Operation is now Generally available; Added in 2.4.0
POST /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
PUT /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
PUT /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
PUT /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
PUT /_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
PUT /_cluster/settings
  • Operation is now Generally available
PUT /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
PUT /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_api_key_id
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_check_in
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_configuration
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_error
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_filtering
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_filtering/_activate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_filtering/_validation
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
PUT /_connector/{connector_id}/_index_name
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_name
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
PUT /_connector/{connector_id}/_native
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
POST /{index}/_fleet/_fleet_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
POST /{index}/_flush
  • Operation is now Generally available
POST /{index}/_forcemerge
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
POST /{index}/_graph/explore
  • Operation is now Generally available
POST /{index}/_ilm/remove
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /{index}/_ilm/retry
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
POST /{index}/_mapping
  • Operation is now Generally available
POST /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
POST /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_mtermvectors
  • Operation is now Generally available
POST /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
POST /{index}/_open
  • Operation is now Generally available
POST /{index}/_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
POST /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
POST /{index}/_refresh
  • Operation is now Generally available
POST /{index}/_reload_search_analyzers
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
POST /{index}/_rollup_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
POST /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
POST /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /{index}/_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
POST /{index}/_searchable_snapshots/cache/clear
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.10.0
POST /{index}/_shrink/{target}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
POST /{index}/_split/{target}
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
POST /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available; Added in 7.14.0
GET /_cat/transforms/{transform_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_ccr/auto_follow
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_ccr/stats
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_cluster/allocation/explain
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • note property Modified
        • Property is now Generally available; Added in 7.14.0
GET /_cluster/health
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/health/{index}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/pending_tasks
  • Operation is now Generally available
GET /_cluster/settings
  • Operation is now Generally available
GET /_cluster/state
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/state/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/state/{metric}/{index}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_cluster/stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • analysis, mappings properties Modified
      • nodes property Modified
        • count, os properties Modified
GET /_cluster/stats/nodes/{node_id}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • analysis, mappings properties Modified
      • nodes property Modified
        • count, os properties Modified
GET /_component_template
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_connector
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/_sync_job
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
GET /_count
  • Operation is now Generally available
GET /_dangling
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_data_stream
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available; Added in 7.10.0
        • settings property Added
GET /_data_stream/_stats
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available; Added in 7.10.0
        • settings property Added
DELETE /_ml/_delete_expired_data/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_cat/ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/datafeeds
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/trained_models
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available; Added in 8.0.0
GET /_cat/ml/trained_models/{model_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available; Added in 8.0.0
GET /_cat/nodeattrs
  • Operation is now Generally available
GET /_cat/nodes
  • Operation is now Generally available
GET /_cat/pending_tasks
  • Operation is now Generally available
GET /_cat/plugins
  • Operation is now Generally available
GET /_cat/recovery
  • Operation is now Generally available
GET /_cat/recovery/{index}
  • Operation is now Generally available
GET /_cat/repositories
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/segments
  • Operation is now Generally available
GET /_cat/segments/{index}
  • Operation is now Generally available
GET /_cat/shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/shards/{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/snapshots
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/snapshots/{repository}
  • Operation is no longer Added in 2.1.0
  • Operation is now Generally available; Added in 2.1.0
GET /_cat/tasks
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 5.0.0
GET /_cat/templates
  • Operation is no longer Added in 5.2.0
  • Operation is now Generally available; Added in 5.2.0
GET /_cat/templates/{name}
  • Operation is no longer Added in 5.2.0
  • Operation is now Generally available; Added in 5.2.0
GET /_cat/thread_pool
  • Operation is now Generally available
GET /_cat/thread_pool/{thread_pool_patterns}
  • Operation is now Generally available
GET /_cat/transforms
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/geoip/stats
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ingest/ip_location/database
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_ingest/pipeline
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
GET /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
GET /_ingest/processor/grok
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_ingest/{index}/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_license
  • Operation is now Generally available
GET /_license/basic_status
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_license/trial_status
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_lifecycle/stats
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available; Added in 8.12.0
GET /_logstash/pipeline
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_mapping
  • Operation is now Generally available
GET /_mapping/field/{fields}
  • Operation is now Generally available
GET /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_migration/deprecations
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_migration/reindex/{index}/_status
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.18.0
GET /_migration/system_features
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
GET /_ml/anomaly_detectors
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_ml/anomaly_detectors/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_data_stream/{name}/_options
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available; Added in 8.19.0
GET /_data_stream/{name}/_stats
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_enrich/_stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cache_stats property Modified
        • Property is now Generally available; Added in 7.16.0
GET /_enrich/policy
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_eql/search/status/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_features
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
GET /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
GET /_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /_flush
  • Operation is now Generally available
GET /_health_report
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
GET /_health_report/{feature}
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available; Added in 8.7.0
GET /_ilm/policy
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_ilm/status
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /_index_template
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_inference
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /_info/{target}
  • Operation is no longer Added in 8.9.0
  • Operation is now Generally available; Added in 8.9.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • http property Modified
        • routes property Modified
          • Property is no longer Added in 8.12.0
          • Property is now Generally available; Added in 8.12.0
      • ingest property Modified
        • pipelines property Modified
GET /_ingest/_simulate
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.12.0
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
        • deprecated property Modified
          • Property is now Generally available; Added in 8.12.0
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/geoip/database
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/anomaly_detectors/{job_id}/_forecast
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/calendars/{calendar_id}/events/{event_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
DELETE /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
DELETE /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
DELETE /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
DELETE /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
DELETE /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
DELETE /_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
DELETE /_query/async/{id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
DELETE /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
DELETE /_scripts/{id}
  • Operation is now Generally available
DELETE /_search/scroll
  • Operation is now Generally available
DELETE /_search/scroll/{scroll_id}
  • Operation is now Generally available
DELETE /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
DELETE /_security/oauth2/token
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
DELETE /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
DELETE /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
DELETE /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
DELETE /_ccr/auto_follow/{name}
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
DELETE /_cluster/voting_config_exclusions
  • Operation is no longer Added in 7.0.0
  • Operation is now Generally available; Added in 7.0.0
DELETE /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
DELETE /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
DELETE /_connector/{connector_id}
  • Operation is now Beta; Added in 8.12.0
  • Operation is no longer beta
DELETE /_dangling/{index_uuid}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_data_stream/{name}/_options
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available; Added in 8.19.0
DELETE /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
DELETE /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
DELETE /_ilm/policy/{policy}
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
DELETE /_index_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
DELETE /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
DELETE /_ingest/geoip/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_ingest/ip_location/database/{id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
DELETE /_license
  • Operation is now Generally available
DELETE /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available; Added in 7.12.0
DELETE /_ml/_delete_expired_data
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_application/search_application
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_application/search_application/{name}
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_application/search_application/{name}/_search
  • Operation is now Beta; Added in 8.8.0
  • Operation is no longer beta
GET /_async_search/status/{id}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_autoscaling/capacity
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_autoscaling/policy/{name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_cat
  • Operation is now Generally available
GET /_cat/aliases
  • Operation is now Generally available
GET /_cat/aliases/{name}
  • Operation is now Generally available
GET /_cat/allocation
  • Operation is now Generally available
GET /_cat/allocation/{node_id}
  • Operation is now Generally available
GET /_cat/component_templates
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available; Added in 5.1.0
GET /_cat/component_templates/{name}
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available; Added in 5.1.0
GET /_cat/count
  • Operation is now Generally available
GET /_cat/count/{index}
  • Operation is now Generally available
GET /_cat/fielddata
  • Operation is now Generally available
GET /_cat/fielddata/{fields}
  • Operation is now Generally available
GET /_cat/health
  • Operation is now Generally available
GET /_cat/indices
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/indices/{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available; Added in 8.11.0
GET /_cat/master
  • Operation is now Generally available
GET /_cat/ml/anomaly_detectors
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
GET /_cat/ml/data_frame/analytics
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available; Added in 7.7.0
DELETE /_security/privilege/{application}/{name}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
DELETE /_security/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
DELETE /_security/role/{name}
  • Operation is now Generally available
DELETE /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_security/service/{namespace}/{service}/credential/token/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
DELETE /_security/user/{username}
  • Operation is now Generally available
DELETE /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
DELETE /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
DELETE /_snapshot/{repository}/{snapshot}
  • Operation is now Generally available
DELETE /_sql/async/delete/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
DELETE /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
DELETE /_template/{name}
  • Operation is now Generally available
DELETE /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
DELETE /_watcher/watch/{id}
  • Operation is now Generally available
DELETE /{index}
  • Operation is now Generally available
DELETE /{index}/_alias/{name}
  • Operation is now Generally available
DELETE /{index}/_aliases/{name}
  • Operation is now Generally available
DELETE /{index}/_doc/{id}
  • Operation is now Generally available
GET /
  • Operation is now Generally available
GET /_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_analyze
  • Operation is now Generally available
GET /_application/analytics
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
GET /_application/analytics/{name}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 8.8.0
GET /_slm/policy/{policy_id}
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
GET /_slm/stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_slm/status
  • Operation is no longer Added in 7.6.0
  • Operation is now Generally available; Added in 7.6.0
GET /_snapshot
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
GET /_snapshot/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_snapshot/{repository}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
GET /_snapshot/{repository}/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_snapshot/{repository}/{snapshot}
  • Operation is no longer Added in 0.0.0
  • Operation is now Generally available; Added in 0.0.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remaining, total properties Modified
        • Properties are now Generally available; Added in 7.15.0
      • responses property Modified
        • snapshots property Modified
      • snapshots property Modified
        • index_details property Modified
          • Property is now Generally available; Added in 7.13.0
GET /_snapshot/{repository}/{snapshot}/_status
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available; Added in 7.8.0
GET /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_sql/async/status/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /_sql/async/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_ssl/certificates
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_stats
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_stats/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_synonyms
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_tasks
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 2.3.0
GET /_tasks/{task_id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 5.0.0
GET /_template
  • Operation is now Generally available
GET /_template/{name}
  • Operation is now Generally available
GET /_text_structure/find_field_structure
  • Operation is now Generally available
GET /_text_structure/find_message_structure
  • Operation is now Generally available
GET /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_security/privilege/{application}/{name}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/profile/_has_privileges
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available; Added in 8.3.0
GET /_security/profile/_suggest
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_security/profile/{uid}
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_security/role
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
        • global property Modified
          • Property is now Generally available; Added in 8.0.0
GET /_security/role/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
        • global property Modified
          • Property is now Generally available; Added in 8.0.0
GET /_security/role_mapping
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_security/role_mapping/{name}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_security/saml/metadata/{realm_name}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
GET /_security/service
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}/credential
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_security/settings
  • Operation is now Generally available
GET /_security/user
  • Operation is now Generally available
GET /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/user/_privileges
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /_security/user/{username}
  • Operation is now Generally available
GET /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_segments
  • Operation is now Generally available
GET /_settings
  • Operation is now Generally available
GET /_settings/{name}
  • Operation is now Generally available
GET /_shard_stores
  • Operation is now Generally available
GET /_slm/policy
  • Operation is no longer Added in 7.4.0
  • Operation is now Generally available; Added in 7.4.0
GET /{index}/_field_usage_stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.15.0
GET /{index}/_fleet/_fleet_msearch
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_fleet/_fleet_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
GET /{index}/_fleet/global_checkpoints
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /{index}/_flush
  • Operation is now Generally available
GET /{index}/_graph/explore
  • Operation is now Generally available
GET /{index}/_ilm/explain
  • Operation is no longer Added in 6.6.0
  • Operation is now Generally available; Added in 6.6.0
GET /{index}/_lifecycle/explain
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available; Added in 8.11.0
GET /{index}/_mapping
  • Operation is now Generally available
GET /{index}/_mapping/field/{fields}
  • Operation is now Generally available
GET /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /{index}/_migration/deprecations
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_mtermvectors
  • Operation is now Generally available
GET /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
GET /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /{index}/_recovery
  • Operation is now Generally available
GET /{index}/_refresh
  • Operation is now Generally available
GET /{index}/_reload_search_analyzers
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /{index}/_rollup/data
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.4.0
GET /{index}/_rollup_search
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
GET /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /{index}/_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_text_structure/test_grok_pattern
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_transform
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
GET /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available; Added in 7.2.0
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available; Added in 8.5.0
GET /_transform/{transform_id}/_stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available; Added in 7.5.0
GET /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_watcher/_query/watches
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available; Added in 7.11.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_watcher/settings
  • Operation is now Generally available
GET /_watcher/stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_watcher/stats/{metric}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_watcher/watch/{id}
  • Operation is no longer Added in 5.6.0
  • Operation is now Generally available; Added in 5.6.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, condition properties Modified
GET /_xpack
  • Operation is now Generally available
GET /_xpack/usage
  • Operation is now Generally available
GET /{index}
  • Operation is now Generally available
GET /{index}/_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_analyze
  • Operation is now Generally available
GET /{index}/_ccr/info
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
GET /{index}/_ccr/stats
  • Operation is no longer Added in 6.5.0
  • Operation is now Generally available; Added in 6.5.0
GET /{index}/_count
  • Operation is now Generally available
GET /{index}/_doc/{id}
  • Operation is now Generally available
GET /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /{index}/_explain/{id}
  • Operation is now Generally available
GET /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • * property Modified
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
GET /_ml/datafeeds/{datafeed_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/filters
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/info
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available; Added in 6.3.0
GET /_ml/memory/_stats
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_ml/memory/{node_id}/_stats
  • Operation is no longer Added in 8.2.0
  • Operation is now Generally available; Added in 8.2.0
GET /_ml/trained_models
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_ml/trained_models/{model_id}/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available; Added in 8.4.0
GET /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available; Added in 5.0.0
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_mtermvectors
  • Operation is now Generally available
GET /_nodes
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_nodes/hot_threads
  • Operation is now Generally available
GET /_nodes/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_nodes/stats
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/stats/{metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/stats/{metric}/{index_metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/usage
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
GET /_nodes/usage/{metric}
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
GET /_nodes/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_nodes/{node_id}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_ml/anomaly_detectors/{job_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available; Added in 7.16.0
GET /_ml/anomaly_detectors/{job_id}/results/buckets
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/categories
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/categories/{category_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/influencers
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_ml/anomaly_detectors/{job_id}/results/records
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
GET /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_ml/data_frame/analytics
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ml/data_frame/analytics/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}/_explain
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_ml/data_frame/analytics/{id}/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
GET /_ml/datafeeds
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available; Added in 5.4.0
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available; Added in 7.9.0
GET /_ml/datafeeds/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
GET /_rollup/data/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_rollup/job
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_rollup/job/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_script_context
  • Operation is now Generally available
GET /_script_language
  • Operation is now Generally available
GET /_scripts/painless/_execute
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
GET /_scripts/{id}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • sparse_vector property Modified
        • text_expansion property Modified
          • Property is now Generally available; Added in 8.8.0
        • weighted_tokens property Modified
          • Property is now Generally available; Added in 8.13.0
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available; Added in 8.4.0
GET /_search/scroll
  • Operation is now Generally available
GET /_search/scroll/{scroll_id}
  • Operation is now Generally available
GET /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available; Added in 2.0.0
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_search_shards
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_searchable_snapshots/cache/stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.13.0
GET /_searchable_snapshots/stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available; Added in 7.10.0
GET /_searchable_snapshots/{node_id}/cache/stats
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.13.0
GET /_security/_authenticate
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available; Added in 5.5.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Modified
        • type property Modified
          • Property is now Generally available; Added in 7.14.0
GET /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available; Added in 7.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
GET /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices, global properties Modified
        • remote_indices property Modified
          • Property is now Generally available; Added in 8.14.0
        • remote_cluster property Modified
          • Property is now Generally available; Added in 8.15.0
GET /_security/_query/user
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available; Added in 8.14.0
GET /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available; Added in 6.7.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, profile_uid properties Modified
          • Properties are now Generally available; Added in 8.14.0
        • role_descriptors, access properties Modified
        • limited_by property Modified
          • Property is now Generally available; Added in 8.5.0
GET /_security/enroll/kibana
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
GET /_security/enroll/node
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available; Added in 8.0.0
GET /_security/privilege
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_security/privilege/_builtin
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available; Added in 7.3.0
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remote_cluster property Modified
        • Property is now Generally available; Added in 8.15.0
GET /_security/privilege/{application}
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available; Added in 6.4.0
GET /_nodes/{node_id}/_repositories_metering
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 7.16.0
GET /_nodes/{node_id}/hot_threads
  • Operation is now Generally available
GET /_nodes/{node_id}/shutdown
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available; Added in 7.13.0
GET /_nodes/{node_id}/stats
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/stats/{metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/usage
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
GET /_nodes/{node_id}/usage/{metric}
  • Operation is no longer Added in 6.0.0
  • Operation is now Generally available; Added in 6.0.0
GET /_nodes/{node_id}/{metric}
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available; Added in 1.3.0
GET /_query/async/{id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_query/queries
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 9.1.0
GET /_query/queries/{id}
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 9.1.0
GET /_query_rules
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available; Added in 8.10.0
GET /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available; Added in 8.15.0
GET /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available; Added in 6.2.0
GET /_recovery
  • Operation is now Generally available
GET /_refresh
  • Operation is now Generally available
GET /_remote/info
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available; Added in 6.1.0
GET /_render/template
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_render/template/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_resolve/cluster
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_resolve/cluster/{name}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available; Added in 8.13.0
GET /_resolve/index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available; Added in 7.9.0
GET /_rollup/data
  • Operation is no longer Technical preview
  • Operation is now Technical preview; Added in 6.3.0
Added 2
PUT /_data_stream/{name}/_settings
GET /_data_stream/{name}/_settings
Elasticsearch Serverless API

This documentation update aligns with a release. Check out the release notes.

Note that there is also a widespread improvement to the way we describe the lifecycle of each API (removal of version details that are not applicable to Elasticsearch Serverless).

391 structure changes including:
2 Additions
389 Modifications
Modified 389
POST /{index}/_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
POST /_search/scroll
  • Operation is now Generally available
POST /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
POST /_scripts/{id}/{context}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_render/template/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_render/template
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_reindex
  • Operation is no longer Added in 2.3.0
  • Operation is now Generally available
POST /_refresh
  • Operation is now Generally available
POST /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
POST /_query_rules/{ruleset_id}/_test
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
POST /_query
  • Operation is now Generally available
POST /_mtermvectors
  • Operation is now Generally available
POST /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available
POST /_ml/trained_models/{model_id}/deployment/_update
  • Operation is no longer Added in 8.6.0
  • Operation is now Beta
POST /_ml/trained_models/{model_id}/deployment/_stop
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available
POST /_ml/trained_models/{model_id}/deployment/_start
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available
POST /_ml/trained_models/{model_id}/_infer
  • Operation is no longer Added in 8.3.0
  • Operation is now Generally available
POST /_ml/filters/{filter_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
POST /_ml/datafeeds/{datafeed_id}/_update
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
POST /_ml/datafeeds/{datafeed_id}/_stop
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /_ml/datafeeds/{datafeed_id}/_start
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
POST /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
POST /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
POST /{index}/_analyze
  • Operation is now Generally available
POST /{index}/_aliases/{name}
  • Operation is now Generally available
POST /{index}/_alias/{name}
  • Operation is now Generally available
POST /{alias}/_rollover/{new_index}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
POST /{alias}/_rollover
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
POST /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
POST /_transform/{transform_id}/_update
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • unattended property Modified
          • Property is now Generally available
POST /_transform/{transform_id}/_stop
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
POST /_transform/{transform_id}/_start
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
POST /_transform/{transform_id}/_schedule_now
  • Operation is no longer Added in 8.7.0
  • Operation is now Generally available
POST /_transform/{transform_id}/_reset
  • Operation is no longer Added in 8.1.0
  • Operation is now Generally available
POST /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
POST /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
POST /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available
POST /_sql/close
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available
POST /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available
POST /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
POST /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
POST /_security/role/{name}
  • Operation is now Generally available
POST /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available
POST /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
POST /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, limited_by, profile_uid properties Modified
          • Properties are now Generally available
POST /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /_search/scroll/{scroll_id}
  • Operation is now Generally available
POST /_ml/data_frame/analytics/{id}/_update
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
POST /_inference/chat_completion/{inference_id}/_stream
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available
POST /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
POST /_index_template/_simulate_index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
POST /_index_template/_simulate/{name}
  • Operation is now Generally available
POST /_index_template/_simulate
  • Operation is now Generally available
POST /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /_data_stream/_modify
  • Operation is no longer Added in 7.16.0
  • Operation is now Generally available
POST /_data_stream/_migrate/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
POST /_count
  • Operation is now Generally available
POST /_connector/_sync_job
  • Operation is now Beta
  • Operation is no longer beta
POST /_connector
  • Operation is now Beta
  • Operation is no longer beta
POST /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
POST /_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /_async_search
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
POST /_application/search_application/{name}/_search
  • Operation is now Beta
  • Operation is no longer beta
POST /_analyze
  • Operation is now Generally available
POST /_aliases
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
HEAD /{index}/_source/{id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
HEAD /{index}/_doc/{id}
  • Operation is now Generally available
HEAD /{index}/_alias/{name}
  • Operation is now Generally available
HEAD /{index}
  • Operation is now Generally available
HEAD /_index_template/{name}
  • Operation is now Generally available
HEAD /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
GET /_mapping
  • Operation is now Generally available
POST /_ml/data_frame/analytics/{id}/_stop
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
POST /_ml/data_frame/analytics/{id}/_start
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
POST /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
POST /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
POST /_ml/data_frame/_evaluate
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
POST /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
POST /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
POST /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/{job_id}/_update
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
POST /_ml/anomaly_detectors/{job_id}/_reset
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/{job_id}/_open
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/{job_id}/_flush
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/{job_id}/_close
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /_ml/anomaly_detectors/_estimate_model_memory
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
POST /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
POST /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
POST /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
POST /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /_inference/text_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /_inference/sparse_embedding/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /_inference/rerank/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /_inference/completion/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
PUT /{index}/_settings
  • Operation is now Generally available
PUT /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
PUT /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
PUT /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
PUT /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
PUT /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • model_plot_config property Modified
      • annotations_enabled property Modified
        • Property is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
PUT /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available
PUT /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{watsonx_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{voyageai_inference_id}
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{openai_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{mistral_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{jinaai_inference_id}
  • Operation is no longer Added in 8.18.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{huggingface_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • service_settings property Modified
      • model_id property Added
PUT /_inference/{task_type}/{googlevertexai_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{googleaistudio_inference_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{elser_inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{elasticsearch_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{cohere_inference_id}
  • Operation is no longer Added in 8.13.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{azureopenai_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{azureaistudio_inference_id}
  • Operation is no longer Added in 8.14.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{anthropic_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{amazonbedrock_inference_id}
  • Operation is no longer Added in 8.12.0
  • Operation is now Generally available
PUT /_inference/{task_type}/{alibabacloud_inference_id}
  • Operation is no longer Added in 8.16.0
  • Operation is now Generally available
PUT /{index}/_mapping
  • Operation is now Generally available
PUT /{index}/_doc/{id}
  • Operation is now Generally available
PUT /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
PUT /{index}/_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /{index}/_block/{block}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
PUT /{index}/_aliases/{name}
  • Operation is now Generally available
PUT /{index}/_alias/{name}
  • Operation is now Generally available
PUT /{index}
  • Operation is now Generally available
PUT /_transform/{transform_id}
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
PUT /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
PUT /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
PUT /_settings
  • Operation is now Generally available
PUT /_security/role/{name}
  • Operation is now Generally available
PUT /_security/api_key/{id}
  • Operation is no longer Added in 8.4.0
  • Operation is now Generally available
PUT /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • encoded property Modified
        • Property is now Generally available
PUT /_scripts/{id}/{context}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
PUT /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
PUT /_ml/trained_models/{model_id}/vocabulary
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • merges, scores properties Modified
      • Properties are now Generally available
PUT /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
PUT /_ml/trained_models/{model_id}/definition/{part}
  • Operation is no longer Added in 8.0.0
  • Operation is now Generally available
PUT /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
PUT /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
PUT /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
POST /{index}/_termvectors/{id}
  • Operation is now Generally available
POST /{index}/_termvectors
  • Operation is now Generally available
POST /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available
POST /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
POST /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
POST /{index}/_refresh
  • Operation is now Generally available
POST /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
POST /{index}/_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
POST /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
POST /{index}/_mtermvectors
  • Operation is now Generally available
POST /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available
POST /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
POST /{index}/_mapping
  • Operation is now Generally available
POST /{index}/_graph/explore
  • Operation is now Generally available
POST /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
POST /{index}/_explain/{id}
  • Operation is now Generally available
POST /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
POST /{index}/_doc/{id}
  • Operation is now Generally available
POST /{index}/_doc
  • Operation is now Generally available
POST /{index}/_delete_by_query
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
POST /{index}/_create/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
POST /{index}/_count
  • Operation is now Generally available
POST /{index}/_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
PUT /_enrich/policy/{name}/_execute
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
PUT /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
PUT /_data_stream/{name}/_options
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available
PUT /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
PUT /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
PUT /_connector/{connector_id}/_service_type
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_scheduling
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_pipeline
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_native
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_name
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_index_name
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_filtering
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_configuration
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}/_api_key_id
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/{connector_id}
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel
  • Operation is now Beta
  • Operation is no longer beta
PUT /_connector
  • Operation is now Beta
  • Operation is no longer beta
PUT /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
PUT /_bulk
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /_application/search_application/{name}
  • Operation is now Beta
  • Operation is no longer beta
POST /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
POST /{index}/_update_by_query
  • Operation is no longer Added in 2.4.0
  • Operation is now Generally available
POST /{index}/_update/{id}
  • Operation is now Generally available
GET /_connector/{connector_id}
  • Operation is now Beta
  • Operation is no longer beta
GET /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta
  • Operation is no longer beta
GET /_connector/_sync_job
  • Operation is now Beta
  • Operation is no longer beta
GET /_connector
  • Operation is now Beta
  • Operation is no longer beta
GET /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_component_template
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • component_templates property Modified
        • component_template property Modified
GET /_cat/transforms/{transform_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/transforms
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/trained_models/{model_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available
GET /_cat/ml/trained_models
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Property is now Generally available
GET /_cat/ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/datafeeds
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/data_frame/analytics
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/ml/anomaly_detectors
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_cat/indices/{index}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available
GET /_cat/indices
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataset.size property Modified
        • string-1, string-2 alternatives Modified
          • Alternatives are no longer Added in 8.11.0
          • Alternatives are now Generally available
GET /_cat/count/{index}
  • Operation is now Generally available
GET /_cat/count
  • Operation is now Generally available
GET /_cat/component_templates/{name}
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available
GET /_cat/component_templates
  • Operation is no longer Added in 5.1.0
  • Operation is now Generally available
GET /_cat/aliases/{name}
  • Operation is now Generally available
GET /_cat/aliases
  • Operation is now Generally available
GET /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available
GET /_logstash/pipeline
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available
GET /_license
  • Operation is now Generally available
GET /_ingest/processor/grok
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available
GET /_ingest/pipeline/{id}/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
GET /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • redact, script, user_agent properties Modified
GET /_ingest/pipeline
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_info/{target}
  • Operation is no longer Added in 8.9.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest property Modified
        • pipelines property Modified
GET /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
GET /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
GET /_inference
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
GET /_index_template/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
GET /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
GET /_eql/search/status/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
GET /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
GET /_enrich/policy
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
GET /_data_stream/{name}/_options
  • Operation is no longer Added in 8.19.0
  • Operation is now Generally available
GET /_data_stream/{name}/_lifecycle
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
GET /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available
        • settings property Added
GET /_data_stream
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Modified
        • system property Modified
          • Property is now Generally available
        • settings property Added
GET /_count
  • Operation is now Generally available
DELETE /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
DELETE /_pit
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
DELETE /_ml/trained_models/{model_id}/model_aliases/{model_alias}
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
DELETE /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
DELETE /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
DELETE /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
DELETE /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
DELETE /_ml/calendars/{calendar_id}/events/{event_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
DELETE /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
DELETE /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
DELETE /_logstash/pipeline/{id}
  • Operation is no longer Added in 7.12.0
  • Operation is now Generally available
DELETE /_ingest/pipeline/{id}
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
DELETE /_inference/{task_type}/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
DELETE /_inference/{inference_id}
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
DELETE /_index_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
DELETE /_eql/search/{id}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
DELETE /_enrich/policy/{name}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
DELETE /_data_stream/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
DELETE /_connector/{connector_id}
  • Operation is now Beta
  • Operation is no longer beta
DELETE /_connector/_sync_job/{connector_sync_job_id}
  • Operation is now Beta
  • Operation is no longer beta
DELETE /_component_template/{name}
  • Operation is no longer Added in 7.8.0
  • Operation is now Generally available
DELETE /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
DELETE /_application/search_application/{name}
  • Operation is now Beta
  • Operation is no longer beta
GET /_cat
  • Operation is now Generally available
GET /_async_search/{id}
  • Operation is no longer Added in 7.7.0
  • Operation is now Generally available
GET /_async_search/status/{id}
  • Operation is no longer Added in 7.11.0
  • Operation is now Generally available
GET /_application/search_application/{name}/_search
  • Operation is now Beta
  • Operation is no longer beta
GET /_application/search_application/{name}
  • Operation is now Beta
  • Operation is no longer beta
GET /_application/search_application
  • Operation is now Beta
  • Operation is no longer beta
GET /_analyze
  • Operation is now Generally available
GET /_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /
  • Operation is now Generally available
DELETE /{index}/_doc/{id}
  • Operation is now Generally available
DELETE /{index}/_aliases/{name}
  • Operation is now Generally available
DELETE /{index}/_alias/{name}
  • Operation is now Generally available
DELETE /{index}
  • Operation is now Generally available
DELETE /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
DELETE /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
DELETE /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
DELETE /_sql/async/delete/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
DELETE /_security/role/{name}
  • Operation is now Generally available
DELETE /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available
DELETE /_search/scroll/{scroll_id}
  • Operation is now Generally available
DELETE /_search/scroll
  • Operation is now Generally available
DELETE /_scripts/{id}
  • Operation is now Generally available
DELETE /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
HEAD /_alias/{name}
  • Operation is now Generally available
GET /{index}/_count
  • Operation is now Generally available
GET /{index}/_analyze
  • Operation is now Generally available
GET /{index}/_alias/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}/_alias
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • aliases property Modified
GET /{index}
  • Operation is now Generally available
GET /_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
GET /_transform/{transform_id}/_stats
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
GET /_transform/{transform_id}/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
GET /_transform/{transform_id}
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_transform/_preview
  • Operation is no longer Added in 7.2.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • settings property Modified
      • unattended property Modified
        • Property is now Generally available
GET /_transform
  • Operation is no longer Added in 7.5.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transforms property Modified
        • settings property Modified
GET /_synonyms/{set_id}/{rule_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
GET /_synonyms/{id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
GET /_synonyms
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
GET /_sql/translate
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available
GET /_sql/async/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
GET /_sql/async/status/{id}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
GET /_sql
  • Operation is no longer Added in 6.3.0
  • Operation is now Generally available
GET /_settings/{name}
  • Operation is now Generally available
GET /_settings
  • Operation is now Generally available
GET /_security/user/{user}/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
GET /_security/user/_has_privileges
  • Operation is no longer Added in 6.4.0
  • Operation is now Generally available
GET /_security/role/{name}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • global property Modified
          • Property is now Generally available
GET /_security/role
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • global property Modified
          • Property is now Generally available
HEAD /
  • Operation is now Generally available
GET /{index}/_validate/query
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
GET /{index}/_termvectors/{id}
  • Operation is now Generally available
GET /{index}/_termvectors
  • Operation is now Generally available
GET /{index}/_terms_enum
  • Operation is no longer Added in 7.14.0
  • Operation is now Generally available
GET /{index}/_source/{id}
  • Operation is now Generally available
GET /{index}/_settings/{name}
  • Operation is now Generally available
GET /{index}/_settings
  • Operation is now Generally available
GET /{index}/_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /{index}/_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
GET /{index}/_refresh
  • Operation is now Generally available
GET /{index}/_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
GET /{index}/_mvt/{field}/{zoom}/{x}/{y}
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
GET /{index}/_mtermvectors
  • Operation is now Generally available
GET /{index}/_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available
GET /{index}/_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
GET /{index}/_mapping
  • Operation is now Generally available
GET /{index}/_lifecycle/explain
  • Operation is no longer Added in 8.11.0
  • Operation is now Generally available
GET /{index}/_graph/explore
  • Operation is now Generally available
GET /{index}/_field_caps
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
GET /{index}/_explain/{id}
  • Operation is now Generally available
GET /{index}/_eql/search
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
GET /{index}/_doc/{id}
  • Operation is now Generally available
GET /_ml/trained_models
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
GET /_ml/filters/{filter_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/filters
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/datafeeds/{datafeed_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/datafeeds/{datafeed_id}/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
GET /_ml/datafeeds/{datafeed_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/datafeeds/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/datafeeds/_preview
  • Operation is no longer Added in 5.4.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • job_config property Modified
      • model_plot_config property Modified
        • annotations_enabled property Modified
          • Property is now Generally available
GET /_ml/datafeeds
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics/{id}/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics/{id}/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics/{id}
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics/_stats
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics/_preview
  • Operation is no longer Added in 7.13.0
  • Operation is now Generally available
GET /_ml/data_frame/analytics
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
GET /_ml/calendars/{calendar_id}/events
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
GET /_ml/calendars/{calendar_id}
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
GET /_ml/calendars
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
GET /_ml/anomaly_detectors/{job_id}/results/overall_buckets
  • Operation is no longer Added in 6.1.0
  • Operation is now Generally available
GET /_ml/anomaly_detectors/{job_id}/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/anomaly_detectors/{job_id}
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_ml/anomaly_detectors/_stats
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
GET /_ml/anomaly_detectors
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • jobs property Modified
        • model_plot_config property Modified
GET /_mget
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
GET /_security/privilege/_builtin
  • Operation is no longer Added in 7.3.0
  • Operation is now Generally available
GET /_security/api_key
  • Operation is no longer Added in 6.7.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, limited_by, profile_uid properties Modified
          • Properties are now Generally available
GET /_security/_query/role
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
GET /_security/_query/api_key
  • Operation is no longer Added in 7.15.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • realm_type, limited_by, profile_uid properties Modified
          • Properties are now Generally available
GET /_security/_authenticate
  • Operation is no longer Added in 5.5.0
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Modified
        • type property Modified
          • Property is now Generally available
GET /_search/template
  • Operation is no longer Added in 2.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_search/scroll/{scroll_id}
  • Operation is now Generally available
GET /_search/scroll
  • Operation is now Generally available
GET /_search
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • text_expansion, weighted_tokens properties Modified
          • Properties are now Generally available
    • knn property Modified
      • array-2 alternative Modified
        • Alternative is now Generally available
GET /_scripts/{id}
  • Operation is now Generally available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_resolve/index/{name}
  • Operation is no longer Added in 7.9.0
  • Operation is now Generally available
GET /_render/template/{id}
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_render/template
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, knn properties Modified
GET /_refresh
  • Operation is now Generally available
GET /_rank_eval
  • Operation is no longer Added in 6.2.0
  • Operation is now Generally available
GET /_query_rules/{ruleset_id}/_rule/{rule_id}
  • Operation is no longer Added in 8.15.0
  • Operation is now Generally available
GET /_query_rules/{ruleset_id}
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
GET /_query_rules
  • Operation is no longer Added in 8.10.0
  • Operation is now Generally available
GET /_mtermvectors
  • Operation is now Generally available
GET /_msearch/template
  • Operation is no longer Added in 5.0.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_msearch
  • Operation is no longer Added in 1.3.0
  • Operation is now Generally available
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • knn property Modified
        • array-2 alternative Modified
          • Alternative is now Generally available
GET /_ml/trained_models/{model_id}/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
GET /_ml/trained_models/{model_id}
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
GET /_ml/trained_models/_stats
  • Operation is no longer Added in 7.10.0
  • Operation is now Generally available
Added 2
PUT /_data_stream/{name}/_settings
GET /_data_stream/{name}/_settings
Kibana Serverless API

This documentation update aligns with a release. Check out the release notes.

40 structure changes including:
19 Additions
21 Modifications
Modified 21 Breaking
DELETE /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • entity property Added
GET /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Added
GET /api/asset_criticality/list
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • entity property Added
GET /api/dashboards/dashboard/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
GET /api/fleet/agents
  • Query
  • showAgentless query parameter Added
GET /api/fleet/remote_synced_integrations/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • install_status, warning properties Added
      • warning property Added
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • install_status, warning properties Added
      • warning property Added
POST /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • genai_openai_other_config alternative Added
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
      • defender_secrets alternative Added
POST /api/actions/connector/{id}/_execute
  • Body
  • application/json content type Modified
    • params property Modified
      • run_getagentdetails, run_getagents alternatives Added
POST /api/alerting/rule/{id}/snooze_schedule
  • Operation is now Generally available
POST /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Added
POST /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
POST /api/detection_engine/rules/_bulk_action
  • Body
  • application/json content type Modified
    • Security_Detections_API_BulkDeleteRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDisableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEnableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkExportRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDuplicateRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkManualRuleRun alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEditRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
POST /api/fleet/epm/custom_integrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Modified
        • name property Added
POST /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/gzip; application/zip content type Modified
      • _meta property Modified
        • name property Added
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Modified
        • name property Added
PUT /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • defender_config alternative Added
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
PUT /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
PUT /api/streams/{name}
  • Body
  • application/json content type Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
PUT /api/streams/{name}/_ingest
  • Body
  • application/json content type Modified
    • ingest property Modified
      • object-2 alternative Modified
        • processing property Modified
        • unwired property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • wired property Added
      • object-2 alternative Modified
        • processing property Modified
DELETE /api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}
  • Operation is now Generally available
Added 19
DELETE /api/entity_analytics/monitoring/users/{id}
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastream_assets
DELETE /api/maintenance_window/{id}
GET /api/entity_analytics/monitoring/users/list
GET /api/entity_analytics/monitoring/users/{id}
GET /api/fleet/epm/packages/_bulk_uninstall/{taskId}
GET /api/fleet/epm/packages/_bulk_upgrade/{taskId}
GET /api/maintenance_window/{id}
PATCH /api/maintenance_window/{id}
POST /api/entity_analytics/monitoring/users
POST /api/entity_analytics/monitoring/users/_csv
POST /api/entity_analytics/monitoring/users/_json
POST /api/fleet/agents/{agentId}/migrate
POST /api/fleet/epm/packages/_bulk_uninstall
POST /api/fleet/epm/packages/_bulk_upgrade
POST /api/maintenance_window
POST /api/maintenance_window/{id}/_archive
POST /api/maintenance_window/{id}/_unarchive
PUT /api/entity_analytics/monitoring/users/{id}
16 structure changes including:
6 Additions
10 Modifications
Modified 10 Breaking
GET /api/dashboards/dashboard/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
POST /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • genai_openai_other_config alternative Added
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
POST /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object-1, object-2 alternatives Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
POST /api/detection_engine/rules/_bulk_action
  • Body
  • application/json content type Modified
    • Security_Detections_API_BulkDeleteRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDisableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEnableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkExportRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDuplicateRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkManualRuleRun alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEditRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
POST /api/synthetics/monitors
  • Body
  • application/json content type Modified
    • Synthetics_browserMonitorFields alternative Modified
      • labels property Added
    • Synthetics_httpMonitorFields alternative Modified
      • labels property Added
    • Synthetics_icmpMonitorFields alternative Modified
      • labels property Added
    • Synthetics_tcpMonitorFields alternative Modified
      • labels property Added
PUT /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
PUT /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object-1, object-2 alternatives Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
PUT /api/streams/{name}
  • Body
  • application/json content type Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
PUT /api/streams/{name}/_ingest
  • Body
  • application/json content type Modified
    • ingest property Modified
      • object-2 alternative Modified
        • processing property Modified
        • unwired property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • wired property Added
      • object-2 alternative Modified
        • processing property Modified
PUT /api/synthetics/monitors/{id}
  • Body
  • application/json content type Modified
    • Synthetics_browserMonitorFields alternative Modified
      • labels property Added
    • Synthetics_httpMonitorFields alternative Modified
      • labels property Added
    • Synthetics_icmpMonitorFields alternative Modified
      • labels property Added
    • Synthetics_tcpMonitorFields alternative Modified
      • labels property Added
Added 6
GET /api/fleet/epm/packages/_bulk_uninstall/{taskId}
GET /api/fleet/epm/packages/_bulk_upgrade/{taskId}
GET /api/fleet/remote_synced_integrations/status
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
POST /api/fleet/epm/packages/_bulk_uninstall
POST /api/fleet/epm/packages/_bulk_upgrade
Elasticsearch API

The breaking changes in this change summary that relate to index settings reflect a change the documentation, not in the behaviour of the APIs. The index settings documentation is the source of truth for those values and the API documentation now links to it.

121 structure changes including:
121 Modifications
Modified 121 Breaking
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_cluster/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_cluster/stats/nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
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 /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties 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 /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ml/memory/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ml/memory/{node_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_nodes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/_repositories_metering
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_scripts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
GET /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_security/service/{namespace}/{service}/credential
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes_credentials property Modified
        • _nodes property Modified
GET /_security/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • security property Modified
        • index property Added
      • security-profile property Modified
        • index property Added
      • security-tokens property Modified
        • index property Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_slm/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_stats property Modified
        • Type went from array[string] to array[object]
          Breaking
        • SnapshotPolicyStats property Added
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Added
GET /_watcher/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, condition properties Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
GET /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
POST /_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
POST /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
POST /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
POST /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_nodes/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_nodes/{node_id}/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
POST /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_security/api_key/{ids}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/privilege/{application}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/realm/{realms}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Added
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
POST /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
POST /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
PUT /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
PUT /_connector/{connector_id}/_error
  • Body
  • application/json content type Modified
    • error property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_index_name
  • Body
  • application/json content type Modified
    • index_name property Modified
      • NullValue alternative Modified
        • Alternative is now required
PUT /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
PUT /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_security/settings
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Added
    • security-profile property Modified
      • index property Added
    • security-tokens property Modified
      • index property Added
PUT /_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • mode, soft_deletes, sort, number_of_routing_shards, check_on_startup, codec, load_fixed_bitset_filters_eagerly, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, uuid, version, max_slices_per_scroll, translog, query_string, top_metrics_max_size, analysis, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • routing_path property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, array-2 properties Removed
      • 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
      • routing_partition_size property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • Stringifiedinteger, Stringifiedinteger properties Removed
      • hidden property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • auto_expand_replicas property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, NullValue properties Removed
      • creation_date property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • UnitMillis, StringifiedEpochTimeUnitMillis properties Removed
      • creation_date_string property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • DateTime, UnitMillis properties Removed
      • verified_before_close property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • format property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, number-2 properties Removed
      • priority property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
Elasticsearch API
94 structure changes including:
3 Additions
91 Modifications
Modified 91 Breaking
PUT /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_nodes/{node_id}/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_nodes/reload_secure_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
POST /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
PUT /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /{index}/_fleet/_fleet_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /{index}/_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • actions property Modified
      • * property Modified
        • condition, transform properties Modified
    • condition property Modified
      • script property Modified
        • source property Modified
POST /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • actions property Modified
        • * property Modified
      • condition property Modified
        • script property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch_record property Modified
        • condition property Modified
POST /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/role/{name}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/realm/{realms}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/privilege/{application}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
POST /_security/api_key/{ids}/_clear_cache
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /_ml/memory/{node_id}/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ml/memory/_stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • pipeline_substitutions property Modified
      • * property Modified
        • on_failure property 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 /_fleet/_fleet_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties 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 /_cluster/stats/nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_cluster/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/watch/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watch property Modified
        • actions, condition properties Modified
GET /_watcher/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_watcher/_query/watches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • watches property Modified
        • watch property Modified
GET /_slm/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_stats property Modified
        • Type went from array[string] to array[object]
          Breaking
        • SnapshotPolicyStats property Added
GET /_security/service/{namespace}/{service}/credential
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes_credentials property Modified
        • _nodes property Modified
GET /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /_scripts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_nodes/{node_id}/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/stats
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}/_repositories_metering
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
GET /_nodes/usage
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _nodes property Modified
        • failures property Modified
Added 3
PUT /_data_stream/{name}/_options
GET /_data_stream/{name}/_options
DELETE /_data_stream/{name}/_options
Elasticsearch Serverless API

Check out the latest release notes.

64 structure changes including:
2 Additions
62 Modifications
Modified 62 Breaking
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
POST /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /{index}/_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
POST /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
POST /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
POST /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
POST /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
PUT /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
PUT /_connector/{connector_id}/_error
  • Body
  • application/json content type Modified
    • error property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_index_name
  • Body
  • application/json content type Modified
    • index_name property Modified
      • NullValue alternative Modified
        • Alternative is now required
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
PUT /_scripts/{id}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_scripts/{id}/{context}
  • Body
  • application/json content type Modified
    • script property Modified
      • source property Modified
        • SearchRequestBody alternative Modified
PUT /_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}/_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • IndexSettings 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 /_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 /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure property Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • script property Modified
GET /_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /_render/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_render/template/{id}
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /_scripts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • script property Modified
        • source property Modified
GET /_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
POST /_bulk
  • Body
  • application/json content type Modified
    • UpdateAction alternative Modified
      • script property Modified
        • source property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • * property Modified
POST /_async_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_search/template
  • Body
  • application/json content type Modified
    • source property Modified
      • SearchRequestBody alternative Modified
        • collapse model Modified
        • highlight, retriever properties Modified
GET /{index}/_search
  • Body
  • application/json content type Modified
    • highlight property Modified
      • highlight_query property Modified
        • rule property Modified
      • fields property Modified
        • Combinator is now oneOf
        • fields alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, array-2 alternatives Added
GET /{index}/_msearch/template
  • Body
  • application/json content type Modified
    • TemplateConfig alternative Modified
      • source property Modified
        • SearchRequestBody alternative Modified
GET /{index}/_msearch
  • Body
  • application/json content type Modified
    • SearchRequestBody alternative Modified
      • collapse model Modified
      • highlight property Modified
        • highlight_query property Modified
        • fields property Modified
          • Combinator is now oneOf
      • retriever property Modified
        • standard, knn, rrf, text_similarity_reranker, rule properties Modified
        • rescorer, linear, pinned properties Added
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
Added 2
PUT /_data_stream/{name}/_options
GET /_data_stream/{name}/_options
Elasticsearch API

The breaking changes in this change summary reflect a change the documentation, not in the behaviour of the APIs. The index settings documentation is the source of truth for those values and the API documentation now links to it.

38 structure changes including:
38 Modifications
Modified 38 Breaking
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 /_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 /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
GET /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
GET /_security/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • security property Modified
        • index property Added
      • security-profile property Modified
        • index property Added
      • security-tokens property Modified
        • index property Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
GET /_watcher/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Added
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Added
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
POST /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Added
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
POST /_ingest/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
POST /_ingest/{index}/_simulate
  • Body
  • application/json content type Modified
    • component_template_substitutions property Modified
      • * property Modified
        • template property Modified
    • index_template_substitutions property Modified
      • * property Modified
        • template property Modified
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Added
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Added
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings, defaults properties Added
PUT /_connector/{connector_id}/_error
  • Body
  • application/json content type Modified
    • error property Modified
      • NullValue alternative Modified
        • Alternative is now required
          Breaking
PUT /_connector/{connector_id}/_index_name
  • Body
  • application/json content type Modified
    • index_name property Modified
      • NullValue alternative Modified
        • Alternative is now required
PUT /_create_from/{source}/{dest}
  • Body
  • application/json content type Modified
    • settings_override property Added
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Added
PUT /_security/settings
  • Body
  • application/json content type Modified
    • security property Modified
      • index property Added
    • security-profile property Modified
      • index property Added
    • security-tokens property Modified
      • index property Added
PUT /_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Added
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • mode, soft_deletes, sort, number_of_routing_shards, check_on_startup, codec, load_fixed_bitset_filters_eagerly, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, uuid, version, max_slices_per_scroll, translog, query_string, top_metrics_max_size, analysis, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • routing_path property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, array-2 properties Removed
      • 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
      • routing_partition_size property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • Stringifiedinteger, Stringifiedinteger properties Removed
      • hidden property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • auto_expand_replicas property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, NullValue properties Removed
      • creation_date property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • UnitMillis, StringifiedEpochTimeUnitMillis properties Removed
      • creation_date_string property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • DateTime, UnitMillis properties Removed
      • verified_before_close property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • boolean-1, string-2 properties Removed
      • format property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • string-1, number-2 properties Removed
      • priority property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
        • number-1, string-2 properties Removed
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • IndexSettings property Added
11 structure changes including:
7 Additions
4 Modifications
Modified 4 Breaking
GET /api/dashboards/dashboard/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
GET /api/fleet/agents
  • Query
  • showAgentless query parameter Added
POST /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
PUT /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
Added 7
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastream_assets
DELETE /api/maintenance_window/{id}
GET /api/maintenance_window/{id}
PATCH /api/maintenance_window/{id}
POST /api/maintenance_window
POST /api/maintenance_window/{id}/_archive
POST /api/maintenance_window/{id}/_unarchive
Kibana API

This update aligns with the Kibana 9.0.2 release. Check out the release notes.

3 structure changes including:
3 Modifications
Modified 3
POST /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • secrets property Modified
      • defender_secrets alternative Added
POST /api/actions/connector/{id}/_execute
  • Body
  • application/json content type Modified
    • params property Modified
      • run_getagentdetails, run_getagents alternatives Added
PUT /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • defender_config alternative Added