Release 8.8.1

This release contains the following fix:

• Added the psr/http-message ^2.0 support #1313 (this was supposed to be in 8.8.0)

Release 8.8.0

This release is compatible with the latest Elasticsearch 8.8.0.

• SearchHitIterators and SearchResponseIterator helpers revised with new version #1302

General changes

This release introduces 15 new APIs: 13 EXPERIMENTAL and 2 stable.

Specific changes per endpoints

search

Added the include_named_queries_score boolean parameter. Indicates whether hit.matched_queries
should be rendered as a map that includes the name of the matched query associated with its score
(true) or as an array containing the name of the matched queries (false)

Cluster.getComponentTemplate

Added include_defaults boolean parameters. Return all default configurations
for the component template (default: false)

Indices.deleteDataLifecycle (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_lifecycle.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-delete-lifecycle.html

Indices.explainDataLifecycle (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.explain_data_lifecycle.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/dlm-explain-lifecycle.html

Indices.getDataLifecycle (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-get-lifecycle.html

Indices.getDataStream

Added include_defaults boolean parameter. Return all relevant default configurations
for the data stream (default: false)

Indices.getIndexTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for the index template (default: false)

Indices.putDataLifecycle (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json
DOcumentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-put-lifecycle.html

Indices.simulateIndexTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for this index template simulation (default: false)

Indices.simulateTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for this template simulation (default: false)

Logstash.getPipeline

Make id parameter optional.

Ml.putTrainedModel

Added wait_for_completion boolean parameter. Whether to wait for all child operations
(e.g. model download) to complete, before returning or not. Default to false

Ml.startTrainedModelDeployment

Added deployment_id string parameter. The Id of the new deployment. Defaults to the
model_id if not set.

SearchApplication.delete (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html

SearchApplication.deleteBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html

SearchApplication.get (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.get.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html

SearchApplication.getBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.get_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html

SearchApplication.list (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html

SearchApplication.postBehavioralAnalyticsEvent (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.post_behavioral_analytics_event.json
Documentation: TBD

SearchApplication.put (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html

SearchApplication.putBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html

SearchApplication.search (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.search.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html

Transform.deleteTransform

Added delete_dest_index boolean parameter. When true, the destination index is deleted together
with the transform. The default value is false, meaning that the destination index will not be deleted.

Watcher.getSettings (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.get_settings.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html

Watcher.updateSettings (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.update_settings.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html

Release 7.17.2

This release contains the following fix:

• Added ELASTIC_CLIENT_URL_PLUS_AS_SPACE env variable for URL encode #1303 and b35ec5e

Release 8.7.0

This release is compatible with the latest Elasticsearch 8.7.0.

• Allow plugin for php-http/discovery library #1294

General changes

This release introduces 2 new APIs.

Specific changes per endpoints

healthReport (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/health_report.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html

Transform.scheduleNowTransform (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html

Ml.deleteJob

Added the delete_user_annotations boolean parameter. Should annotations added by the user be deleted

Ml.resetJob

Added the delete_user_annotations boolean parameter. Should annotations added by the user be deleted

Transform.getTransformStats

Added the timeout time parameter. Controls the time to wait for the stats

Transform.startTransform

Added the from string parameter. Restricts the set of transformed entities to those changed after this time

Release 8.6.1

This release is compatible with the latest Elasticsearch 8.6.0.

General changes

This release introduces 1 new API.

Specific changes per endpoints

Ml.startTrainedModelDeployment

Added the priority string paramter. The deployment priority.

Ml.updateTrainedModelDeployment (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html

Release 8.5.0

This release is compatible with the latest Elasticsearch 8.5.0.

General changes

This release introduces 1 experimental new API and 2 stable APIs.

Specific changes per endpoints

Indices.downsample (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/indices.downsample.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html

Ml.clearTrainedModelDeploymentCache (new API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/ml.clear_trained_model_deployment_cache.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html

Ml.inferTrainedModel

This API is now stable.

Ml.putTrainedModelDefinitionPart

This API is now stable.

Ml.putTrainedModelVocabulary

This API is now stable.

Ml.startTrainedModelDeployment

This API is now stable. The descript of the number_of_allocations has been changed in "The total number of allocations this model is assigned across machine learning nodes".

Ml.stopTrainedModelDeployment

This API is now stable.

Rollup.rollup

This experimental API has been removed.

Security.activateUserProfile

This API is now stable.

Security.bulkUpdateApiKeys (new API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/security.bulk_update_api_keys.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html

Security.disableUserProfile

This API is now stable.

Security.enableUserProfile

This API is now stable.

Security.getApiKey

Added the with_limited_by boolean parameter. Flag to show the limited-by role descriptors of API Keys.

Security.getUser

Added the with_profile_uid boolean parameter. Flag to retrieve profile uid (if exists) associated to the user.

Security.getUserProfile

This API is now stable. Changed the description of uid parameter, a comma-separated list of unique identifier for user profiles.

Security.hasPrivilegesUserProfile

This API is now stable.

Security.queryApiKeys

Added the with_limited_by boolean parameter. Flag to show the limited-by role descriptors of API Keys.

Security.suggestUserProfiles

This API is now stable.

Security.updateUserProfileData

This API is now stable.

TextStructure.findStructure

Added the ecs_compatibility string parameter. Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'.

Release 7.17.1

This release contains the following fix:

• Fixed a node selector issue for StickyRoundRobinSelector #1253

Release 8.4.0

This release is compatible with the latest Elasticsearch 8.4.0 and includes the following changes:

• Added a ClientInterface to simplify the mock of the Client, this is a fix for #1227
  #1249
• Added the support of Symfony HTTP client, fixing the issue #1241
  #1243
• Added the API compatibility header
  #1233

Added the following new API 🎉

Stable

• Security.updateApiKey: api spec, documentation

API changes

get

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

mget

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

search

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

Ml.startTrainedModelDeployment

Added cache_size parameter (string). A byte-size value for configuring the inference cache size. For example, 20mb.

Snapshot.get

Added the following parameters:

• sort (enum), allows setting a sort order for the result. Defaults to start_time;
• size (integer), maximum number of snapshots to return. Defaults to 0 which means return all that match without limit;
• order (enum), soprt order;
• from_sort_value (string), value of the current sort column at which to start retrieval;
• after (string), offset identifier to start pagination from as returned by the 'next' field in the response body;
• offset (integer), numeric offset to start pagination based on the snapshots matching the request. Defaults to 0;
• slm_policy_filter (string), filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy.

Release 8.3.0

This release is compatible with the latest Elasticsearch 8.3.0.

Added the following new API 🎉

Experimental

• Security.hasPrivilegesUserProfile: api spec, documentation

API changes

Cluster.deleteVotingConfigExclusions

Added master_timeout parameter (time). Timeout for submitting request to master.

Cluster.postVotingConfigExclusions

Added master_timeout parameter (time). Timeout for submitting request to master.

Ml.inferTrainedModel (renamed)

The Ml.inferTrainedModelDeployment API has been renamed in Ml.inferTrainedModel.

Ml.previewDatafeed

Added the following optional parameters:

• start: string, the start time from where the datafeed preview should begin;
• end: string, the end time when the datafeed preview should stop.

Ml.startTrainedModelDeployment

Added the following optional parameters:

• number_of_allocations: int, the number of model allocations on each node where the model is deployed;
• threads_per_allocation: int, the number of threads used by each model allocation during inference;
• queue_capacity: int, controls how many inference requests are allowed in the queue at a time.

Snapshot.get

Added the index_names parameter (boolean). Whether to include the name of each index in the snapshot. Defaults to true.

Release 8.2.1

This release is compatible with the latest Elasticsearch 8.2.1.