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

Nov 22, 2024

v8
Compare

API structure has changed

This documentation update aligns with 8.16.1, which has the following release notes: https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-8.16.1.html

14 structure changes including:
14 Modifications
Modified 14 Breaking
DELETE /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
GET /_autoscaling/capacity
  • Query
  • master_timeout query parameter Added
GET /_autoscaling/policy/{name}
  • Query
  • master_timeout query parameter 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 /_query_rules
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • rule_type_counts property Added
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
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 /_security/cross_cluster/api_key
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • allow_restricted_indices property Added
POST /{index}/_pit
  • Query
  • allow_partial_search_results query parameter Added
PUT /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
PUT /_security/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • allow_restricted_indices property Added