Get a document count | Elasticsearch API documentation (original) (raw)

Example searches: “name”, “Get an autoscaling policy”, “*”, “analytics”, “Create or update an autoscaling policy”

Topics

• Introduction
• Authentication

Endpoints

• Autoscaling
  • Get an autoscaling policyGET
  • Create or update an autoscaling policyPUT
  • Delete an autoscaling policyDELETE
  • Get the autoscaling capacityGET
• Behavioral analytics
  • Get behavioral analytics collectionsGET
  • Create a behavioral analytics collectionPUT
  • Delete a behavioral analytics collectionDELETE
  • Get behavioral analytics collectionsGET
  • Create a behavioral analytics collection eventPOST
• Compact and aligned text (CAT)
  • Get aliasesGET
  • Get aliasesGET
  • Get shard allocation informationGET
  • Get shard allocation informationGET
  • Get component templatesGET
  • Get component templatesGET
  • Get a document countGET
  • Get a document countGET
  • Get field data cache informationGET
  • Get field data cache informationGET
  • Get the cluster health statusGET
  • Get CAT helpGET
  • Get index informationGET
  • Get index informationGET
  • Get master node informationGET
  • Get data frame analytics jobsGET
  • Get data frame analytics jobsGET
  • Get datafeedsGET
  • Get datafeedsGET
  • Get anomaly detection jobsGET
  • Get anomaly detection jobsGET
  • Get trained modelsGET
  • Get trained modelsGET
  • Get node attribute informationGET
  • Get node informationGET
  • Get pending task informationGET
  • Get plugin informationGET
  • Get shard recovery informationGET
  • Get shard recovery informationGET
  • Get snapshot repository informationGET
  • Get segment informationGET
  • Get segment informationGET
  • Get shard informationGET
  • Get shard informationGET
  • Get snapshot informationGET
  • Get snapshot informationGET
  • Get task informationGET
  • Get index template informationGET
  • Get index template informationGET
  • Get thread pool statisticsGET
  • Get thread pool statisticsGET
  • Get transform informationGET
  • Get transform informationGET
• Cluster
  • Explain the shard allocationsGET
  • Explain the shard allocationsPOST
  • Update voting configuration exclusionsPOST
  • Clear cluster voting config exclusionsDELETE
  • Get cluster-wide settingsGET
  • Update the cluster settingsPUT
  • Get the cluster health statusGET
  • Get the cluster health statusGET
  • Get cluster infoGET
  • Get the pending cluster tasksGET
  • Get remote cluster informationGET
  • Reroute the clusterPOST
  • Get the cluster stateGET
  • Get the cluster stateGET
  • Get the cluster stateGET
  • Get cluster statisticsGET
  • Get cluster statisticsGET
  • Ping the clusterHEAD
  • Clear the archived repositories meteringDELETE
  • Get cluster repositories meteringGET
  • Get the hot threads for nodesGET
  • Get the hot threads for nodesGET
  • Get node informationGET
  • Get node informationGET
  • Get node informationGET
  • Get node informationGET
  • Reload the keystore on nodes in the clusterPOST
  • Reload the keystore on nodes in the clusterPOST
  • Get node statisticsGET
  • Get node statisticsGET
  • Get node statisticsGET
  • Get node statisticsGET
  • Get node statisticsGET
  • Get node statisticsGET
  • Get feature usage informationGET
  • Get feature usage informationGET
  • Get feature usage informationGET
  • Get feature usage informationGET
• Cluster - Health
  • Get the cluster healthGET
  • Get the cluster healthGET
• Connector
  • Check in a connectorPUT
  • Get a connectorGET
  • Create or update a connectorPUT
  • Delete a connectorDELETE
  • Get all connectorsGET
  • Create or update a connectorPUT
  • Create a connectorPOST
  • Cancel a connector sync jobPUT
  • Check in a connector sync jobPUT
  • Claim a connector sync jobPUT
  • Get a connector sync jobGET
  • Delete a connector sync jobDELETE
  • Set a connector sync job errorPUT
  • Get all connector sync jobsGET
  • Create a connector sync jobPOST
  • Set the connector sync job statsPUT
  • Activate the connector draft filterPUT
  • Update the connector API key IDPUT
  • Update the connector configurationPUT
  • Update the connector error fieldPUT
  • Update the connector featuresPUT
  • Update the connector filteringPUT
  • Update the connector draft filtering validationPUT
  • Update the connector index namePUT
  • Update the connector name and descriptionPUT
  • Update the connector is_native flagPUT
  • Update the connector pipelinePUT
  • Update the connector schedulingPUT
  • Update the connector service typePUT
  • Update the connector statusPUT
• Cross-cluster replication
  • Get auto-follow patternsGET
  • Create or update auto-follow patternsPUT
  • Delete auto-follow patternsDELETE
  • Create a followerPUT
  • Get follower informationGET
  • Get follower statsGET
  • Forget a followerPOST
  • Get auto-follow patternsGET
  • Pause an auto-follow patternPOST
  • Pause a followerPOST
  • Resume an auto-follow patternPOST
  • Resume a followerPOST
  • Get cross-cluster replication statsGET
  • Unfollow an indexPOST
• Data stream
  • Get data streamsGET
  • Create a data streamPUT
  • Delete data streamsDELETE
  • Get data stream statsGET
  • Get data stream statsGET
  • Get data stream lifecyclesGET
  • Update data stream lifecyclesPUT
  • Downsample an indexPOST
  • Get the status for a data stream lifecycleGET
  • Get data stream lifecycle statsGET
  • Get data streamsGET
  • Convert an index alias to a data streamPOST
  • Update data streamsPOST
  • Promote a data streamPOST
• Document
  • Bulk index or delete documentsPUT
  • Bulk index or delete documentsPOST
  • Bulk index or delete documentsPUT
  • Bulk index or delete documentsPOST
  • Create a new document in the indexPUT
  • Create a new document in the indexPOST
  • Get a document by its IDGET
  • Create or update a document in an indexPUT
  • Create or update a document in an indexPOST
  • Delete a documentDELETE
  • Check a documentHEAD
  • Delete documentsPOST
  • Throttle a delete by query operationPOST
  • Get a document's sourceGET
  • Check for a document sourceHEAD
  • Create or update a document in an indexPOST
  • Get multiple documentsGET
  • Get multiple documentsPOST
  • Get multiple documentsGET
  • Get multiple documentsPOST
  • Get multiple term vectorsGET
  • Get multiple term vectorsPOST
  • Get multiple term vectorsGET
  • Get multiple term vectorsPOST
  • Reindex documentsPOST
  • Throttle a reindex operationPOST
  • Get term vector informationGET
  • Get term vector informationPOST
  • Get term vector informationGET
  • Get term vector informationPOST
  • Update a documentPOST
  • Update documentsPOST
  • Throttle an update by query operationPOST
• Enrich
  • Get an enrich policyGET
  • Create an enrich policyPUT
  • Delete an enrich policyDELETE
  • Run an enrich policyPUT
  • Get an enrich policyGET
  • Get enrich statsGET
• EQL
  • Get async EQL search resultsGET
  • Delete an async EQL searchDELETE
  • Get the async EQL statusGET
  • Get EQL search resultsGET
  • Get EQL search resultsPOST
• ES|QL
  • Run an async ES|QL queryPOST
  • Get async ES|QL query resultsGET
  • Delete an async ES|QL queryDELETE
  • Stop async ES|QL queryPOST
  • Get a specific running ES|QL query informationGET
  • Get running ES|QL queries informationGET
  • Run an ES|QL queryPOST
• Features
  • Get the featuresGET
  • Reset the featuresPOST
• Fleet
  • Get global checkpointsGET
  • Run multiple Fleet searchesGET
  • Run multiple Fleet searchesPOST
  • Run multiple Fleet searchesGET
  • Run multiple Fleet searchesPOST
  • Run a Fleet searchGET
  • Run a Fleet searchPOST
• Graph explore
  • Explore graph analyticsGET
  • Explore graph analyticsPOST
• Index
  • Get component templatesGET
  • Create or update a component templatePUT
  • Create or update a component templatePOST
  • Delete component templatesDELETE
  • Check component templatesHEAD
  • Get component templatesGET
  • Import a dangling indexPOST
  • Delete a dangling indexDELETE
  • Get the dangling indicesGET
  • Add an index blockPUT
  • Get tokens from text analysisGET
  • Get tokens from text analysisPOST
  • Get tokens from text analysisGET
  • Get tokens from text analysisPOST
  • Clear the cachePOST
  • Clear the cachePOST
  • Clone an indexPUT
  • Clone an indexPOST
  • Close an indexPOST
  • Get index informationGET
  • Create an indexPUT
  • Delete indicesDELETE
  • Check indicesHEAD
  • Get aliasesGET
  • Create or update an aliasPUT
  • Create or update an aliasPOST
  • Delete an aliasDELETE
  • Check aliasesHEAD
  • Create or update an aliasPUT
  • Create or update an aliasPOST
  • Delete an aliasDELETE
  • Delete data stream lifecyclesDELETE
  • Get index templatesGET
  • Create or update an index templatePUT
  • Create or update an index templatePOST
  • Delete an index templateDELETE
  • Check index templatesHEAD
  • Get index templatesGET
  • Create or update an index templatePUT
  • Create or update an index templatePOST
  • Delete a legacy index templateDELETE
  • Check existence of index templatesHEAD
  • Analyze the index disk usagePOST
  • Get aliasesGET
  • Check aliasesHEAD
  • Get field usage statsGET
  • Flush data streams or indicesGET
  • Flush data streams or indicesPOST
  • Flush data streams or indicesGET
  • Flush data streams or indicesPOST
  • Force a mergePOST
  • Force a mergePOST
  • Get aliasesGET
  • Get aliasesGET
  • Get mapping definitionsGET
  • Get mapping definitionsGET
  • Get index templatesGET
  • Get mapping definitionsGET
  • Get mapping definitionsGET
  • Update field mappingsPUT
  • Update field mappingsPOST
  • Get index settingsGET
  • Update index settingsPUT
  • Get index settingsGET
  • Update index settingsPUT
  • Get index settingsGET
  • Get index settingsGET
  • Get index templatesGET
  • Open a closed indexPOST
  • Get index recovery informationGET
  • Get index recovery informationGET
  • Refresh an indexGET
  • Refresh an indexPOST
  • Refresh an indexGET
  • Refresh an indexPOST
  • Reload search analyzersGET
  • Reload search analyzersPOST
  • Resolve the clusterGET
  • Resolve the clusterGET
  • Resolve indicesGET
  • Roll over to a new indexPOST
  • Roll over to a new indexPOST
  • Get index segmentsGET
  • Get index segmentsGET
  • Get index shard storesGET
  • Get index shard storesGET
  • Shrink an indexPUT
  • Shrink an indexPOST
  • Simulate an indexPOST
  • Simulate an index templatePOST
  • Simulate an index templatePOST
  • Split an indexPUT
  • Split an indexPOST
  • Get index statisticsGET
  • Get index statisticsGET
  • Get index statisticsGET
  • Get index statisticsGET
  • Create or update an aliasPOST
  • Validate a queryGET
  • Validate a queryPOST
  • Validate a queryGET
  • Validate a queryPOST
• Index lifecycle management
  • Get lifecycle policiesGET
  • Create or update a lifecycle policyPUT
  • Delete a lifecycle policyDELETE
  • Explain the lifecycle stateGET
  • Get lifecycle policiesGET
  • Get the ILM statusGET
  • Migrate to data tiers routingPOST
  • Move to a lifecycle stepPOST
  • Remove policies from an indexPOST
  • Retry a policyPOST
  • Start the ILM pluginPOST
  • Stop the ILM pluginPOST
• Inference
  • Perform chat completion inferencePOST
  • Perform completion inference on the servicePOST
  • Get an inference endpointGET
  • Create an inference endpointPUT
  • Perform inference on the servicePOST
  • Delete an inference endpointDELETE
  • Get an inference endpointGET
  • Create an inference endpointPUT
  • Perform inference on the servicePOST
  • Delete an inference endpointDELETE
  • Get an inference endpointGET
  • Create an AlibabaCloud AI Search inference endpointPUT
  • Create an Amazon Bedrock inference endpointPUT
  • Create an Anthropic inference endpointPUT
  • Create an Azure AI studio inference endpointPUT
  • Create an Azure OpenAI inference endpointPUT
  • Create a Cohere inference endpointPUT
  • Create an Elasticsearch inference endpointPUT
  • Create an ELSER inference endpointPUT
  • Create an Google AI Studio inference endpointPUT
  • Create a Google Vertex AI inference endpointPUT
  • Create a Hugging Face inference endpointPUT
  • Create an JinaAI inference endpointPUT
  • Create a Mistral inference endpointPUT
  • Create an OpenAI inference endpointPUT
  • Create a VoyageAI inference endpointPUT
  • Create a Watsonx inference endpointPUT
  • Perform rereanking inference on the servicePOST
  • Perform sparse embedding inference on the servicePOST
  • Perform streaming inferencePOST
  • Perform text embedding inference on the servicePOST
  • Update an inference endpointPUT
  • Update an inference endpointPUT
• Info
  • Get cluster infoGET
• Ingest
  • Get GeoIP database configurationsGET
  • Create or update a GeoIP database configurationPUT
  • Delete GeoIP database configurationsDELETE
  • Get IP geolocation database configurationsGET
  • Create or update an IP geolocation database configurationPUT
  • Delete IP geolocation database configurationsDELETE
  • Get pipelinesGET
  • Create or update a pipelinePUT
  • Delete pipelinesDELETE
  • Get GeoIP statisticsGET
  • Get GeoIP database configurationsGET
  • Get IP geolocation database configurationsGET
  • Get pipelinesGET
  • Run a grok processorGET
  • Simulate a pipelineGET
  • Simulate a pipelinePOST
  • Simulate a pipelineGET
  • Simulate a pipelinePOST
  • Simulate data ingestionGET
  • Simulate data ingestionPOST
  • Simulate data ingestionGET
  • Simulate data ingestionPOST
• Licensing
  • Get license informationGET
  • Update the licensePUT
  • Update the licensePOST
  • Delete the licenseDELETE
  • Get the basic license statusGET
  • Get the trial statusGET
  • Start a basic licensePOST
  • Start a trialPOST
• Logstash
  • Get Logstash pipelinesGET
  • Create or update a Logstash pipelinePUT
  • Delete a Logstash pipelineDELETE
  • Get Logstash pipelinesGET
• Machine learning
  • Get machine learning memory usage infoGET
  • Get machine learning memory usage infoGET
  • Get machine learning informationGET
  • Set upgrade_mode for ML indicesPOST
• Machine learning anomaly detection
  • Close anomaly detection jobsPOST
  • Get calendar configuration infoGET
  • Create a calendarPUT
  • Get calendar configuration infoPOST
  • Delete a calendarDELETE
  • Delete events from a calendarDELETE
  • Add anomaly detection job to calendarPUT
  • Delete anomaly jobs from a calendarDELETE
  • Get datafeeds configuration infoGET
  • Create a datafeedPUT
  • Delete a datafeedDELETE
  • Delete expired ML dataDELETE
  • Delete expired ML dataDELETE
  • Get filtersGET
  • Create a filterPUT
  • Delete a filterDELETE
  • Predict future behavior of a time seriesPOST
  • Delete forecasts from a jobDELETE
  • Delete forecasts from a jobDELETE
  • Get anomaly detection jobs configuration infoGET
  • Create an anomaly detection jobPUT
  • Delete an anomaly detection jobDELETE
  • Get model snapshots infoGET
  • Get model snapshots infoPOST
  • Delete a model snapshotDELETE
  • Estimate job model memory usagePOST
  • Force buffered data to be processedPOST
  • Get anomaly detection job results for bucketsGET
  • Get anomaly detection job results for bucketsPOST
  • Get anomaly detection job results for bucketsGET
  • Get anomaly detection job results for bucketsPOST
  • Get info about events in calendarsGET
  • Add scheduled events to the calendarPOST
  • Get calendar configuration infoGET
  • Get calendar configuration infoPOST
  • Get anomaly detection job results for categoriesGET
  • Get anomaly detection job results for categoriesPOST
  • Get anomaly detection job results for categoriesGET
  • Get anomaly detection job results for categoriesPOST
  • Get datafeed statsGET
  • Get datafeed statsGET
  • Get datafeeds configuration infoGET
  • Get filtersGET
  • Get anomaly detection job results for influencersGET
  • Get anomaly detection job results for influencersPOST
  • Get anomaly detection job statsGET
  • Get anomaly detection job statsGET
  • Get anomaly detection jobs configuration infoGET
  • Get anomaly detection job model snapshot upgrade usage infoGET
  • Get model snapshots infoGET
  • Get model snapshots infoPOST
  • Get overall bucket resultsGET
  • Get overall bucket resultsPOST
  • Get anomaly records for an anomaly detection jobGET
  • Get anomaly records for an anomaly detection jobPOST
  • Open anomaly detection jobsPOST
  • Send data to an anomaly detection job for analysisPOST
  • Preview a datafeedGET
  • Preview a datafeedPOST
  • Preview a datafeedGET
  • Preview a datafeedPOST
  • Reset an anomaly detection jobPOST
  • Revert to a snapshotPOST
  • Start datafeedsPOST
  • Stop datafeedsPOST
  • Update a datafeedPOST
  • Update a filterPOST
  • Update an anomaly detection jobPOST
  • Update a snapshotPOST
  • Upgrade a snapshotPOST
• Machine learning data frame analytics
  • Get data frame analytics job configuration infoGET
  • Create a data frame analytics jobPUT
  • Delete a data frame analytics jobDELETE
  • Evaluate data frame analyticsPOST
  • Explain data frame analytics configGET
  • Explain data frame analytics configPOST
  • Explain data frame analytics configGET
  • Explain data frame analytics configPOST
  • Get data frame analytics job configuration infoGET
  • Get data frame analytics job statsGET
  • Get data frame analytics job statsGET
  • Preview features used by data frame analyticsGET
  • Preview features used by data frame analyticsPOST
  • Preview features used by data frame analyticsGET
  • Preview features used by data frame analyticsPOST
  • Start a data frame analytics jobPOST
  • Stop data frame analytics jobsPOST
  • Update a data frame analytics jobPOST
• Machine learning trained model
  • Clear trained model deployment cachePOST
  • Get trained model configuration infoGET
  • Create a trained modelPUT
  • Delete an unreferenced trained modelDELETE
  • Create or update a trained model aliasPUT
  • Delete a trained model aliasDELETE
  • Get trained model configuration infoGET
  • Get trained models usage infoGET
  • Get trained models usage infoGET
  • Evaluate a trained modelPOST
  • Create part of a trained model definitionPUT
  • Create a trained model vocabularyPUT
  • Start a trained model deploymentPOST
  • Stop a trained model deploymentPOST
  • Update a trained model deploymentPOST
• Migration
  • Cancel a migration reindex operationPOST
  • Create an index from a source indexPUT
  • Create an index from a source indexPOST
  • Get the migration reindexing statusGET
  • Reindex legacy backing indicesPOST
  • Get deprecation informationGET
  • Get deprecation informationGET
  • Get feature migration informationGET
  • Start the feature migrationPOST
• Node lifecycle
  • Get the shutdown statusGET
  • Prepare a node to be shut downPUT
  • Cancel node shutdown preparationsDELETE
  • Get the shutdown statusGET
• Query rules
  • Get a query ruleGET
  • Create or update a query rulePUT
  • Delete a query ruleDELETE
  • Get a query rulesetGET
  • Create or update a query rulesetPUT
  • Delete a query rulesetDELETE
  • Get all query rulesetsGET
  • Test a query rulesetPOST
• Rollup
  • Get rollup job informationGET
  • Create a rollup jobPUT
  • Delete a rollup jobDELETE
  • Get rollup job informationGET
  • Get the rollup job capabilitiesGET
  • Get the rollup job capabilitiesGET
  • Get the rollup index capabilitiesGET
  • Search rolled-up dataGET
  • Search rolled-up dataPOST
  • Start rollup jobsPOST
  • Stop rollup jobsPOST
• Script
  • Get a script or search templateGET
  • Create or update a script or search templatePUT
  • Create or update a script or search templatePOST
  • Delete a script or search templateDELETE
  • Get script contextsGET
  • Get script languagesGET
  • Create or update a script or search templatePUT
  • Create or update a script or search templatePOST
  • Run a scriptGET
  • Run a scriptPOST
• Search
  • Get async search resultsGET
  • Delete an async searchDELETE
  • Get the async search statusGET
  • Run an async searchPOST
  • Run an async searchPOST
  • Run a scrolling searchGET
  • Run a scrolling searchPOST
  • Clear a scrolling searchDELETE
  • Run a scrolling searchGET
  • Run a scrolling searchPOST
  • Clear a scrolling searchDELETE
  • Close a point in timeDELETE
  • Count search resultsGET
  • Count search resultsPOST
  • Count search resultsGET
  • Count search resultsPOST
  • Explain a document match resultGET
  • Explain a document match resultPOST
  • Get the field capabilitiesGET
  • Get the field capabilitiesPOST
  • Get the field capabilitiesGET
  • Get the field capabilitiesPOST
  • Run multiple searchesGET
  • Run multiple searchesPOST
  • Run multiple searchesGET
  • Run multiple searchesPOST
  • Run multiple templated searchesGET
  • Run multiple templated searchesPOST
  • Run multiple templated searchesGET
  • Run multiple templated searchesPOST
  • Open a point in timePOST
  • Evaluate ranked search resultsGET
  • Evaluate ranked search resultsPOST
  • Evaluate ranked search resultsGET
  • Evaluate ranked search resultsPOST
  • Render a search templateGET
  • Render a search templatePOST
  • Render a search templateGET
  • Render a search templatePOST
  • Run a searchGET
  • Run a searchPOST
  • Run a searchGET
  • Run a searchPOST
  • Search a vector tileGET
  • Search a vector tilePOST
  • Get the search shardsGET
  • Get the search shardsPOST
  • Get the search shardsGET
  • Get the search shardsPOST
  • Run a search with a search templateGET
  • Run a search with a search templatePOST
  • Run a search with a search templateGET
  • Run a search with a search templatePOST
  • Get terms in an indexGET
  • Get terms in an indexPOST
• Search application
  • Get search application detailsGET
  • Create or update a search applicationPUT
  • Delete a search applicationDELETE
  • Get search applicationsGET
  • Render a search application queryPOST
  • Run a search application searchGET
  • Run a search application searchPOST
• Searchable snapshots
  • Get cache statisticsGET
  • Get cache statisticsGET
  • Clear the cachePOST
  • Clear the cachePOST
  • Mount a snapshotPOST
  • Get searchable snapshot statisticsGET
  • Get searchable snapshot statisticsGET
• Security
  • Activate a user profilePOST
  • Authenticate a userGET
  • Get rolesGET
  • Bulk create or update rolesPOST
  • Bulk delete rolesDELETE
  • Bulk update API keysPOST
  • Change passwordsPUT
  • Change passwordsPOST
  • Change passwordsPUT
  • Change passwordsPOST
  • Clear the API key cachePOST
  • Clear the privileges cachePOST
  • Clear the user cachePOST
  • Clear the roles cachePOST
  • Clear service account token cachesPOST
  • Get API key informationGET
  • Create an API keyPUT
  • Create an API keyPOST
  • Invalidate API keysDELETE
  • Create a cross-cluster API keyPOST
  • Create a service account tokenPUT
  • Create a service account tokenPOST
  • Delete service account tokensDELETE
  • Create a service account tokenPOST
  • Delegate PKI authenticationPOST
  • Get application privilegesGET
  • Delete application privilegesDELETE
  • Get rolesGET
  • Create or update rolesPUT
  • Create or update rolesPOST
  • Delete rolesDELETE
  • Get role mappingsGET
  • Create or update role mappingsPUT
  • Create or update role mappingsPOST
  • Delete role mappingsDELETE
  • Get usersGET
  • Create or update usersPUT
  • Create or update usersPOST
  • Delete usersDELETE
  • Disable usersPUT
  • Disable usersPOST
  • Disable a user profilePUT
  • Disable a user profilePOST
  • Enable usersPUT
  • Enable usersPOST
  • Enable a user profilePUT
  • Enable a user profilePOST
  • Enroll KibanaGET
  • Enroll a nodeGET
  • Get builtin privilegesGET
  • Get application privilegesGET
  • Create or update application privilegesPUT
  • Create or update application privilegesPOST
  • Get application privilegesGET
  • Get role mappingsGET
  • Get service accountsGET
  • Get service accountsGET
  • Get service accountsGET
  • Get service account credentialsGET
  • Get security index settingsGET
  • Update security index settingsPUT
  • Get a tokenPOST
  • Invalidate a tokenDELETE
  • Get usersGET
  • Get user privilegesGET
  • Get a user profileGET
  • Grant an API keyPOST
  • Check user privilegesGET
  • Check user privilegesPOST
  • Check user privilegesGET
  • Check user privilegesPOST
  • Check user profile privilegesGET
  • Check user profile privilegesPOST
  • Authenticate OpenID ConnectPOST
  • Logout of OpenID ConnectPOST
  • Prepare OpenID connect authenticationPOST
  • Find API keys with a queryGET
  • Find API keys with a queryPOST
  • Find roles with a queryGET
  • Find roles with a queryPOST
  • Find users with a queryGET
  • Find users with a queryPOST
  • Authenticate SAMLPOST
  • Logout of SAML completelyPOST
  • Invalidate SAMLPOST
  • Logout of SAMLPOST
  • Prepare SAML authenticationPOST
  • Create SAML service provider metadataGET
  • Suggest a user profileGET
  • Suggest a user profilePOST
  • Update an API keyPUT
  • Update a cross-cluster API keyPUT
  • Update user profile dataPUT
  • Update user profile dataPOST
  • Get SSL certificatesGET
• Snapshot and restore
  • Clean up the snapshot repositoryPOST
  • Clone a snapshotPUT
  • Get snapshot informationGET
  • Create a snapshotPUT
  • Create a snapshotPOST
  • Delete snapshotsDELETE
  • Get snapshot repository informationGET
  • Create or update a snapshot repositoryPUT
  • Create or update a snapshot repositoryPOST
  • Delete snapshot repositoriesDELETE
  • Get snapshot repository informationGET
  • Analyze a snapshot repositoryPOST
  • Restore a snapshotPOST
  • Get the snapshot statusGET
  • Get the snapshot statusGET
  • Get the snapshot statusGET
  • Verify a snapshot repositoryPOST
• Snapshot lifecycle management
  • Get policy informationGET
  • Create or update a policyPUT
  • Delete a policyDELETE
  • Run a policyPUT
  • Run a retention policyPOST
  • Get policy informationGET
  • Get snapshot lifecycle management statisticsGET
  • Get the snapshot lifecycle management statusGET
  • Start snapshot lifecycle managementPOST
  • Stop snapshot lifecycle managementPOST
• SQL
  • Clear an SQL search cursorPOST
  • Delete an async SQL searchDELETE
  • Get async SQL search resultsGET
  • Get the async SQL search statusGET
  • Get SQL search resultsGET
  • Get SQL search resultsPOST
  • Translate SQL into Elasticsearch queriesGET
  • Translate SQL into Elasticsearch queriesPOST
• Synonyms
  • Get a synonym setGET
  • Create or update a synonym setPUT
  • Delete a synonym setDELETE
  • Get a synonym ruleGET
  • Create or update a synonym rulePUT
  • Delete a synonym ruleDELETE
  • Get all synonym setsGET
• Task management
  • Cancel a taskPOST
  • Cancel a taskPOST
  • Get task informationGET
  • Get all tasksGET
• Text structure
  • Find the structure of a text fieldGET
  • Find the structure of text messagesGET
  • Find the structure of text messagesPOST
  • Find the structure of a text filePOST
  • Test a Grok patternGET
  • Test a Grok patternPOST
• Transform
  • Get transformsGET
  • Create a transformPUT
  • Delete a transformDELETE
  • Get transformsGET
  • Get transform statsGET
  • Preview a transformGET
  • Preview a transformPOST
  • Preview a transformGET
  • Preview a transformPOST
  • Reset a transformPOST
  • Schedule a transform to start nowPOST
  • Start a transformPOST
  • Stop transformsPOST
  • Update a transformPOST
  • Upgrade all transformsPOST
• Usage
  • Get informationGET
  • Get usage informationGET
• Watcher
  • Acknowledge a watchPUT
  • Acknowledge a watchPOST
  • Acknowledge a watchPUT
  • Acknowledge a watchPOST
  • Activate a watchPUT
  • Activate a watchPOST
  • Deactivate a watchPUT
  • Deactivate a watchPOST
  • Get a watchGET
  • Create or update a watchPUT
  • Create or update a watchPOST
  • Delete a watchDELETE
  • Run a watchPUT
  • Run a watchPOST
  • Run a watchPUT
  • Run a watchPOST
  • Get Watcher index settingsGET
  • Update Watcher index settingsPUT
  • Query watchesGET
  • Query watchesPOST
  • Start the watch servicePOST
  • Get Watcher statisticsGET
  • Get Watcher statisticsGET
  • Stop the watch servicePOST

Dismiss highlight Show more

Path parameters

• index
  string | array[string] Required
  A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

• List of columns to appear in the response. Supports simple wildcards.
• List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :ascor :desc as a suffix to the column name.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • epoch number | string

  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

  • Time of day, expressed as HH:MM:SS
  • the document count