[[api-reference]] //////// =========================================================================================================================== || || || || || || || ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ || || ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ || || ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ || || ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ || || ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ || || ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ || || || || || || This file is autogenerated, DO NOT send pull requests that changes this file directly. || || You should update the script that does the generation, which can be found in: || || https://github.com/elastic/elastic-client-generator-js || || || || You can run the script with the following command: || || npm run elasticsearch -- --version || || || || || || || =========================================================================================================================== //////// == API Reference [discrete] === client.asyncSearch.delete [discrete] === client.asyncSearch.get [discrete] === client.asyncSearch.status [discrete] === client.asyncSearch.submit [discrete] === client.autoscaling.deleteAutoscalingPolicy [discrete] === client.autoscaling.getAutoscalingCapacity [discrete] === client.autoscaling.getAutoscalingPolicy [discrete] === client.autoscaling.putAutoscalingPolicy [discrete] === client.bulk [discrete] === client.cat.aliases [discrete] === client.cat.allocation [discrete] === client.cat.componentTemplates [discrete] === client.cat.count [discrete] === client.cat.fielddata [discrete] === client.cat.health [discrete] === client.cat.help [discrete] === client.cat.indices [discrete] === client.cat.master [discrete] === client.cat.mlDataFrameAnalytics [discrete] === client.cat.mlDatafeeds [discrete] === client.cat.mlJobs [discrete] === client.cat.mlTrainedModels [discrete] === client.cat.nodeattrs [discrete] === client.cat.nodes [discrete] === client.cat.pendingTasks [discrete] === client.cat.plugins [discrete] === client.cat.recovery [discrete] === client.cat.repositories [discrete] === client.cat.segments [discrete] === client.cat.shards [discrete] === client.cat.snapshots [discrete] === client.cat.tasks [discrete] === client.cat.templates [discrete] === client.cat.threadPool [discrete] === client.cat.transforms [discrete] === client.ccr.deleteAutoFollowPattern [discrete] === client.ccr.follow [discrete] === client.ccr.followInfo [discrete] === client.ccr.followStats [discrete] === client.ccr.forgetFollower [discrete] === client.ccr.getAutoFollowPattern [discrete] === client.ccr.pauseAutoFollowPattern [discrete] === client.ccr.pauseFollow [discrete] === client.ccr.putAutoFollowPattern [discrete] === client.ccr.resumeAutoFollowPattern [discrete] === client.ccr.resumeFollow [discrete] === client.ccr.stats [discrete] === client.ccr.unfollow [discrete] === client.clearScroll [discrete] === client.closePointInTime [discrete] === client.cluster.allocationExplain [discrete] === client.cluster.deleteComponentTemplate [discrete] === client.cluster.deleteVotingConfigExclusions [discrete] === client.cluster.existsComponentTemplate [discrete] === client.cluster.getComponentTemplate [discrete] === client.cluster.getSettings [discrete] === client.cluster.health [discrete] === client.cluster.info [discrete] === client.cluster.pendingTasks [discrete] === client.cluster.postVotingConfigExclusions [discrete] === client.cluster.putComponentTemplate [discrete] === client.cluster.putSettings [discrete] === client.cluster.remoteInfo [discrete] === client.cluster.reroute [discrete] === client.cluster.state [discrete] === client.cluster.stats [discrete] === client.connector.checkIn [discrete] === client.connector.delete [discrete] === client.connector.get [discrete] === client.connector.list [discrete] === client.connector.post [discrete] === client.connector.put [discrete] === client.connector.syncJobCancel [discrete] === client.connector.syncJobCheckIn [discrete] === client.connector.syncJobClaim [discrete] === client.connector.syncJobDelete [discrete] === client.connector.syncJobError [discrete] === client.connector.syncJobGet [discrete] === client.connector.syncJobList [discrete] === client.connector.syncJobPost [discrete] === client.connector.syncJobUpdateStats [discrete] === client.connector.updateActiveFiltering [discrete] === client.connector.updateApiKeyId [discrete] === client.connector.updateConfiguration [discrete] === client.connector.updateError [discrete] === client.connector.updateFeatures [discrete] === client.connector.updateFiltering [discrete] === client.connector.updateFilteringValidation [discrete] === client.connector.updateIndexName [discrete] === client.connector.updateName [discrete] === client.connector.updateNative [discrete] === client.connector.updatePipeline [discrete] === client.connector.updateScheduling [discrete] === client.connector.updateServiceType [discrete] === client.connector.updateStatus [discrete] === client.count [discrete] === client.create [discrete] === client.danglingIndices.deleteDanglingIndex [discrete] === client.danglingIndices.importDanglingIndex [discrete] === client.danglingIndices.listDanglingIndices [discrete] === client.delete [discrete] === client.deleteByQuery [discrete] === client.deleteByQueryRethrottle [discrete] === client.deleteScript [discrete] === client.enrich.deletePolicy [discrete] === client.enrich.executePolicy [discrete] === client.enrich.getPolicy [discrete] === client.enrich.putPolicy [discrete] === client.enrich.stats [discrete] === client.eql.delete [discrete] === client.eql.get [discrete] === client.eql.getStatus [discrete] === client.eql.search [discrete] === client.esql.asyncQuery [discrete] === client.esql.asyncQueryGet [discrete] === client.esql.query [discrete] === client.exists [discrete] === client.existsSource [discrete] === client.explain [discrete] === client.features.getFeatures [discrete] === client.features.resetFeatures [discrete] === client.fieldCaps [discrete] === client.fleet.globalCheckpoints [discrete] === client.fleet.msearch [discrete] === client.fleet.search [discrete] === client.get [discrete] === client.getScript [discrete] === client.getScriptContext [discrete] === client.getScriptLanguages [discrete] === client.getSource [discrete] === client.graph.explore [discrete] === client.healthReport [discrete] === client.ilm.deleteLifecycle [discrete] === client.ilm.explainLifecycle [discrete] === client.ilm.getLifecycle [discrete] === client.ilm.getStatus [discrete] === client.ilm.migrateToDataTiers [discrete] === client.ilm.moveToStep [discrete] === client.ilm.putLifecycle [discrete] === client.ilm.removePolicy [discrete] === client.ilm.retry [discrete] === client.ilm.start [discrete] === client.ilm.stop [discrete] === client.index [discrete] === client.indices.addBlock [discrete] === client.indices.analyze [discrete] === client.indices.clearCache [discrete] === client.indices.clone [discrete] === client.indices.close [discrete] === client.indices.create [discrete] === client.indices.createDataStream [discrete] === client.indices.dataStreamsStats [discrete] === client.indices.delete [discrete] === client.indices.deleteAlias [discrete] === client.indices.deleteDataLifecycle [discrete] === client.indices.deleteDataStream [discrete] === client.indices.deleteIndexTemplate [discrete] === client.indices.deleteTemplate [discrete] === client.indices.diskUsage [discrete] === client.indices.downsample [discrete] === client.indices.exists [discrete] === client.indices.existsAlias [discrete] === client.indices.existsIndexTemplate [discrete] === client.indices.existsTemplate [discrete] === client.indices.explainDataLifecycle [discrete] === client.indices.fieldUsageStats [discrete] === client.indices.flush [discrete] === client.indices.forcemerge [discrete] === client.indices.get [discrete] === client.indices.getAlias [discrete] === client.indices.getDataLifecycle [discrete] === client.indices.getDataStream [discrete] === client.indices.getFieldMapping [discrete] === client.indices.getIndexTemplate [discrete] === client.indices.getMapping [discrete] === client.indices.getSettings [discrete] === client.indices.getTemplate [discrete] === client.indices.migrateToDataStream [discrete] === client.indices.modifyDataStream [discrete] === client.indices.open [discrete] === client.indices.promoteDataStream [discrete] === client.indices.putAlias [discrete] === client.indices.putDataLifecycle [discrete] === client.indices.putIndexTemplate [discrete] === client.indices.putMapping [discrete] === client.indices.putSettings [discrete] === client.indices.putTemplate [discrete] === client.indices.recovery [discrete] === client.indices.refresh [discrete] === client.indices.reloadSearchAnalyzers [discrete] === client.indices.resolveCluster [discrete] === client.indices.resolveIndex [discrete] === client.indices.rollover [discrete] === client.indices.segments [discrete] === client.indices.shardStores [discrete] === client.indices.shrink [discrete] === client.indices.simulateIndexTemplate [discrete] === client.indices.simulateTemplate [discrete] === client.indices.split [discrete] === client.indices.stats [discrete] === client.indices.unfreeze [discrete] === client.indices.updateAliases [discrete] === client.indices.validateQuery [discrete] === client.inference.delete [discrete] === client.inference.get [discrete] === client.inference.inference [discrete] === client.inference.put [discrete] === client.inference.streamInference [discrete] === client.info [discrete] === client.ingest.deleteGeoipDatabase [discrete] === client.ingest.deletePipeline [discrete] === client.ingest.geoIpStats [discrete] === client.ingest.getGeoipDatabase [discrete] === client.ingest.getPipeline [discrete] === client.ingest.processorGrok [discrete] === client.ingest.putGeoipDatabase [discrete] === client.ingest.putPipeline [discrete] === client.ingest.simulate [discrete] === client.knnSearch [discrete] === client.license.delete [discrete] === client.license.get [discrete] === client.license.getBasicStatus [discrete] === client.license.getTrialStatus [discrete] === client.license.post [discrete] === client.license.postStartBasic [discrete] === client.license.postStartTrial [discrete] === client.logstash.deletePipeline [discrete] === client.logstash.getPipeline [discrete] === client.logstash.putPipeline [discrete] === client.mget [discrete] === client.migration.deprecations [discrete] === client.migration.getFeatureUpgradeStatus [discrete] === client.migration.postFeatureUpgrade [discrete] === client.ml.clearTrainedModelDeploymentCache [discrete] === client.ml.closeJob [discrete] === client.ml.deleteCalendar [discrete] === client.ml.deleteCalendarEvent [discrete] === client.ml.deleteCalendarJob [discrete] === client.ml.deleteDataFrameAnalytics [discrete] === client.ml.deleteDatafeed [discrete] === client.ml.deleteExpiredData [discrete] === client.ml.deleteFilter [discrete] === client.ml.deleteForecast [discrete] === client.ml.deleteJob [discrete] === client.ml.deleteModelSnapshot [discrete] === client.ml.deleteTrainedModel [discrete] === client.ml.deleteTrainedModelAlias [discrete] === client.ml.estimateModelMemory [discrete] === client.ml.evaluateDataFrame [discrete] === client.ml.explainDataFrameAnalytics [discrete] === client.ml.flushJob [discrete] === client.ml.forecast [discrete] === client.ml.getBuckets [discrete] === client.ml.getCalendarEvents [discrete] === client.ml.getCalendars [discrete] === client.ml.getCategories [discrete] === client.ml.getDataFrameAnalytics [discrete] === client.ml.getDataFrameAnalyticsStats [discrete] === client.ml.getDatafeedStats [discrete] === client.ml.getDatafeeds [discrete] === client.ml.getFilters [discrete] === client.ml.getInfluencers [discrete] === client.ml.getJobStats [discrete] === client.ml.getJobs [discrete] === client.ml.getMemoryStats [discrete] === client.ml.getModelSnapshotUpgradeStats [discrete] === client.ml.getModelSnapshots [discrete] === client.ml.getOverallBuckets [discrete] === client.ml.getRecords [discrete] === client.ml.getTrainedModels [discrete] === client.ml.getTrainedModelsStats [discrete] === client.ml.inferTrainedModel [discrete] === client.ml.info [discrete] === client.ml.openJob [discrete] === client.ml.postCalendarEvents [discrete] === client.ml.postData [discrete] === client.ml.previewDataFrameAnalytics [discrete] === client.ml.previewDatafeed [discrete] === client.ml.putCalendar [discrete] === client.ml.putCalendarJob [discrete] === client.ml.putDataFrameAnalytics [discrete] === client.ml.putDatafeed [discrete] === client.ml.putFilter [discrete] === client.ml.putJob [discrete] === client.ml.putTrainedModel [discrete] === client.ml.putTrainedModelAlias [discrete] === client.ml.putTrainedModelDefinitionPart [discrete] === client.ml.putTrainedModelVocabulary [discrete] === client.ml.resetJob [discrete] === client.ml.revertModelSnapshot [discrete] === client.ml.setUpgradeMode [discrete] === client.ml.startDataFrameAnalytics [discrete] === client.ml.startDatafeed [discrete] === client.ml.startTrainedModelDeployment [discrete] === client.ml.stopDataFrameAnalytics [discrete] === client.ml.stopDatafeed [discrete] === client.ml.stopTrainedModelDeployment [discrete] === client.ml.updateDataFrameAnalytics [discrete] === client.ml.updateDatafeed [discrete] === client.ml.updateFilter [discrete] === client.ml.updateJob [discrete] === client.ml.updateModelSnapshot [discrete] === client.ml.updateTrainedModelDeployment [discrete] === client.ml.upgradeJobSnapshot [discrete] === client.monitoring.bulk [discrete] === client.msearch [discrete] === client.msearchTemplate [discrete] === client.mtermvectors [discrete] === client.nodes.clearRepositoriesMeteringArchive [discrete] === client.nodes.getRepositoriesMeteringInfo [discrete] === client.nodes.hotThreads [discrete] === client.nodes.info [discrete] === client.nodes.reloadSecureSettings [discrete] === client.nodes.stats [discrete] === client.nodes.usage [discrete] === client.openPointInTime [discrete] === client.ping [discrete] === client.putScript [discrete] === client.queryRules.deleteRule [discrete] === client.queryRules.deleteRuleset [discrete] === client.queryRules.getRule [discrete] === client.queryRules.getRuleset [discrete] === client.queryRules.listRulesets [discrete] === client.queryRules.putRule [discrete] === client.queryRules.putRuleset [discrete] === client.queryRules.test [discrete] === client.rankEval [discrete] === client.reindex [discrete] === client.reindexRethrottle [discrete] === client.renderSearchTemplate [discrete] === client.rollup.deleteJob [discrete] === client.rollup.getJobs [discrete] === client.rollup.getRollupCaps [discrete] === client.rollup.getRollupIndexCaps [discrete] === client.rollup.putJob [discrete] === client.rollup.rollupSearch [discrete] === client.rollup.startJob [discrete] === client.rollup.stopJob [discrete] === client.scriptsPainlessExecute [discrete] === client.scroll [discrete] === client.search [discrete] === client.searchApplication.delete [discrete] === client.searchApplication.deleteBehavioralAnalytics [discrete] === client.searchApplication.get [discrete] === client.searchApplication.getBehavioralAnalytics [discrete] === client.searchApplication.list [discrete] === client.searchApplication.postBehavioralAnalyticsEvent [discrete] === client.searchApplication.put [discrete] === client.searchApplication.putBehavioralAnalytics [discrete] === client.searchApplication.renderQuery [discrete] === client.searchApplication.search [discrete] === client.searchMvt [discrete] === client.searchShards [discrete] === client.searchTemplate [discrete] === client.searchableSnapshots.cacheStats [discrete] === client.searchableSnapshots.clearCache [discrete] === client.searchableSnapshots.mount [discrete] === client.searchableSnapshots.stats [discrete] === client.security.activateUserProfile [discrete] === client.security.authenticate [discrete] === client.security.bulkDeleteRole [discrete] === client.security.bulkPutRole [discrete] === client.security.bulkUpdateApiKeys [discrete] === client.security.changePassword [discrete] === client.security.clearApiKeyCache [discrete] === client.security.clearCachedPrivileges [discrete] === client.security.clearCachedRealms [discrete] === client.security.clearCachedRoles [discrete] === client.security.clearCachedServiceTokens [discrete] === client.security.createApiKey [discrete] === client.security.createCrossClusterApiKey [discrete] === client.security.createServiceToken [discrete] === client.security.deletePrivileges [discrete] === client.security.deleteRole [discrete] === client.security.deleteRoleMapping [discrete] === client.security.deleteServiceToken [discrete] === client.security.deleteUser [discrete] === client.security.disableUser [discrete] === client.security.disableUserProfile [discrete] === client.security.enableUser [discrete] === client.security.enableUserProfile [discrete] === client.security.enrollKibana [discrete] === client.security.enrollNode [discrete] === client.security.getApiKey [discrete] === client.security.getBuiltinPrivileges [discrete] === client.security.getPrivileges [discrete] === client.security.getRole [discrete] === client.security.getRoleMapping [discrete] === client.security.getServiceAccounts [discrete] === client.security.getServiceCredentials [discrete] === client.security.getSettings [discrete] === client.security.getToken [discrete] === client.security.getUser [discrete] === client.security.getUserPrivileges [discrete] === client.security.getUserProfile [discrete] === client.security.grantApiKey [discrete] === client.security.hasPrivileges [discrete] === client.security.hasPrivilegesUserProfile [discrete] === client.security.invalidateApiKey [discrete] === client.security.invalidateToken [discrete] === client.security.oidcAuthenticate [discrete] === client.security.oidcLogout [discrete] === client.security.oidcPrepareAuthentication [discrete] === client.security.putPrivileges [discrete] === client.security.putRole [discrete] === client.security.putRoleMapping [discrete] === client.security.putUser [discrete] === client.security.queryApiKeys [discrete] === client.security.queryRole [discrete] === client.security.queryUser [discrete] === client.security.samlAuthenticate [discrete] === client.security.samlCompleteLogout [discrete] === client.security.samlInvalidate [discrete] === client.security.samlLogout [discrete] === client.security.samlPrepareAuthentication [discrete] === client.security.samlServiceProviderMetadata [discrete] === client.security.suggestUserProfiles [discrete] === client.security.updateApiKey [discrete] === client.security.updateCrossClusterApiKey [discrete] === client.security.updateSettings [discrete] === client.security.updateUserProfileData [discrete] === client.shutdown.deleteNode [discrete] === client.shutdown.getNode [discrete] === client.shutdown.putNode [discrete] === client.simulate.ingest [discrete] === client.slm.deleteLifecycle [discrete] === client.slm.executeLifecycle [discrete] === client.slm.executeRetention [discrete] === client.slm.getLifecycle [discrete] === client.slm.getStats [discrete] === client.slm.getStatus [discrete] === client.slm.putLifecycle [discrete] === client.slm.start [discrete] === client.slm.stop [discrete] === client.snapshot.cleanupRepository [discrete] === client.snapshot.clone [discrete] === client.snapshot.create [discrete] === client.snapshot.createRepository [discrete] === client.snapshot.delete [discrete] === client.snapshot.deleteRepository [discrete] === client.snapshot.get [discrete] === client.snapshot.getRepository [discrete] === client.snapshot.repositoryAnalyze [discrete] === client.snapshot.restore [discrete] === client.snapshot.status [discrete] === client.snapshot.verifyRepository [discrete] === client.sql.clearCursor [discrete] === client.sql.deleteAsync [discrete] === client.sql.getAsync [discrete] === client.sql.getAsyncStatus [discrete] === client.sql.query [discrete] === client.sql.translate [discrete] === client.ssl.certificates [discrete] === client.synonyms.deleteSynonym [discrete] === client.synonyms.deleteSynonymRule [discrete] === client.synonyms.getSynonym [discrete] === client.synonyms.getSynonymRule [discrete] === client.synonyms.getSynonymsSets [discrete] === client.synonyms.putSynonym [discrete] === client.synonyms.putSynonymRule [discrete] === client.tasks.cancel [discrete] === client.tasks.get [discrete] === client.tasks.list [discrete] === client.termsEnum [discrete] === client.termvectors [discrete] === client.textStructure.findFieldStructure [discrete] === client.textStructure.findMessageStructure [discrete] === client.textStructure.findStructure [discrete] === client.textStructure.testGrokPattern [discrete] === client.transform.deleteTransform [discrete] === client.transform.getNodeStats [discrete] === client.transform.getTransform [discrete] === client.transform.getTransformStats [discrete] === client.transform.previewTransform [discrete] === client.transform.putTransform [discrete] === client.transform.resetTransform [discrete] === client.transform.scheduleNowTransform [discrete] === client.transform.startTransform [discrete] === client.transform.stopTransform [discrete] === client.transform.updateTransform [discrete] === client.transform.upgradeTransforms [discrete] === client.update [discrete] === client.updateByQuery [discrete] === client.updateByQueryRethrottle [discrete] === client.watcher.ackWatch [discrete] === client.watcher.activateWatch [discrete] === client.watcher.deactivateWatch [discrete] === client.watcher.deleteWatch [discrete] === client.watcher.executeWatch [discrete] === client.watcher.getSettings [discrete] === client.watcher.getWatch [discrete] === client.watcher.putWatch [discrete] === client.watcher.queryWatches [discrete] === client.watcher.start [discrete] === client.watcher.stats [discrete] === client.watcher.stop [discrete] === client.watcher.updateSettings [discrete] === client.xpack.info [discrete] === client.xpack.usage