Path parameters

• index string Required

  The name of the index that contains the document.

• id string Required

  A unique document identifier.

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

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

• refresh boolean

  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 string

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

• _source boolean | string | array[string]

  Indicates whether to return the _source field (true or false) or lists the 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]

  A comma-separated list of stored fields to return as part of a hit.

• version number

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

• version_type string

  The version type.

  Values are internal, external, external_gte, or force.

Responses

• 200 application/json