Get API

GET <index>/_doc/<_id>

HEAD <index>/_doc/<_id>

GET <index>/_source/<_id>

HEAD <index>/_source/<_id>

You use GET to retrieve a document and its source or stored fields from a particular index. Use HEAD to verify that a document exists. You can use the _source resource retrieve just the document source or verify that it exists.

By default, the get API is realtime, and is not affected by the refresh rate of the index (when data will become visible for search). In case where stored fields are requested (see stored_fields parameter) and the document has been updated but is not yet refreshed, the get API will have to parse and analyze the source to extract the stored fields. In order to disable realtime GET, the realtime parameter can be set to false.

By default, the get operation returns the contents of the _source field unless you have used the stored_fields parameter or if the _source field is disabled. You can turn off _source retrieval by using the _source parameter:

resp = client.get(
    index="my-index-000001",
    id="0",
    _source="false",
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 0,
  _source: false
)
puts response

GET my-index-000001/_doc/0?_source=false

If you only need one or two fields from the _source, use the _source_includes or _source_excludes parameters to include or filter out particular fields. This can be especially helpful with large documents where partial retrieval can save on network overhead. Both parameters take a comma separated list of fields or wildcard expressions. Example:

resp = client.get(
    index="my-index-000001",
    id="0",
    _source_includes="*.id",
    _source_excludes="entities",
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 0,
  _source_includes: '*.id',
  _source_excludes: 'entities'
)
puts response

GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities

If you only want to specify includes, you can use a shorter notation:

resp = client.get(
    index="my-index-000001",
    id="0",
    _source="*.id",
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 0,
  _source: '*.id'
)
puts response

GET my-index-000001/_doc/0?_source=*.id

If routing is used during indexing, the routing value also needs to be specified to retrieve a document. For example:

resp = client.get(
    index="my-index-000001",
    id="2",
    routing="user1",
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 2,
  routing: 'user1'
)
puts response

GET my-index-000001/_doc/2?routing=user1

This request gets the document with id 2, but it is routed based on the user. The document is not fetched if the correct routing is not specified.

Controls a preference of which shard replicas to execute the get request on. By default, the operation is randomized between the shard replicas.

The preference can be set to:

The refresh parameter can be set to true in order to refresh the relevant shard before the get operation and make it searchable. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slows down indexing).

The get operation gets hashed into a specific shard id. It then gets redirected to one of the replicas within that shard id and returns the result. The replicas are the primary shard and its replicas within that shard id group. This means that the more replicas we have, the better GET scaling we will have.

You can use the version parameter to retrieve 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.

Retrieve the JSON document with the _id 0 from the my-index-000001 index:

resp = client.get(
    index="my-index-000001",
    id="0",
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 0
)
puts response

GET my-index-000001/_doc/0

The API returns the following result:

{
  "_index": "my-index-000001",
  "_id": "0",
  "_version": 1,
  "_seq_no": 0,
  "_primary_term": 1,
  "found": true,
  "_source": {
    "@timestamp": "2099-11-15T14:12:12",
    "http": {
      "request": {
        "method": "get"
      },
      "response": {
        "status_code": 200,
        "bytes": 1070000
      },
      "version": "1.1"
    },
    "source": {
      "ip": "127.0.0.1"
    },
    "message": "GET /search HTTP/1.1 200 1070000",
    "user": {
      "id": "kimchy"
    }
  }
}

Check to see if a document with the _id 0 exists:

resp = client.exists(
    index="my-index-000001",
    id="0",
)
print(resp)

response = client.exists(
  index: 'my-index-000001',
  id: 0
)
puts response

HEAD my-index-000001/_doc/0

Elasticsearch returns a status code of 200 - OK if the document exists, or 404 - Not Found if it doesn’t.

Use the <index>/_source/<id> resource to get just the _source field of a document. For example:

resp = client.get_source(
    index="my-index-000001",
    id="1",
)
print(resp)

response = client.get_source(
  index: 'my-index-000001',
  id: 1
)
puts response

GET my-index-000001/_source/1

You can use the source filtering parameters to control which parts of the _source are returned:

resp = client.get_source(
    index="my-index-000001",
    id="1",
    _source_includes="*.id",
    _source_excludes="entities",
)
print(resp)

response = client.get_source(
  index: 'my-index-000001',
  id: 1,
  _source_includes: '*.id',
  _source_excludes: 'entities'
)
puts response

GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities

You can use HEAD with the _source endpoint to efficiently test whether or not the document _source exists. A document’s source is not available if it is disabled in the mapping.

resp = client.exists_source(
    index="my-index-000001",
    id="1",
)
print(resp)

response = client.exists_source(
  index: 'my-index-000001',
  id: 1
)
puts response

HEAD my-index-000001/_source/1

Use the stored_fields parameter to specify the set of stored fields you want to retrieve. Any requested fields that are not stored are ignored. Consider for instance the following mapping:

resp = client.indices.create(
    index="my-index-000001",
    body={
        "mappings": {
            "properties": {
                "counter": {"type": "integer", "store": False},
                "tags": {"type": "keyword", "store": True},
            }
        }
    },
)
print(resp)

response = client.indices.create(
  index: 'my-index-000001',
  body: {
    mappings: {
      properties: {
        counter: {
          type: 'integer',
          store: false
        },
        tags: {
          type: 'keyword',
          store: true
        }
      }
    }
  }
)
puts response

PUT my-index-000001
{
   "mappings": {
       "properties": {
          "counter": {
             "type": "integer",
             "store": false
          },
          "tags": {
             "type": "keyword",
             "store": true
          }
       }
   }
}

Now we can add a document:

resp = client.index(
    index="my-index-000001",
    id="1",
    body={"counter": 1, "tags": ["production"]},
)
print(resp)

response = client.index(
  index: 'my-index-000001',
  id: 1,
  body: {
    counter: 1,
    tags: [
      'production'
    ]
  }
)
puts response

PUT my-index-000001/_doc/1
{
  "counter": 1,
  "tags": [ "production" ]
}

And then try to retrieve it:

resp = client.get(
    index="my-index-000001",
    id="1",
    stored_fields=["tags", "counter"],
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 1,
  stored_fields: 'tags,counter'
)
puts response

GET my-index-000001/_doc/1?stored_fields=tags,counter

The API returns the following result:

{
   "_index": "my-index-000001",
   "_id": "1",
   "_version": 1,
   "_seq_no" : 22,
   "_primary_term" : 1,
   "found": true,
   "fields": {
      "tags": [
         "production"
      ]
   }
}

Field values fetched from the document itself are always returned as an array. Since the counter field is not stored, the get request ignores it.

You can also retrieve metadata fields like the _routing field:

resp = client.index(
    index="my-index-000001",
    id="2",
    routing="user1",
    body={"counter": 1, "tags": ["env2"]},
)
print(resp)

response = client.index(
  index: 'my-index-000001',
  id: 2,
  routing: 'user1',
  body: {
    counter: 1,
    tags: [
      'env2'
    ]
  }
)
puts response

PUT my-index-000001/_doc/2?routing=user1
{
  "counter" : 1,
  "tags" : ["env2"]
}

resp = client.get(
    index="my-index-000001",
    id="2",
    routing="user1",
    stored_fields=["tags", "counter"],
)
print(resp)

response = client.get(
  index: 'my-index-000001',
  id: 2,
  routing: 'user1',
  stored_fields: 'tags,counter'
)
puts response

GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter

The API returns the following result:

{
   "_index": "my-index-000001",
   "_id": "2",
   "_version": 1,
   "_seq_no" : 13,
   "_primary_term" : 1,
   "_routing": "user1",
   "found": true,
   "fields": {
      "tags": [
         "env2"
      ]
   }
}

Only leaf fields can be retrieved with the stored_field option. Object fields can’t be returned—​if specified, the request fails.