IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Connecting App Search API »
Elastic Docs ›

Enterprise Search API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Enterprise Search API

edit

Health API

edit

Get information on the health of a deployment and basic statistics around resource usage.

> response = ent_client.health
> response.body
 => {"name"=>"...",
     "version"=>{"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."},
     "jvm"=>{...},
     "filebeat"=>{...},
     "system"=>{...}
    }

Version API

edit

Get version information for the server.

> response = ent_client.version
> response.body
 => {"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."}

Managing Read-Only mode:

edit
# Set read-only flag state
> ent_client.put_read_only(body: { enabled: false })

# Get read-only flag state
> ent_client.read_only

Stats API

edit

Get information about the resource usage of the application, the state of different internal queues, etc.

> ent_client.stats.body
 => {"app"=>{"pid"=>1, "start"=>"...", "end"=>"", "metrics"=>{...}},
     "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
     "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}

Search Engines

edit

Retrieve information about search engines

> ent_client.search_engines
« Connecting App Search API »