Get multiple documents | Elasticsearch Serverless API

Get multiple documents Added in 1.3.0

GET /_mget

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

Query parameters

preference string

Specifies the node or shard the operation should be performed on. Random by default.
realtime boolean

If true, the request is real-time as opposed to near-real-time.
refresh boolean

If true, the request refreshes relevant shards before retrieving documents.
routing string

Custom value used to route operations to a specific shard.
_source boolean | string | array[string]

True or false to return the _source field or not, or a list of fields to return.
_source_excludes string | array[string]

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.
_source_includes string | array[string]

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.
stored_fields string | array[string]

If true, retrieves the document fields stored in the index rather than the document _source.

application/json

Body Required

docs array[object]

The documents you want to retrieve. Required if no index is specified in the request URI.
Hide docs attributes Show docs attributes object
- _id string Required
- _index string
- routing string
- _source boolean | object
  
  Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
  
  One of:
  _types:SourceConfig boolean _types:SourceFilter object
- stored_fields string | array[string]
- version number
- version_type string
  
  Values are internal, external, external_gte, or force.
ids string | array[string]

One of:
_types:Id string _types:Ids array[string]

Responses

200 application/json
Hide response attribute Show response attribute object
- docs array[object] Required
  
  One of:
  get:GetResult object mget:MultiGetError object
  
  Hide attributes Show attributes
  
  _index string Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  _ignored array[string]
  
  found boolean Required
  
  _id string Required
  
  _primary_term number
  
  _routing string
  
  _seq_no number
  
  _source object
  
  Additional properties are allowed.
  
  _version number
  
  Hide attributes Show attributes
  
  error object Required
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in english
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Additional properties are allowed.
  
  root_cause array[object]
  
  Additional properties are allowed.
  
  suppressed array[object]
  
  Additional properties are allowed.
  
  _id string Required
  
  _index string Required

GET /_mget

curl \
 -X GET http://api.example.com/_mget \
 -H "Content-Type: application/json" \
 -d '{"docs":[{"_id":"string","_index":"string","routing":"string","":true,"stored_fields":"string","version":42.0,"version_type":"internal"}],"":"string"}'

Get multiple documents Added in 1.3.0

Query parameters

Body Required

_source boolean | object

ids string | array[string]

Responses