IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« Host Examples »
Elastic Docs ›elasticsearch.js ›Host

Constructor(params)

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

Constructor(params)

edit

Params

edit

Params can either be URL string, or an object with the following properties

host

String — The name of the host

Default
"localhost"

port

Number — The port number to use for this host. Note the default of 9200 is only true if the params are passed as an object. If a string, then default port is evaluated based on the protocol (80 for http, 443 for https).

Default
9200

protocol

String — The name of the protocol this host is reachable on

Default
"http"
Options
  • "http"
  • "https"

path

String — A path prefix that should be prepended to every path requested.

auth

String — Basic authentication i.e. user:password to compute an Authorization header.

query

String,Object — A default set of query string parameters to use on every request.

headers

Object — An object describing the headers to send for every request to this node.

...

Any — When the host receives a configuration object, it assigns all of the object’s keys to itself. This allows you to pass in arbitrary keys and values that can be used within selectors, or other custom functionality.

ssl

Object — Host specific version of the ssl config.

« Host Examples »