Releases: elastic/elasticsearch-php
Release 8.15.0
Release 8.14.0
This release is compatible with the latest Elasticsearch 8.14.0.
This release introduces 3 new APIs and 10 EXPERIMENTAL APIs.
- Specific changes per endpoints
Ccr.deleteAutoFollowPattern
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.follow
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.followInfo
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.followStats
- Added the
timeout
parameter (time), explicit operation timeout.
- Added the
Ccr.forgetFollower
- Added the
timeout
parameter (time), explicit operation timeout.
- Added the
Ccr.getAutoFollowPattern
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.pauseFollow
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.putAutoFollowPattern
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.resumeAutoFollowPattern
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.resumeFollow
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.stats
- Added the
timeout
parameter (time), explicit operation timeout. - Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
Ccr.unfollow
- Added the
master_timeout
parameter (time), explicit operation timeout for connection to master node.
- Added the
ConnectorSyncJob
- The APIs of
ConnectorSyncJob
has been removed and merged inConnector
namespace.
- The APIs of
Connector.delete
- Added the
delete_sync_jobs
parameter (boolean), determines whether associated sync jobs are also deleted.
- Added the
Connector.syncJobCancel
(new EXPERIMENTAL API)Connector.syncJobCheckIn
(new EXPERIMENTAL API)Connector.syncJobDelete
(new EXPERIMENTAL API)Connector.syncJobError
(new EXPERIMENTAL API)Connector.syncJobGet
(new EXPERIMENTAL API)Connector.syncJobList
(new EXPERIMENTAL API)Connector.syncJobPost
(new EXPERIMENTAL API)Connector.syncJobUpdateStats
(new EXPERIMENTAL API)Connector.updateActiveFiltering
(new EXPERIMENTAL API)Connector.updateFilteringValidation
(new EXPERIMENTAL API)Esql.asyncQuery
- This API is now stable.
Esql.query
- This API is now stable.
Indices.rollover
- Added the
target_failure_store
parameter (boolean), if set to true, the rollover action will be applied on the failure store of the data stream.
- Added the
Inference.getModel
- The
inference_id
is not anymore a required parameter.
- The
Profiling.topnFunctions
(new API)SearchApplication.search
- Added the
typed_keys
parameter (boolean), specify whether aggregation and suggester names should be prefixed by their respective types in the response.
- Added the
Security.getApiKey
- Added the
with_profile_uid
parameter (boolean), flag to also retrieve the API Key's owner profile uid, if it exists.
- Added the
Security.queryApiKeys
- Added the
with_profile_uid
parameter (boolean), flag to also retrieve the API Key's owner profile uid, if it exists. - Added the
typed_keys
paremeter (boolean), flag to prefix aggregation names by their respective types in the response.
- Added the
TextStructure.findFieldStructure
(new API)TextStructure.findMessageStructure
(new API)
Release 6.8.3
Release 8.13.0
This release is compatible with the latest Elasticsearch 8.13.0.
- Added the
mapTo($class)
function to Elasticsearch response for mapping the result of ES|QL
query to an object of stdClass or of a specific class #1398
This release introduces 6 new APIs and 6 EXPERIMENTAL APIs.
- Specific changes per endpoints
AsyncSearch.status
- Added the
keep_alive
parameter (time), specify the time interval in which the results (partial or final) for this search will be available.
- Added the
Connector.list
- Added the following parameters:
index_name
: list, a comma-separated list of connector index names to fetch connector documents for;connector_name
: list, a comma-separated list of connector names to fetch connector documents for;service_type
: list, a comma-separated list of connector service types to fetch connector documents for;query
: string, a search string for querying connectors, filtering results by matching against connector names, descriptions, and index names;
- Added the following parameters:
Connector.updateApiKeyId
(new EXPERIMENTAL API)Connector.updateIndexName
(new EXPERIMENTAL API)Connector.updateNative
(new EXPERIMENTAL API)Connector.updateServiceType
(new EXPERIMENTAL API)Connector.updateStatus
(new EXPERIMENTAL API)ConnectorSyncJob.list
- Added the
job_type
parameter (list), a comma-separated list of job types.
- Added the
Esql.asyncQuery
(new EXPERIMENTAL API)Esql.asyncQueryGet
(new API)Esql.query
- Added the
drop_null_columns
parameter (boolean) to sepcify if null columns should be removed from the results. If yes, their name and type will be returned in a newall_columns
section.
- Added the
Indices.resolveCluster
(new API)Indices.rollover
- Added the
lazy
parameter (boolean), if set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
- Added the
Inference.deleteModel
- The
model_id
parameter has been renamed toinference_id
.
- The
Inference.getModel
- The
model_id
parameter has been renamed ininference_id
.
- The
Inference.inference
- The
model_id
parameter has been renamed ininference_id
.
- The
Inference.putModel
- The
model_id
parameter has been renamed ininference_id
.
- The
Profiling.flamegraph
(new API)Profiling.stacktraces
(new API)Security.queryUser
(new API)Synonyms.deleteSynonym
- This API is now stable.
Synonyms.deleteSynonymRule
- This API is now stable.
Synonyms.getSynonym
- This API is now stable.
Synonyms.getSynonymRule
- This API is now stable.
Synonyms.getSynonymsSets
- This API is now stable.
Synonyms.putSynonym
- This API is now stable.
Synonyms.putSynonymRule
- This API is now stable.
TextStructure.testGrokPattern
(new API)
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. Setslist_executed_pipelines
for all incoming documents. Defaults to unset (false).
- Adds
indices.put_settings
- Adds
reopen
boolean parameter. Whether to close and reopen the index to apply non-dynamic settings. If set totrue
the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default isfalse
.
- Adds
open_point_in_time
- Adds
body
object/Hash parameter. An index_filter specified with the Query DSL.
- Adds
security.get_api_key
- Adds
active_only
boolean parameter. Flag to limit response to only active (not invalidated or expired) API keys.
- Adds
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)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)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)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)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)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)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)connector_sync_job.post
(new EXPERIMENTAL API)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)Security.getSettings
(new API)Security.updateSettings
(new API)Synonyms.delete
- Removed this API in favor of
deleteSynonym
.
- Removed this API in favor of
Synonyms.deleteSynonym
(new EXPERIMENTAL API)- This API replaces
Synonyms.delete
. Removedsynonyms_set
in favor ofid
parameter (string). The id of the synonyms set to be deleted.
- This API replaces
Synonyms.deleteSynonymRule
(new EXPERIMENTAL API)Synonyms.get
- Removed this function in favor of
getSynonym
.
- Removed this function in favor of
Synonyms.getSynonym
(new EXPERIMENTAL API)- This API replaces
Synonyms.getSynonym
. Removedsynonyms_set
in favor ofid
required parameter (string). The name of the synonyms set to be retrieved.
- This API replaces
Synonyms.getSynonymRule
(new EXPERIMENTAL API)Synonyms.getSynonymsSets
(new EXPERIMENTAL API)Synonyms.put
- Removed this function in favor of
putSynonym
.
- Removed this function in favor of
Synonyms.putSynonym
(new EXPERIMENTAL API)- This API replaces
Synonyms.put
. Removedsynonyms_set
in favor ofid
required parameter (string). The id of the synonyms set to be created or updated.
- This API replaces
Synonyms.putSynonymRule
(new EXPERIMENTAL API)
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)QueryRuleset.delete
(new EXPERIMENTAL API)QueryRuleset.get
(new EXPERIMENTAL API)QueryRuleset.put
(new EXPERIMENTAL API)SearchApplication.renderQuery
(new EXPERIMENTAL API)Security.createCrossClusterApiKey
(new EXPERIMENTAL API)Security.updateCrossClusterApiKey
(new EXPERIMENTAL API)SynonymRule.put
(new EXPERIMENTAL API)Synonyms.delete
(new EXPERIMENTAL API)Synonyms.get
(new EXPERIMENTAL API)Synonyms.put
(new EXPERIMENTAL API)SynonymsSets.get
(new EXPERIMENTAL API)
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