Elasticsearch API logo
Elastic APIs hub
  • Elastic Cloud API
  • Elastic Cloud Billing API
  • Elastic Cloud Enterprise API
  • Elastic Cloud Serverless API
  • Elasticsearch API
  • Elasticsearch Serverless API
  • Kibana API
  • Kibana Serverless API
  • Logstash API
  • Observability Intake Serverless API
Back to hub page
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Feedback
v8
  • main default
  • v8
  • v9

Topics

  • Introduction
  • Authentication

Endpoints

  • Autoscaling
    • Get an autoscaling policy GET
    • Create or update an autoscaling policy PUT
    • Delete an autoscaling policy DELETE
    • Get the autoscaling capacity GET
  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection event POST
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get aliases GET
    • Get shard allocation information GET
    • Get shard allocation information GET
    • Get component templates GET
    • Get component templates GET
    • Get a document count GET
    • Get a document count GET
    • Get field data cache information GET
    • Get field data cache information GET
    • Get the cluster health status GET
    • Get CAT help GET
    • Get index information GET
    • Get index information GET
    • Get master node information GET
    • Get data frame analytics jobs GET
    • Get data frame analytics jobs GET
    • Get datafeeds GET
    • Get datafeeds GET
    • Get anomaly detection jobs GET
    • Get anomaly detection jobs GET
    • Get trained models GET
    • Get trained models GET
    • Get node attribute information GET
    • Get node information GET
    • Get pending task information GET
    • Get plugin information GET
    • Get shard recovery information GET
    • Get shard recovery information GET
    • Get snapshot repository information GET
    • Get segment information GET
    • Get segment information GET
    • Get shard information GET
    • Get shard information GET
    • Get snapshot information GET
    • Get snapshot information GET
    • Get task information GET
    • Get index template information GET
    • Get index template information GET
    • Get thread pool statistics GET
    • Get thread pool statistics GET
    • Get transform information GET
    • Get transform information GET
  • Cluster
    • Explain the shard allocations GET
    • Explain the shard allocations POST
    • Update voting configuration exclusions POST
    • Clear cluster voting config exclusions DELETE
    • Get cluster-wide settings GET
    • Update the cluster settings PUT
    • Get the cluster health status GET
    • Get the cluster health status GET
    • Get cluster info GET
    • Get the pending cluster tasks GET
    • Get remote cluster information GET
    • Reroute the cluster POST
    • Get the cluster state GET
    • Get the cluster state GET
    • Get the cluster state GET
    • Get cluster statistics GET
    • Get cluster statistics GET
    • Ping the cluster HEAD
    • Clear the archived repositories metering DELETE
    • Get cluster repositories metering GET
    • Get the hot threads for nodes GET
    • Get the hot threads for nodes GET
    • Get node information GET
    • Get node information GET
    • Get node information GET
    • Get node information GET
    • Reload the keystore on nodes in the cluster POST
    • Reload the keystore on nodes in the cluster POST
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get feature usage information GET
    • Get feature usage information GET
    • Get feature usage information GET
    • Get feature usage information GET
  • Cluster - Health
    • Get the cluster health GET
    • Get the cluster health GET
  • Connector
    • Check in a connector PUT
    • Get a connector GET
    • Create or update a connector PUT
    • Delete a connector DELETE
    • Get all connectors GET
    • Create or update a connector PUT
    • Create a connector POST
    • Cancel a connector sync job PUT
    • Check in a connector sync job PUT
    • Claim a connector sync job PUT
    • Get a connector sync job GET
    • Delete a connector sync job DELETE
    • Set a connector sync job error PUT
    • Get all connector sync jobs GET
    • Create a connector sync job POST
    • Set the connector sync job stats PUT
    • Activate the connector draft filter PUT
    • Update the connector API key ID PUT
    • Update the connector configuration PUT
    • Update the connector error field PUT
    • Update the connector features PUT
    • Update the connector filtering PUT
    • Update the connector draft filtering validation PUT
    • Update the connector index name PUT
    • Update the connector name and description PUT
    • Update the connector is_native flag PUT
    • Update the connector pipeline PUT
    • Update the connector scheduling PUT
    • Update the connector service type PUT
    • Update the connector status PUT
  • Cross-cluster replication
    • Get auto-follow patterns GET
    • Create or update auto-follow patterns PUT
    • Delete auto-follow patterns DELETE
    • Create a follower PUT
    • Get follower information GET
    • Get follower stats GET
    • Forget a follower POST
    • Get auto-follow patterns GET
    • Pause an auto-follow pattern POST
    • Pause a follower POST
    • Resume an auto-follow pattern POST
    • Resume a follower POST
    • Get cross-cluster replication stats GET
    • Unfollow an index POST
  • Data stream
    • Get data streams GET
    • Create a data stream PUT
    • Delete data streams DELETE
    • Get data stream stats GET
    • Get data stream stats GET
    • Get data stream lifecycles GET
    • Update data stream lifecycles PUT
    • Downsample an index POST
    • Get the status for a data stream lifecycle GET
    • Get data stream lifecycle stats GET
    • Get data streams GET
    • Convert an index alias to a data stream POST
    • Update data streams POST
    • Promote a data stream POST
  • Document
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
    • Create a new document in the index PUT
    • Create a new document in the index POST
    • Get a document by its ID GET
    • Create or update a document in an index PUT
    • Create or update a document in an index POST
    • Delete a document DELETE
    • Check a document HEAD
    • Delete documents POST
    • Throttle a delete by query operation POST
    • Get a document's source GET
    • Check for a document source HEAD
    • Create or update a document in an index POST
    • Get multiple documents GET
    • Get multiple documents POST
    • Get multiple documents GET
    • Get multiple documents POST
    • Get multiple term vectors GET
    • Get multiple term vectors POST
    • Get multiple term vectors GET
    • Get multiple term vectors POST
    • Reindex documents POST
    • Throttle a reindex operation POST
    • Get term vector information GET
    • Get term vector information POST
    • Get term vector information GET
    • Get term vector information POST
    • Update a document POST
    • Update documents POST
    • Throttle an update by query operation POST
  • Enrich
    • Get an enrich policy GET
    • Create an enrich policy PUT
    • Delete an enrich policy DELETE
    • Run an enrich policy PUT
    • Get an enrich policy GET
    • Get enrich stats GET
  • EQL
    • Get async EQL search results GET
    • Delete an async EQL search DELETE
    • Get the async EQL status GET
    • Get EQL search results GET
    • Get EQL search results POST
  • ES|QL
    • Run an async ES|QL query POST
    • Get async ES|QL query results GET
    • Delete an async ES|QL query DELETE
    • Stop async ES|QL query POST
    • Run an ES|QL query POST
  • Features
    • Get the features GET
    • Reset the features POST
  • Fleet
    • Get global checkpoints GET
    • Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request GET
    • Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request POST
    • Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request GET
    • Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request POST
    • The purpose of the fleet search api is to provide a search api where the search will only be executed GET
    • The purpose of the fleet search api is to provide a search api where the search will only be executed POST
  • Graph explore
    • Explore graph analytics GET
    • Explore graph analytics POST
  • Index
    • Get component templates GET
    • Create or update a component template PUT
    • Create or update a component template POST
    • Delete component templates DELETE
    • Check component templates HEAD
    • Get component templates GET
    • Import a dangling index POST
    • Delete a dangling index DELETE
    • Get the dangling indices GET
    • Add an index block PUT
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
    • Clear the cache POST
    • Clear the cache POST
    • Clone an index PUT
    • Clone an index POST
    • Close an index POST
    • Get index information GET
    • Create an index PUT
    • Delete indices DELETE
    • Check indices HEAD
    • Get aliases GET
    • Create or update an alias PUT
    • Create or update an alias POST
    • Delete an alias DELETE
    • Check aliases HEAD
    • Create or update an alias PUT
    • Create or update an alias POST
    • Delete an alias DELETE
    • Delete data stream lifecycles DELETE
    • Get index templates GET
    • Create or update an index template PUT
    • Create or update an index template POST
    • Delete an index template DELETE
    • Check index templates HEAD
    • Get index templates GET
    • Create or update an index template PUT
    • Create or update an index template POST
    • Delete a legacy index template DELETE
    • Check existence of index templates HEAD
    • Analyze the index disk usage POST
    • Get aliases GET
    • Check aliases HEAD
    • Get field usage stats GET
    • Flush data streams or indices GET
    • Flush data streams or indices POST
    • Flush data streams or indices GET
    • Flush data streams or indices POST
    • Force a merge POST
    • Force a merge POST
    • Get aliases GET
    • Get aliases GET
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Get index templates GET
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Update field mappings PUT
    • Update field mappings POST
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
    • Get index settings GET
    • Get index templates GET
    • Open a closed index POST
    • Get index recovery information GET
    • Get index recovery information GET
    • Refresh an index GET
    • Refresh an index POST
    • Refresh an index GET
    • Refresh an index POST
    • Reload search analyzers GET
    • Reload search analyzers POST
    • Resolve the cluster GET
    • Resolve the cluster GET
    • Resolve indices GET
    • Roll over to a new index POST
    • Roll over to a new index POST
    • Get index segments GET
    • Get index segments GET
    • Get index shard stores GET
    • Get index shard stores GET
    • Shrink an index PUT
    • Shrink an index POST
    • Simulate an index POST
    • Simulate an index template POST
    • Simulate an index template POST
    • Split an index PUT
    • Split an index POST
    • Get index statistics GET
    • Get index statistics GET
    • Get index statistics GET
    • Get index statistics GET
    • Unfreeze an index POST
    • Create or update an alias POST
    • Validate a query GET
    • Validate a query POST
    • Validate a query GET
    • Validate a query POST
  • Index lifecycle management
    • Get lifecycle policies GET
    • Create or update a lifecycle policy PUT
    • Delete a lifecycle policy DELETE
    • Explain the lifecycle state GET
    • Get lifecycle policies GET
    • Get the ILM status GET
    • Migrate to data tiers routing POST
    • Move to a lifecycle step POST
    • Remove policies from an index POST
    • Retry a policy POST
    • Start the ILM plugin POST
    • Stop the ILM plugin POST
  • Inference
    • Perform chat completion inference POST
    • Perform completion inference on the service POST
    • Get an inference endpoint GET
    • Create an inference endpoint PUT
    • Perform inference on the service POST
    • Delete an inference endpoint DELETE
    • Get an inference endpoint GET
    • Create an inference endpoint PUT
    • Perform inference on the service POST
    • Delete an inference endpoint DELETE
    • Get an inference endpoint GET
    • Create an AlibabaCloud AI Search inference endpoint PUT
    • Create an Amazon Bedrock inference endpoint PUT
    • Create an Anthropic inference endpoint PUT
    • Create an Azure AI studio inference endpoint PUT
    • Create an Azure OpenAI inference endpoint PUT
    • Create a Cohere inference endpoint PUT
    • Create an Elasticsearch inference endpoint PUT
    • Create an ELSER inference endpoint PUT
    • Create an Google AI Studio inference endpoint PUT
    • Create a Google Vertex AI inference endpoint PUT
    • Create a Hugging Face inference endpoint PUT
    • Create an JinaAI inference endpoint PUT
    • Create a Mistral inference endpoint PUT
    • Create an OpenAI inference endpoint PUT
    • Create a VoyageAI inference endpoint PUT
    • Create a Watsonx inference endpoint PUT
    • Perform rereanking inference on the service POST
    • Perform sparse embedding inference on the service POST
    • Perform streaming inference POST
    • Perform text embedding inference on the service POST
    • Update an inference endpoint PUT
    • Update an inference endpoint PUT
  • Info
    • Get cluster info GET
  • Ingest
    • Get GeoIP database configurations GET
    • Create or update a GeoIP database configuration PUT
    • Delete GeoIP database configurations DELETE
    • Get IP geolocation database configurations GET
    • Create or update an IP geolocation database configuration PUT
    • Delete IP geolocation database configurations DELETE
    • Get pipelines GET
    • Create or update a pipeline PUT
    • Delete pipelines DELETE
    • Get GeoIP statistics GET
    • Get GeoIP database configurations GET
    • Get IP geolocation database configurations GET
    • Get pipelines GET
    • Run a grok processor GET
    • Simulate a pipeline GET
    • Simulate a pipeline POST
    • Simulate a pipeline GET
    • Simulate a pipeline POST
    • Simulate data ingestion GET
    • Simulate data ingestion POST
    • Simulate data ingestion GET
    • Simulate data ingestion POST
  • Licensing
    • Get license information GET
    • Update the license PUT
    • Update the license POST
    • Delete the license DELETE
    • Get the basic license status GET
    • Get the trial status GET
    • Start a basic license POST
    • Start a trial POST
  • Logstash
    • Get Logstash pipelines GET
    • Create or update a Logstash pipeline PUT
    • Delete a Logstash pipeline DELETE
    • Get Logstash pipelines GET
  • Machine learning
    • Get machine learning memory usage info GET
    • Get machine learning memory usage info GET
    • Get machine learning information GET
    • Set upgrade_mode for ML indices POST
  • Machine learning anomaly detection
    • Close anomaly detection jobs POST
    • Get calendar configuration info GET
    • Create a calendar PUT
    • Get calendar configuration info POST
    • Delete a calendar DELETE
    • Delete events from a calendar DELETE
    • Add anomaly detection job to calendar PUT
    • Delete anomaly jobs from a calendar DELETE
    • Get datafeeds configuration info GET
    • Create a datafeed PUT
    • Delete a datafeed DELETE
    • Delete expired ML data DELETE
    • Delete expired ML data DELETE
    • Get filters GET
    • Create a filter PUT
    • Delete a filter DELETE
    • Predict future behavior of a time series POST
    • Delete forecasts from a job DELETE
    • Delete forecasts from a job DELETE
    • Get anomaly detection jobs configuration info GET
    • Create an anomaly detection job PUT
    • Delete an anomaly detection job DELETE
    • Get model snapshots info GET
    • Get model snapshots info POST
    • Delete a model snapshot DELETE
    • Estimate job model memory usage POST
    • Force buffered data to be processed POST
    • Get anomaly detection job results for buckets GET
    • Get anomaly detection job results for buckets POST
    • Get anomaly detection job results for buckets GET
    • Get anomaly detection job results for buckets POST
    • Get info about events in calendars GET
    • Add scheduled events to the calendar POST
    • Get calendar configuration info GET
    • Get calendar configuration info POST
    • Get anomaly detection job results for categories GET
    • Get anomaly detection job results for categories POST
    • Get anomaly detection job results for categories GET
    • Get anomaly detection job results for categories POST
    • Get datafeed stats GET
    • Get datafeed stats GET
    • Get datafeeds configuration info GET
    • Get filters GET
    • Get anomaly detection job results for influencers GET
    • Get anomaly detection job results for influencers POST
    • Get anomaly detection job stats GET
    • Get anomaly detection job stats GET
    • Get anomaly detection jobs configuration info GET
    • Get anomaly detection job model snapshot upgrade usage info GET
    • Get model snapshots info GET
    • Get model snapshots info POST
    • Get overall bucket results GET
    • Get overall bucket results POST
    • Get anomaly records for an anomaly detection job GET
    • Get anomaly records for an anomaly detection job POST
    • Open anomaly detection jobs POST
    • Send data to an anomaly detection job for analysis POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Reset an anomaly detection job POST
    • Revert to a snapshot POST
    • Start datafeeds POST
    • Stop datafeeds POST
    • Update a datafeed POST
    • Update a filter POST
    • Update an anomaly detection job POST
    • Update a snapshot POST
    • Upgrade a snapshot POST
  • Machine learning data frame analytics
    • Get data frame analytics job configuration info GET
    • Create a data frame analytics job PUT
    • Delete a data frame analytics job DELETE
    • Evaluate data frame analytics POST
    • Explain data frame analytics config GET
    • Explain data frame analytics config POST
    • Explain data frame analytics config GET
    • Explain data frame analytics config POST
    • Get data frame analytics job configuration info GET
    • Get data frame analytics job stats GET
    • Get data frame analytics job stats GET
    • Preview features used by data frame analytics GET
    • Preview features used by data frame analytics POST
    • Preview features used by data frame analytics GET
    • Preview features used by data frame analytics POST
    • Start a data frame analytics job POST
    • Stop data frame analytics jobs POST
    • Update a data frame analytics job POST
  • Machine learning trained model
    • Clear trained model deployment cache POST
    • Get trained model configuration info GET
    • Create a trained model PUT
    • Delete an unreferenced trained model DELETE
    • Create or update a trained model alias PUT
    • Delete a trained model alias DELETE
    • Get trained model configuration info GET
    • Get trained models usage info GET
    • Get trained models usage info GET
    • Evaluate a trained model POST
    • Evaluate a trained model POST
    • Create part of a trained model definition PUT
    • Create a trained model vocabulary PUT
    • Start a trained model deployment POST
    • Stop a trained model deployment POST
    • Update a trained model deployment POST
  • Migration
    • Cancel a migration reindex operation POST
    • Create an index from a source index PUT
    • Create an index from a source index POST
    • Get the migration reindexing status GET
    • Reindex legacy backing indices POST
    • Get deprecation information GET
    • Get deprecation information GET
    • Get feature migration information GET
    • Start the feature migration POST
  • Node lifecycle
    • Get the shutdown status GET
    • Prepare a node to be shut down PUT
    • Cancel node shutdown preparations DELETE
    • Get the shutdown status GET
  • Query rules
    • Get a query rule GET
    • Create or update a query rule PUT
    • Delete a query rule DELETE
    • Get a query ruleset GET
    • Create or update a query ruleset PUT
    • Delete a query ruleset DELETE
    • Get all query rulesets GET
    • Test a query ruleset POST
  • Rollup
    • Get rollup job information GET
    • Create a rollup job PUT
    • Delete a rollup job DELETE
    • Get rollup job information GET
    • Get the rollup job capabilities GET
    • Get the rollup job capabilities GET
    • Get the rollup index capabilities GET
    • Search rolled-up data GET
    • Search rolled-up data POST
    • Start rollup jobs POST
    • Stop rollup jobs POST
  • Script
    • Get a script or search template GET
    • Create or update a script or search template PUT
    • Create or update a script or search template POST
    • Delete a script or search template DELETE
    • Get script contexts GET
    • Get script languages GET
    • Create or update a script or search template PUT
    • Create or update a script or search template POST
    • Run a script GET
    • Run a script POST
  • Search
    • Get async search results GET
    • Delete an async search DELETE
    • Get the async search status GET
    • Run an async search POST
    • Run an async search POST
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Close a point in time DELETE
    • Count search results GET
    • Count search results POST
    • Count search results GET
    • Count search results POST
    • Explain a document match result GET
    • Explain a document match result POST
    • Get the field capabilities GET
    • Get the field capabilities POST
    • Get the field capabilities GET
    • Get the field capabilities POST
    • Run a knn search GET
    • Run a knn search POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Run multiple templated searches GET
    • Run multiple templated searches POST
    • Run multiple templated searches GET
    • Run multiple templated searches POST
    • Open a point in time POST
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
    • Render a search template GET
    • Render a search template POST
    • Render a search template GET
    • Render a search template POST
    • Run a search GET
    • Run a search POST
    • Run a search GET
    • Run a search POST
    • Search a vector tile GET
    • Search a vector tile POST
    • Get the search shards GET
    • Get the search shards POST
    • Get the search shards GET
    • Get the search shards POST
    • Run a search with a search template GET
    • Run a search with a search template POST
    • Run a search with a search template GET
    • Run a search with a search template POST
    • Get terms in an index GET
    • Get terms in an index POST
  • Search application
    • Get search application details GET
    • Create or update a search application PUT
    • Delete a search application DELETE
    • Get search applications GET
    • Render a search application query POST
    • Run a search application search GET
    • Run a search application search POST
  • Searchable snapshots
    • Get cache statistics GET
    • Get cache statistics GET
    • Clear the cache POST
    • Clear the cache POST
    • Mount a snapshot POST
    • Get searchable snapshot statistics GET
    • Get searchable snapshot statistics GET
  • Security
    • Activate a user profile POST
    • Authenticate a user GET
    • Get roles GET
    • Bulk create or update roles POST
    • Bulk delete roles DELETE
    • Bulk update API keys POST
    • Change passwords PUT
    • Change passwords POST
    • Change passwords PUT
    • Change passwords POST
    • Clear the API key cache POST
    • Clear the privileges cache POST
    • Clear the user cache POST
    • Clear the roles cache POST
    • Clear service account token caches POST
    • Get API key information GET
    • Create an API key PUT
    • Create an API key POST
    • Invalidate API keys DELETE
    • Create a cross-cluster API key POST
    • Create a service account token PUT
    • Create a service account token POST
    • Delete service account tokens DELETE
    • Create a service account token POST
    • Delegate PKI authentication POST
    • Get application privileges GET
    • Delete application privileges DELETE
    • Get roles GET
    • Create or update roles PUT
    • Create or update roles POST
    • Delete roles DELETE
    • Get role mappings GET
    • Create or update role mappings PUT
    • Create or update role mappings POST
    • Delete role mappings DELETE
    • Get users GET
    • Create or update users PUT
    • Create or update users POST
    • Delete users DELETE
    • Disable users PUT
    • Disable users POST
    • Disable a user profile PUT
    • Disable a user profile POST
    • Enable users PUT
    • Enable users POST
    • Enable a user profile PUT
    • Enable a user profile POST
    • Enroll Kibana GET
    • Enroll a node GET
    • Get builtin privileges GET
    • Get application privileges GET
    • Create or update application privileges PUT
    • Create or update application privileges POST
    • Get application privileges GET
    • Get role mappings GET
    • Get service accounts GET
    • Get service accounts GET
    • Get service accounts GET
    • Get service account credentials GET
    • Get security index settings GET
    • Update security index settings PUT
    • Get a token POST
    • Invalidate a token DELETE
    • Get users GET
    • Get user privileges GET
    • Get a user profile GET
    • Grant an API key POST
    • Check user privileges GET
    • Check user privileges POST
    • Check user privileges GET
    • Check user privileges POST
    • Check user profile privileges GET
    • Check user profile privileges POST
    • Authenticate OpenID Connect POST
    • Logout of OpenID Connect POST
    • Prepare OpenID connect authentication POST
    • Find API keys with a query GET
    • Find API keys with a query POST
    • Find roles with a query GET
    • Find roles with a query POST
    • Find users with a query GET
    • Find users with a query POST
    • Authenticate SAML POST
    • Logout of SAML completely POST
    • Invalidate SAML POST
    • Logout of SAML POST
    • Prepare SAML authentication POST
    • Create SAML service provider metadata GET
    • Suggest a user profile GET
    • Suggest a user profile POST
    • Update an API key PUT
    • Update a cross-cluster API key PUT
    • Update user profile data PUT
    • Update user profile data POST
    • Get SSL certificates GET
  • Snapshot and restore
    • Clean up the snapshot repository POST
    • Clone a snapshot PUT
    • Get snapshot information GET
    • Create a snapshot PUT
    • Create a snapshot POST
    • Delete snapshots DELETE
    • Get snapshot repository information GET
    • Create or update a snapshot repository PUT
    • Create or update a snapshot repository POST
    • Delete snapshot repositories DELETE
    • Get snapshot repository information GET
    • Analyze a snapshot repository POST
    • Restore a snapshot POST
    • Get the snapshot status GET
    • Get the snapshot status GET
    • Get the snapshot status GET
    • Verify a snapshot repository POST
  • Snapshot lifecycle management
    • Get policy information GET
    • Create or update a policy PUT
    • Delete a policy DELETE
    • Run a policy PUT
    • Run a retention policy POST
    • Get policy information GET
    • Get snapshot lifecycle management statistics GET
    • Get the snapshot lifecycle management status GET
    • Start snapshot lifecycle management POST
    • Stop snapshot lifecycle management POST
  • SQL
    • Clear an SQL search cursor POST
    • Delete an async SQL search DELETE
    • Get async SQL search results GET
    • Get the async SQL search status GET
    • Get SQL search results GET
    • Get SQL search results POST
    • Translate SQL into Elasticsearch queries GET
    • Translate SQL into Elasticsearch queries POST
  • Synonyms
    • Get a synonym set GET
    • Create or update a synonym set PUT
    • Delete a synonym set DELETE
    • Get a synonym rule GET
    • Create or update a synonym rule PUT
    • Delete a synonym rule DELETE
    • Get all synonym sets GET
  • Task management
    • Cancel a task POST
    • Cancel a task POST
    • Get task information GET
    • Get all tasks GET
  • Text structure
    • Find the structure of a text field GET
    • Find the structure of text messages GET
    • Find the structure of text messages POST
    • Find the structure of a text file POST
    • Test a Grok pattern GET
    • Test a Grok pattern POST
  • Transform
    • Get transforms GET
    • Create a transform PUT
    • Delete a transform DELETE
    • Get transforms GET
    • Get transform stats GET
    • Preview a transform GET
    • Preview a transform POST
    • Preview a transform GET
    • Preview a transform POST
    • Reset a transform POST
    • Schedule a transform to start now POST
    • Start a transform POST
    • Stop transforms POST
    • Update a transform POST
    • Upgrade all transforms POST
  • Usage
    • Get information GET
    • Get usage information GET
  • Watcher
    • Acknowledge a watch PUT
    • Acknowledge a watch POST
    • Acknowledge a watch PUT
    • Acknowledge a watch POST
    • Activate a watch PUT
    • Activate a watch POST
    • Deactivate a watch PUT
    • Deactivate a watch POST
    • Get a watch GET
    • Create or update a watch PUT
    • Create or update a watch POST
    • Delete a watch DELETE
    • Run a watch PUT
    • Run a watch POST
    • Run a watch PUT
    • Run a watch POST
    • Get Watcher index settings GET
    • Update Watcher index settings PUT
    • Query watches GET
    • Query watches POST
    • Start the watch service POST
    • Get Watcher statistics GET
    • Get Watcher statistics GET
    • Stop the watch service POST
Powered by Bump.sh

Run a search application search Beta

GET /_application/search_application/{name}/_search
Api key auth Basic auth Bearer auth

Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

Path parameters

  • name string Required

    The name of the search application to be searched.

Query parameters

  • typed_keys boolean

    Determines whether aggregation names are prefixed by their respective types in the response.

application/json

Body

  • params object

    Query parameters specific to this request, which will override any defaults specified in the template.

    Hide params attribute Show params attribute object
    • * object Additional properties

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • took number Required

      The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes:

      • Communication time between the coordinating node and data nodes
      • Time the request spends in the search thread pool, queued for execution
      • Actual run time

      It does not include:

      • Time needed to send the request to Elasticsearch
      • Time needed to serialize the JSON response
      • Time needed to send the response to a client
    • timed_out boolean Required

      If true, the request timed out before completion; returned results may be partial or empty.

    • _shards object Required
      Hide _shards attributes Show _shards attributes object
      • failed number Required
      • successful number Required
      • total number Required
      • failures array[object]
        Hide failures attributes Show failures attributes object
        • index string
        • node string
        • reason object Required
          Hide reason attributes Show reason attributes object
          • type string Required

            The type of error

          • reason string

            A human-readable explanation of the error, in English.

          • stack_trace string

            The server stack trace. Present only if the error_trace=true parameter was sent with the request.

          • caused_by object
          • root_cause array[object]
          • suppressed array[object]
        • shard number Required
        • status string
      • skipped number
    • hits object Required
      Hide hits attributes Show hits attributes object
      • total object | number

        Total hit count information, present only if track_total_hits wasn't false in the search request.

        One of:
        TotalHits object number-2 number
        Hide attributes Show attributes
        • relation string Required

          Values are eq or gte.

        • value number Required
      • hits array[object] Required
        Hide hits attributes Show hits attributes object
        • _index string Required
        • _id string
        • _score number | string | null

          One of:
          number-1 number string-2 string | null
        • _explanation object
          Hide _explanation attributes Show _explanation attributes object
          • description string Required
          • details array[object] Required
          • value number Required
        • fields object
          Hide fields attribute Show fields attribute object
          • * object Additional properties
        • highlight object
          Hide highlight attribute Show highlight attribute object
          • * array[string] Additional properties
        • inner_hits object
          Hide inner_hits attribute Show inner_hits attribute object
          • * object Additional properties
            Hide * attribute Show * attribute object
            • hits object Required
        • matched_queries array[string] | object

          One of:
          array-1 array[string] object-2 object
          Hide attribute Show attribute
          • * number Additional properties
        • _nested object
          Hide _nested attributes Show _nested attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • offset number Required
          • _nested object
        • _ignored array[string]
        • ignored_field_values object
          Hide ignored_field_values attribute Show ignored_field_values attribute object
          • * array[number | string | boolean | null | object] Additional properties

            A field value.

        • _shard string
        • _node string
        • _routing string
        • _source object
        • _rank number
        • _seq_no number
        • _primary_term number
        • _version number
        • sort array[number | string | boolean | null | object]

          A field value.

          A field value.

          One of:
          FieldValue number FieldValue number FieldValue string FieldValue boolean FieldValue string | null FieldValue object
      • max_score number | string | null

        One of:
        number-1 number string-2 string | null
    • aggregations object
    • _clusters object
      Hide _clusters attributes Show _clusters attributes object
      • skipped number Required
      • successful number Required
      • total number Required
      • running number Required
      • partial number Required
      • failed number Required
      • details object
        Hide details attribute Show details attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • status string Required

            Values are running, successful, partial, skipped, or failed.

          • indices string Required
          • took number

            Time unit for milliseconds

          • timed_out boolean Required
          • _shards object
            Hide _shards attributes Show _shards attributes object
            • failed number Required
            • successful number Required
            • total number Required
            • failures array[object]
            • skipped number
          • failures array[object]
            Hide failures attributes Show failures attributes object
            • index string
            • node string
            • reason object Required
            • shard number Required
            • status string
    • fields object
      Hide fields attribute Show fields attribute object
      • * object Additional properties
    • max_score number
    • num_reduce_phases number
    • profile object
      Hide profile attribute Show profile attribute object
      • shards array[object] Required
        Hide shards attributes Show shards attributes object
        • aggregations array[object] Required
          Hide aggregations attributes Show aggregations attributes object
          • breakdown object Required
          • description string Required
          • time_in_nanos
          • type string Required
          • debug object
          • children array[object]
        • cluster string Required
        • dfs object
          Hide dfs attributes Show dfs attributes object
          • statistics object
            Hide statistics attributes Show statistics attributes object
            • type string Required
            • description string Required
            • time string

              A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

            • time_in_nanos
            • breakdown object Required
            • debug object
            • children array[object]
          • knn array[object]
        • fetch object
          Hide fetch attributes Show fetch attributes object
          • type string Required
          • description string Required
          • time_in_nanos number

            Time unit for nanoseconds

          • breakdown object Required
            Hide breakdown attributes Show breakdown attributes object
            • load_source number
            • load_source_count number
            • load_stored_fields number
            • load_stored_fields_count number
            • next_reader number
            • next_reader_count number
            • process_count number
            • process number
          • debug object
            Hide debug attributes Show debug attributes object
            • stored_fields array[string]
            • fast_path number
          • children array[object]
        • id string Required
        • index string Required
        • node_id string Required
        • searches array[object] Required
          Hide searches attributes Show searches attributes object
          • collector array[object] Required
          • query array[object] Required
          • rewrite_time number Required
        • shard_id number Required
    • pit_id string
    • _scroll_id string
    • suggest object
      Hide suggest attribute Show suggest attribute object
      • * array[object] Additional properties
        One of:
        CompletionSuggest object PhraseSuggest object TermSuggest object
        Hide attributes Show attributes
        • length number Required
        • offset number Required
        • text string Required
        • options
        Hide attributes Show attributes
        • length number Required
        • offset number Required
        • text string Required
        • options
        Hide attributes Show attributes
        • length number Required
        • offset number Required
        • text string Required
        • options
    • terminated_early boolean
GET /_application/search_application/{name}/_search
curl \
 --request GET 'http://api.example.com/_application/search_application/{name}/_search' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"params\": {\n    \"query_string\": \"my first query\",\n    \"text_fields\": [\n      {\"name\": \"title\", \"boost\": 5},\n      {\"name\": \"description\", \"boost\": 1}\n    ]\n  }\n}"'
Request example
Use `POST _application/search_application/my-app/_search` to run a search against a search application called `my-app` that uses a search template.
{
  "params": {
    "query_string": "my first query",
    "text_fields": [
      {"name": "title", "boost": 5},
      {"name": "description", "boost": 1}
    ]
  }
}