Path parameters

  • indexstring Required

    The name of the index that contains the document.

  • idstring Required

    A unique document identifier.

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.

  • stored_fieldsstring | array[string]

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

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

    Values are internal, external, external_gte, or force.

Responses

  • 200 application/json
GET /{index}/_source/{id}
GET my-index-000001/_source/1

resp = client.get_source(
    index="my-index-000001",
    id="1",
)
const response = await client.getSource({
  index: "my-index-000001",
  id: 1,
});
response = client.get_source(
  index: "my-index-000001",
  id: "1"
)
$resp = $client->getSource([
    "index" => "my-index-000001",
    "id" => "1",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index-000001/_source/1"