Change Updates

Do not miss any Elasticsearch API changes, ever again

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

RSS

16 days ago

main
Compare

API structure has changed

57 structure changes including:
57 Modifications
Modified 57 Breaking
GET /_alias
  • Query
  • master_timeout query parameter Added
GET /_alias/{name}
  • Query
  • master_timeout query parameter Added
GET /_async_search/status/{id}
  • Query
  • keep_alive query parameter 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 /_health_report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indicators property Modified
        • file_settings property Added
GET /_health_report/{feature}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indicators property Modified
        • file_settings property Added
GET /_index_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cluster_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • index_settings property Modified
        • * property Modified
      • data_streams property Modified
        • * property Modified
      • node_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • ml_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
GET /_nodes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_nodes/{node_id}/{metric}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nodes property Modified
        • * property Modified
GET /_security/_authenticate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_key property Modified
        • name property Modified
          • Property is no longer required
        • creation, expiration, invalidated, realm, realm_type, username, profile_uid, metadata, role_descriptors, limited_by, _sort properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
GET /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
GET /_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
GET /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
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
        • trigger property Modified
GET /{index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_alias
  • Query
  • master_timeout query parameter Added
GET /{index}/_alias/{name}
  • Query
  • master_timeout query parameter Added
GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cluster_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • index_settings property Modified
        • * property Modified
      • data_streams property Modified
        • * property Modified
      • node_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
      • ml_settings property Modified
        • details property Modified
          • Property is no longer required
        • resolve_during_rolling_upgrade, _meta properties Added
GET /{index}/_settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
GET /{index}/_settings/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • settings, defaults properties Modified
HEAD /_alias/{name}
  • Query
  • master_timeout query parameter Added
HEAD /{index}/_alias/{name}
  • Query
  • master_timeout query parameter Added
POST /_async_search
  • Query
  • keep_alive, pre_filter_shard_size, scroll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
      • defaults property Modified
        • mapping property Modified
POST /_index_template/_simulate
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_index_template/_simulate/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_index_template/_simulate_index/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • template property Modified
        • settings property Modified
POST /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • _types:UnitMillis property Modified
          • Name is no longer creation
            Breaking
        • _types:UnitMillis property Modified
          • Name is no longer expiration
            Breaking
        • invalidated, username, realm, metadata properties Modified
          • Properties are now required
            Breaking
        • type, _types:UnitMillis, access properties Added
POST /_snapshot/{repository}/{snapshot}/_restore
  • Body
  • application/json content type Modified
    • index_settings property Modified
      • mapping property Modified
        • total_fields property Modified
POST /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
POST /_transform/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
POST /_transform/{transform_id}/_preview
  • Response
  • 200 response Modified
    • application/json content type Modified
      • generated_dest_index property Modified
        • settings, defaults properties Modified
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
      • trigger property Modified
        • schedule property Modified
POST /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
POST /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
POST /{index}/_async_search
  • Query
  • keep_alive, pre_filter_shard_size, scroll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /_component_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
      • defaults property Modified
        • mapping property Modified
PUT /_index_template/{name}
  • Body
  • application/json content type Modified
    • template property Modified
      • settings property Modified
        • mapping property Modified
PUT /_settings
  • Body
  • application/json content type Modified
    • mapping property Modified
      • total_fields property Modified
        • limit, ignore_dynamic_beyond_limit properties Modified
          • Combinator is now oneOf
PUT /_template/{name}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /_watcher/watch/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
PUT /_watcher/watch/{id}
  • Body
  • application/json content type Modified
    • trigger property Modified
      • schedule property Modified
        • timezone property Added
PUT /_watcher/watch/{id}/_execute
  • Body
  • application/json content type Modified
    • watch property Modified
      • trigger property Modified
        • schedule property Modified
PUT /{index}
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /{index}/_ccr/follow
  • Body
  • application/json content type Modified
    • settings property Modified
      • mapping property Modified
        • total_fields property Modified
PUT /{index}/_settings
  • Body
  • application/json content type Modified
    • mapping property Modified
      • total_fields property Modified
        • limit, ignore_dynamic_beyond_limit properties Modified
          • Combinator is now oneOf