WARNING: Version 1.4 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Return values
editReturn values
edit-
The
ok
return value has been removed from all response bodies as it added no useful information. -
The
found
,not_found
andexists
return values have been unified asfound
on all relevant APIs. -
Field values, in response to the
fields
parameter, are now always returned as arrays. A field could have single or multiple values, which meant that sometimes they were returned as scalars and sometimes as arrays. By always returning arrays, this simplifies user code. The only exception to this rule is whenfields
is used to retrieve metadata like therouting
value, which are always singular. Metadata fields are always returned as scalars.The
fields
parameter is intended to be used for retrieving stored fields, rather than for fields extracted from the_source
. That means that it can no longer be used to return whole objects and it no longer accepts the_source.fieldname
format. For these you should use the_source
_source_include
and_source_exclude
parameters instead. -
Settings, like
index.analysis.analyzer.default
are now returned as proper nested JSON objects, which makes them easier to work with programatically:{ "index": { "analysis": { "analyzer": { "default": xxx } } } }
You can choose to return them in flattened format by passing
?flat_settings
in the query string. -
The
analyze
API no longer supports the text response format, but does support JSON and YAML.