Check a document

HEAD /{index}/_doc/{id}

Copy endpoint

Verify that a document exists. For example, check to see if a document with the _id 0 exists:

HEAD my-index-000001/_doc/0

If the document exists, the API returns a status code of 200 - OK. If the document doesn’t exist, the API returns 404 - Not Found.

Versioning support

You can use the version parameter to check the document only if its current version is equal to the specified one.

Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. The old version of the document doesn't disappear immediately, although you won't be able to access it. Elasticsearch cleans up deleted documents in the background as you continue to index more data.

Parameters

path Path Parameters

Name	Type
`index` required A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`).	type TypesIndexName = string
`id` required A unique document identifier.	type TypesId = string

query Query Parameters

Name	Type
`preference` The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.	string
`realtime` If `true`, the request is real-time as opposed to near-real-time.	boolean
`refresh` 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).	boolean
`routing` A custom value used to route operations to a specific shard.	type TypesRouting = string[] \| string
`_source` Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.	type GlobalSearchTypesSourceConfigParam = type TypesFields = type TypesField = string \| type TypesField = string[] \| boolean
`_source_excludes` 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. If the `_source` parameter is `false`, this parameter is ignored.	type TypesFields = type TypesField = string \| type TypesField = string[]
`_source_includes` 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.	type TypesFields = type TypesField = string \| type TypesField = string[]
`stored_fields` A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`.	type TypesFields = type TypesField = string \| type TypesField = string[]
`version` Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.	type TypesVersionNumber = number
`version_type` The version type.	type TypesVersionType = "internal" \| "external" \| "external_gte"

Responses

200 application/json

unknown