Release 8.12.0

This release is compatible with the latest Elasticsearch 8.12.0.

This release has been tested with PHP 8.3, released on Nov 23, 2023.

• Added 22 new EXPERIMENTAL APIs and 1 new stable API:
  • bulk
    • Adds list_executed_pipelines boolean parameter. Sets list_executed_pipelines for all incoming documents. Defaults to unset (false).
  • indices.put_settings
    • Adds reopen boolean parameter. Whether to close and reopen the index to apply non-dynamic settings. If set to true the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is false.
  • open_point_in_time
    • Adds body object/Hash parameter. An index_filter specified with the Query DSL.
  • security.get_api_key
    • Adds active_only boolean parameter. Flag to limit response to only active (not invalidated or expired) API keys.
  • profiling.status (new API)
    • Returns basic information about the status of Universal Profiling.
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/profiling.status.json
    • Documentation: https://www.elastic.co/guide/en/observability/current/universal-profiling.html
  • simulate.ingest (new EXPERIMENTAL API)
    • Simulates running ingest with example documents.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/simulate-ingest-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/simulate.ingest.json
  • connector.post (new EXPERIMENTAL API)
    • Creates a connector.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.post.json
  • connector.put (new EXPERIMENTAL API)
    • Creates or updates a connector.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.put.json
  • connector.delete (new EXPERIMENTAL API)
    • Deletes a connector.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.delete.json
  • connector.get (new EXPERIMENTAL API)
    • Returns the details about a connector.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.get.json
  • connector.list (new EXPERIMENTAL API)
    • Lists all connectors.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.list.json
  • connector.check_in (new EXPERIMENTAL API)
    • Updates the last_seen timestamp in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.check_in.json
  • connector.update_configuration (new EXPERIMENTAL API)
    • Updates the connector configuration.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-configuration-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_configuration.json
  • connector.update_error (new EXPERIMENTAL API)
    • Updates the error field in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-error-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_error.json
  • connector.update_filtering (new EXPERIMENTAL API)
    • Updates the filtering field in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-filtering-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_filtering.json
  • connector.last_sync (new EXPERIMENTAL API)
    • Updates the stats of last sync in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-last-sync-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.last_sync.json
  • connector.update_name (new EXPERIMENTAL API)
    • Updates the name and/or description fields in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-name-description-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_name.json
  • connector.update_pipeline (new EXPERIMENTAL API)
    • Updates the pipeline field in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-pipeline-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_pipeline.json
  • connector.update_scheduling (new EXPERIMENTAL API)
    • Updates the scheduling field in the connector document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-scheduling-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_scheduling.json
  • connector_sync_job.cancel (new EXPERIMENTAL API)
    • Cancels a connector sync job.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cancel-connector-sync-job-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.cancel.json
  • connector_sync_job.check_in (new EXPERIMENTAL API)
    • Checks in a connector sync job (refreshes 'last_seen').
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-sync-job-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.check_in.json
  • connector_sync_job.delete (new EXPERIMENTAL API)
    • Deletes a connector sync job.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-sync-job-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.delete.json
  • connector_sync_job.error (new EXPERIMENTAL API)
    • Sets an error for a connector sync job.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-error-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.error.json
  • connector_sync_job.get (new EXPERIMENTAL API)
    • Returns the details about a connector sync job.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-sync-job-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.get.json
  • connector_sync_job.list (new EXPERIMENTAL API)
    • Lists all connector sync jobs.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-sync-jobs-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.list.json
  • connector_sync_job.post (new EXPERIMENTAL API)
    • Creates a connector sync job.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-sync-job-api.html
    • API: https://github.com/elastic/elasticsearch/blob/8.12/rest-api-spec/src/main/resources/rest-api-spec/api/connector_sync_job.post.json
  • connector_sync_job.update_stats (new EXPERIMENTAL API)
    • Updates the stats fields in the connector sync job document.
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-stats-api.html
    • API: https://github.com/ela

Release 8.11.0

This release is compatible with the latest Elasticsearch 8.11.0.

It includes the following fix:

• Fixed path in hosts configuration is ignored #1377

This release introduces 5 new EXPERIMENTAL APIs:

Esql.query (new EXPERIMENTAL API)

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

Inference.deleteModel (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete_model.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html

Inference.getModel (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.get_model.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html

Inference.inference (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.inference.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html

Inference.putModel (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_model.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html

Release 8.10.0

This release is compatible with the latest Elasticsearch 8.10.0.

Added 10 new APIs: 8 EXPERIMENTAL and 2 stable:

• QueryRuleset.list (new EXPERIMENTAL API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.list.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html
• Security.getSettings (new API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_settings.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html
• Security.updateSettings (new API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_settings.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html
• Synonyms.delete
  • Removed this API in favor of deleteSynonym.
• Synonyms.deleteSynonym (new EXPERIMENTAL API)
  • This API replaces Synonyms.delete. Removed synonyms_set in favor of id
    parameter (string). The id of the synonyms set to be deleted.
• Synonyms.deleteSynonymRule (new EXPERIMENTAL API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.delete_synonym_rule.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html
• Synonyms.get
  • Removed this function in favor of getSynonym.
• Synonyms.getSynonym (new EXPERIMENTAL API)
  • This API replaces Synonyms.getSynonym. Removed synonyms_set in favor of id
    required parameter (string). The name of the synonyms set to be retrieved.
• Synonyms.getSynonymRule (new EXPERIMENTAL API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.get_synonym_rule.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html
• Synonyms.getSynonymsSets (new EXPERIMENTAL API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.get_synonyms_sets.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html
• Synonyms.put
  • Removed this function in favor of putSynonym.
• Synonyms.putSynonym (new EXPERIMENTAL API)
  • This API replaces Synonyms.put. Removed synonyms_set in favor of id
    required parameter (string). The id of the synonyms set to be created or updated.
• Synonyms.putSynonymRule (new EXPERIMENTAL API)
  • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.put_synonym_rule.json
  • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html

Release 8.9.0

This release is compatible with the latest Elasticsearch 8.9.0.

• Fixed issue with psr/http-message, changed PSR-7 versions to 1.1 and 2.0 #1344
• Added 12 new APIs: 11 EXPERIMENTAL and 1 stable:
  • Cluster.info (new API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.info.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-info.html
  • QueryRuleset.delete (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.delete.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html
  • QueryRuleset.get (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.get.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html
  • QueryRuleset.put (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.put.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html
  • SearchApplication.renderQuery (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.render_query.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html
  • Security.createCrossClusterApiKey (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/security.create_cross_cluster_api_key.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html
  • Security.updateCrossClusterApiKey (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_cross_cluster_api_key.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html
  • SynonymRule.put (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/synonym_rule.put.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html
  • Synonyms.delete (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.delete.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms.html
  • Synonyms.get (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.get.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms.html
  • Synonyms.put (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms.put.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms.html
  • SynonymsSets.get (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/8.9/rest-api-spec/src/main/resources/rest-api-spec/api/synonyms_sets.get.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms.html

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'.