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

Topics

  • Introduction

Endpoints

  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
    • Get behavioral analytics collections GET
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get aliases GET
    • Get component templates GET
    • Get component templates GET
    • Get a document count GET
    • Get a document count GET
    • Get CAT help GET
    • Get index information GET
    • Get index 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 transforms GET
    • Get transforms GET
  • Cluster
    • Get cluster info GET
    • Ping the cluster HEAD
  • 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
    • Get a connector sync job GET
    • Delete a connector sync job DELETE
    • Get all connector sync jobs GET
    • Create a connector sync job POST
    • 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 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
  • Data stream
    • Get data streams GET
    • Create a data stream PUT
    • Get data stream lifecycles GET
    • Get data streams GET
    • Convert an index alias to a data stream POST
    • Update data streams 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
    • Index a document PUT
    • Index a document POST
    • Get a document by its ID GET
    • Index a document PUT
    • Index a document POST
    • Delete a document DELETE
    • Check a document HEAD
    • Delete documents POST
    • Get a document's source GET
    • Check for a document source HEAD
    • Index a document 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
    • 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
  • Enrich
    • Get an enrich policy GET
    • Create an enrich policy PUT
    • Delete an enrich policy DELETE
    • Creates the enrich index for an existing enrich policy PUT
    • Get an enrich policy GET
  • EQL
    • Returns the current status and available results for an async EQL search or a stored synchronous EQL search GET
    • Deletes an async EQL search or a stored synchronous EQL search DELETE
    • Returns the current status for an async EQL search or a stored synchronous EQL search without returning results GET
    • Returns results matching a query expressed in Event Query Language (EQL) GET
    • Returns results matching a query expressed in Event Query Language (EQL) POST
  • ES|QL
    • Executes an ES|QL request POST
  • Graph explore
    • Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index GET
    • Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index 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
    • 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
    • Get index information GET
    • Create an index PUT
    • Delete indices DELETE
    • Check indices HEAD
    • Delete data streams DELETE
    • 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
    • Get index templates GET
    • Create or update an index template PUT
    • Create or update an index template POST
    • Delete an index template DELETE
    • Returns information about whether a particular index template exists HEAD
    • Get aliases GET
    • Check aliases HEAD
    • Get the status for a data stream lifecycle GET
    • Get aliases GET
    • Get aliases GET
    • Update data stream lifecycles PUT
    • 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
    • Refresh an index GET
    • Refresh an index POST
    • Refresh an index GET
    • Refresh an index POST
    • Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams GET
    • Roll over to a new index POST
    • Roll over to a new index POST
    • Simulate an index POST
    • Simulate an index template POST
    • Simulate an index template POST
    • Create or update an alias POST
    • Validate a query GET
    • Validate a query POST
    • Validate a query GET
    • Validate a query POST
  • Inference
    • 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
  • Info
    • Get cluster info GET
  • Ingest
    • Returns information about one or more ingest pipelines GET
    • Creates or updates an ingest pipeline PUT
    • Deletes one or more existing ingest pipeline DELETE
    • Returns information about one or more ingest pipelines GET
    • Extracts structured fields out of a single text field within a document GET
    • Executes an ingest pipeline against a set of provided documents GET
    • Executes an ingest pipeline against a set of provided documents POST
    • Executes an ingest pipeline against a set of provided documents GET
    • Executes an ingest pipeline against a set of provided documents POST
  • Licensing
    • Get license information GET
  • Logstash
    • Retrieves pipelines used for Logstash Central Management GET
    • Creates or updates a pipeline used for Logstash Central Management PUT
    • Deletes a pipeline used for Logstash Central Management DELETE
    • Retrieves pipelines used for Logstash Central Management GET
  • 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
    • Get filters GET
    • Create a filter PUT
    • Delete a filter DELETE
    • Get anomaly detection jobs configuration info GET
    • Create an anomaly detection job PUT
    • Delete an anomaly detection job DELETE
    • Estimate job model memory usage POST
    • Force buffered data to be processed 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 datafeeds usage info GET
    • Get datafeeds usage info GET
    • Get datafeeds configuration info GET
    • Get filters GET
    • Get anomaly detection jobs usage info GET
    • Get anomaly detection jobs usage info GET
    • Get anomaly detection jobs configuration info GET
    • Get overall bucket results GET
    • Get overall bucket results POST
    • Open anomaly detection jobs POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Reset an anomaly detection job POST
    • Start datafeeds POST
    • Stop datafeeds POST
    • Update a datafeed POST
    • Update a filter POST
    • Update an anomaly detection job 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
    • Get data frame analytics job configuration info GET
    • Get data frame analytics jobs usage info GET
    • Get data frame analytics jobs usage info 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
    • 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
  • Query rules
    • Returns the details about a query rule within a query ruleset GET
    • Creates or updates a query rule within a query ruleset PUT
    • Deletes a query rule within a query ruleset DELETE
    • Returns the details about a query ruleset GET
    • Creates or updates a query ruleset PUT
    • Deletes a query ruleset DELETE
    • Returns summarized information about existing query rulesets GET
    • Creates or updates a query ruleset 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
    • 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 async search status GET
    • Run an async search POST
    • Run an async search POST
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clears the search context and results for a scrolling search DELETE
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clears the search context and results for a scrolling search DELETE
    • Closes a point-in-time DELETE
    • Returns number of documents matching a query GET
    • Returns number of documents matching a query POST
    • Returns number of documents matching a query GET
    • Returns number of documents matching a query POST
    • Explain a document match result GET
    • Explain a document match result POST
    • The field capabilities API returns the information about the capabilities of fields among multiple indices GET
    • The field capabilities API returns the information about the capabilities of fields among multiple indices POST
    • The field capabilities API returns the information about the capabilities of fields among multiple indices GET
    • The field capabilities API returns the information about the capabilities of fields among multiple indices POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Runs multiple templated searches with a single request GET
    • Runs multiple templated searches with a single request POST
    • Runs multiple templated searches with a single request GET
    • Runs multiple templated searches with a single request POST
    • A search request by default executes against the most recent visible data of the target indices, POST
    • Enables you to evaluate the quality of ranked search results over a set of typical search queries GET
    • Enables you to evaluate the quality of ranked search results over a set of typical search queries POST
    • Enables you to evaluate the quality of ranked search results over a set of typical search queries GET
    • Enables you to evaluate the quality of ranked search results over a set of typical search queries POST
    • Renders a search template as a search request body GET
    • Renders a search template as a search request body POST
    • Renders a search template as a search request body GET
    • Renders a search template as a search request body POST
    • Returns search hits that match the query defined in the request GET
    • Returns search hits that match the query defined in the request POST
    • Returns search hits that match the query defined in the request GET
    • Returns search hits that match the query defined in the request POST
    • Search a vector tile GET
    • Search a vector tile POST
    • Runs a search with a search template GET
    • Runs a search with a search template POST
    • Runs a search with a search template GET
    • Runs 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
    • Returns the existing search applications GET
    • Run a search application search GET
    • Run a search application search POST
  • Security
    • Authenticate a user GET
    • Get API key information GET
    • Create an API key PUT
    • Create an API key POST
    • Invalidate API keys DELETE
    • Get roles GET
    • Create or update roles PUT
    • Create or update roles POST
    • Delete roles DELETE
    • Get builtin privileges GET
    • Get roles GET
    • Check user privileges GET
    • Check user privileges POST
    • Check user privileges GET
    • Check user privileges POST
    • Find API keys with a query GET
    • Find API keys with a query POST
    • Update an API key PUT
  • SQL
    • Clears the SQL cursor POST
    • Deletes an async SQL search or a stored synchronous SQL search DELETE
    • Returns the current status and available results for an async SQL search or stored synchronous SQL search GET
    • Returns the current status of an async SQL search or a stored synchronous SQL search GET
    • Executes a SQL request GET
    • Executes a SQL request POST
    • Translates SQL into Elasticsearch queries GET
    • Translates SQL into Elasticsearch queries POST
  • Synonyms
    • Retrieves a synonym set GET
    • Creates or updates a synonym set PUT
    • Deletes a synonym set DELETE
    • Retrieves a synonym rule from a synonym set GET
    • Creates or updates a synonym rule in a synonym set PUT
    • Deletes a synonym rule in a synonym set DELETE
    • Retrieves a summary of all defined synonym sets GET
  • Task management
    • Get task information GET
  • 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
Powered by Bump.sh