Check for a document source

Auth

Check whether a document source exists in an index. For example:

HEAD my-index-000001/_source/1

A document's source is not available if it is disabled in the mapping.

Learn more about _source field

Required privileges

Index privileges read

Path parameters

index string required

A comma-separated list of data streams, indices, and aliases. It supports wildcards (*).

id string required

A unique identifier for the document.

Query parameters

preference string

The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.

realtime boolean · default: true

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

refresh boolean · default: false

If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).

routing union string | string[]

A custom value used to route operations to a specific shard.

_source union oneOf

Indicates whether to return the _source field (true or false) or lists the fields to return.

One of: boolean or string
_source_excludes union string | string[]

A comma-separated list of source fields to exclude in the response.

_source_includes union string | string[]

A comma-separated list of source fields to include in the response.

version number

The version number for concurrency control. It must match the current version of the document for the request to succeed.

version_type enum

The version type.

Supported values include:

  • internal: Use internal versioning that starts at 1 and increments with each update or delete.
  • external: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.
  • external_gte: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document. NOTE: The external_gte version type is meant for special use cases and should be used with care. If used incorrectly, it can result in loss of data.
Values: internal external external_gte

Response

200 application/json