- About
- Browser Builds
- Quick Start
- API Conventions
- Configuration
- SSL and Authentication
- Extending
- Extensions
- setup logging
- Contributing
- 7.6 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.cloneindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.5 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.cloneindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.4 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.cloneindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.3 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.2 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessContextscriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.1 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 7.0 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 6.8 API
bulkclearScrollcountcreatedeletedeleteByQuerydeleteByQueryRethrottledeleteScriptexistsexistsSourceexplainfieldCapsgetgetScriptgetSourceindexinfomgetmsearchmsearchTemplatemtermvectorspingputScriptrankEvalreindexreindexRethrottlerenderSearchTemplatescriptsPainlessExecutescrollsearchsearchShardssearchTemplatetermvectorsupdateupdateByQueryupdateByQueryRethrottlecat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.splitindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.reloadSecureSettingsnodes.statsnodes.usagesnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- 5.6 API
bulkclearScrollcountcountPercolatecreatedeletedeleteByQuerydeleteScriptdeleteTemplateexistsexistsSourceexplainfieldCapsfieldStatsgetgetScriptgetSourcegetTemplateindexinfomgetmpercolatemsearchmsearchTemplatemtermvectorspercolatepingputScriptputTemplatereindexreindexRethrottlerenderSearchTemplatescrollsearchsearchShardssearchTemplatesuggesttermvectorsupdateupdateByQuerycat.aliasescat.allocationcat.countcat.fielddatacat.healthcat.helpcat.indicescat.mastercat.nodeattrscat.nodescat.pendingTaskscat.pluginscat.recoverycat.repositoriescat.segmentscat.shardscat.snapshotscat.taskscat.templatescat.threadPoolcluster.allocationExplaincluster.getSettingscluster.healthcluster.pendingTaskscluster.putSettingscluster.remoteInfocluster.reroutecluster.statecluster.statsindices.analyzeindices.clearCacheindices.closeindices.createindices.deleteindices.deleteAliasindices.deleteTemplateindices.existsindices.existsAliasindices.existsTemplateindices.existsTypeindices.flushindices.flushSyncedindices.forcemergeindices.getindices.getAliasindices.getFieldMappingindices.getMappingindices.getSettingsindices.getTemplateindices.getUpgradeindices.openindices.putAliasindices.putMappingindices.putSettingsindices.putTemplateindices.recoveryindices.refreshindices.rolloverindices.segmentsindices.shardStoresindices.shrinkindices.statsindices.updateAliasesindices.upgradeindices.validateQueryingest.deletePipelineingest.getPipelineingest.processorGrokingest.putPipelineingest.simulatenodes.hotThreadsnodes.infonodes.statssnapshot.createsnapshot.createRepositorysnapshot.deletesnapshot.deleteRepositorysnapshot.getsnapshot.getRepositorysnapshot.restoresnapshot.statussnapshot.verifyRepositorytasks.canceltasks.gettasks.list
- Changelog
- Host
- Transport
- Errors
- API Param Types
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.
7.3 API
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
7.3 API
editAt this time, you must opt into the 7.3 API by setting the apiVersion config parameter.
Was this helpful?
Thank you for your feedback.