About
- Features
- Install in Node
- Browser Builds
Browser Builds
- Bower
- NPM
- Download
- Angular Build
- jQuery Build
Quick Start
- Creating a client
- Say hello to Elasticsearch
- Searching for documents
API Conventions
- Generic Parameters
- Config values you can override per request
- Callbacks or Promises
Configuration
- Config options
- Examples
SSL and Authentication
- Basic Auth
- HTTPS/SSL
Extending
- Connection
- Log
- Client/API
Extensions
- superagent-elasticsearch
- http-aws-es
- elasticsearch-scrolltoend
- elasticsearch-deletebyquery
setup logging
- Using A Library
- Bunyan Example
- Using the default loggers
Contributing
7.6 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.clone
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.5 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.clone
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.4 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.clone
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.3 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.2 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessContext
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.1 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
7.0 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
6.8 API
- bulk
- clearScroll
- count
- create
- delete
- deleteByQuery
- deleteByQueryRethrottle
- deleteScript
- exists
- existsSource
- explain
- fieldCaps
- get
- getScript
- getSource
- index
- info
- mget
- msearch
- msearchTemplate
- mtermvectors
- ping
- putScript
- rankEval
- reindex
- reindexRethrottle
- renderSearchTemplate
- scriptsPainlessExecute
- scroll
- search
- searchShards
- searchTemplate
- termvectors
- update
- updateByQuery
- updateByQueryRethrottle
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.split
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.reloadSecureSettings
- nodes.stats
- nodes.usage
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
5.6 API
- bulk
- clearScroll
- count
- countPercolate
- create
- delete
- deleteByQuery
- deleteScript
- deleteTemplate
- exists
- existsSource
- explain
- fieldCaps
- fieldStats
- get
- getScript
- getSource
- getTemplate
- index
- info
- mget
- mpercolate
- msearch
- msearchTemplate
- mtermvectors
- percolate
- ping
- putScript
- putTemplate
- reindex
- reindexRethrottle
- renderSearchTemplate
- scroll
- search
- searchShards
- searchTemplate
- suggest
- termvectors
- update
- updateByQuery
- cat.aliases
- cat.allocation
- cat.count
- cat.fielddata
- cat.health
- cat.help
- cat.indices
- cat.master
- cat.nodeattrs
- cat.nodes
- cat.pendingTasks
- cat.plugins
- cat.recovery
- cat.repositories
- cat.segments
- cat.shards
- cat.snapshots
- cat.tasks
- cat.templates
- cat.threadPool
- cluster.allocationExplain
- cluster.getSettings
- cluster.health
- cluster.pendingTasks
- cluster.putSettings
- cluster.remoteInfo
- cluster.reroute
- cluster.state
- cluster.stats
- indices.analyze
- indices.clearCache
- indices.close
- indices.create
- indices.delete
- indices.deleteAlias
- indices.deleteTemplate
- indices.exists
- indices.existsAlias
- indices.existsTemplate
- indices.existsType
- indices.flush
- indices.flushSynced
- indices.forcemerge
- indices.get
- indices.getAlias
- indices.getFieldMapping
- indices.getMapping
- indices.getSettings
- indices.getTemplate
- indices.getUpgrade
- indices.open
- indices.putAlias
- indices.putMapping
- indices.putSettings
- indices.putTemplate
- indices.recovery
- indices.refresh
- indices.rollover
- indices.segments
- indices.shardStores
- indices.shrink
- indices.stats
- indices.updateAliases
- indices.upgrade
- indices.validateQuery
- ingest.deletePipeline
- ingest.getPipeline
- ingest.processorGrok
- ingest.putPipeline
- ingest.simulate
- nodes.hotThreads
- nodes.info
- nodes.stats
- snapshot.create
- snapshot.createRepository
- snapshot.delete
- snapshot.deleteRepository
- snapshot.get
- snapshot.getRepository
- snapshot.restore
- snapshot.status
- snapshot.verifyRepository
- tasks.cancel
- tasks.get
- tasks.list
Changelog
- Versions
Host
- Constructor(params)
- Examples
Transport
- request(params, [callback])
- setHosts(hostConfigs)
Errors
API Param Types