Check a document

HEAD /{index}/_doc/{id}

Checks if a specified document exists.

Path parameters

  • index string Required

    Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

  • id string Required

    Identifier of the document.

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, Elasticsearch refreshes all shards involved in the delete by query after the request completes.

  • routing string

    Target the specified primary 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 in the response.

  • _source_includes string | array[string]

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

  • stored_fields string | array[string]

    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.

  • version number

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

  • version_type string

    Specific version type: external, external_gte.

    Values are internal, external, external_gte, or force.

Responses

HEAD /{index}/_doc/{id} 
curl \
 -X HEAD http://api.example.com/{index}/_doc/{id}