Path parameters

  • indexstring Required

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

  • idstring Required

    A unique identifier for the document.

Query parameters

  • preferencestring

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

  • realtimeboolean

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

  • refreshboolean

    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).

  • routingstring

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

  • _sourceboolean | string | array[string]

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

  • _source_excludesstring | array[string]

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

  • _source_includesstring | array[string]

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

  • versionnumber

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

  • version_typestring

    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.
    • force: This option is deprecated because it can cause primary and replica shards to diverge.

    Values are internal, external, external_gte, or force.

Responses

  • 200 application/json
HEAD /{index}/_source/{id}
curl \
 --request HEAD 'http://api.example.com/{index}/_source/{id}' \
 --header "Authorization: $API_KEY"