Elasticsearch 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

  • Autoscaling
    • Retrieves an autoscaling policy GET
    • Creates a new autoscaling policy PUT
    • Deletes an autoscaling policy DELETE
    • Gets the current autoscaling capacity based on the configured autoscaling policy 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
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get aliases GET
    • Provides a snapshot of the number of shards allocated to each data node and their disk space GET
    • Provides a snapshot of the number of shards allocated to each data node and their disk space GET
    • Get component templates GET
    • Get component templates GET
    • Get a document count GET
    • Get a document count GET
    • Returns the amount of heap memory currently used by the field data cache on every data node in the cluster GET
    • Returns the amount of heap memory currently used by the field data cache on every data node in the cluster GET
    • Returns the health status of a cluster, similar to the cluster health API GET
    • Get CAT help GET
    • Get index information GET
    • Get index information GET
    • Returns information about the master node, including the ID, bound IP address, and name 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
    • Returns information about custom node attributes GET
    • Returns information about the nodes in a cluster GET
    • Returns cluster-level changes that have not yet been executed GET
    • Returns a list of plugins running on each node of a cluster GET
    • Returns information about ongoing and completed shard recoveries GET
    • Returns information about ongoing and completed shard recoveries GET
    • Returns the snapshot repositories for a cluster GET
    • Returns low-level information about the Lucene segments in index shards GET
    • Returns low-level information about the Lucene segments in index shards GET
    • Returns information about the shards in a cluster GET
    • Returns information about the shards in a cluster GET
    • Returns information about the snapshots stored in one or more repositories GET
    • Returns information about the snapshots stored in one or more repositories GET
    • Returns information about tasks currently executing in the cluster GET
    • Returns information about index templates in a cluster GET
    • Returns information about index templates in a cluster GET
    • Returns thread pool statistics for each node in a cluster GET
    • Returns thread pool statistics for each node in a cluster GET
    • Get transforms GET
    • Get transforms GET
  • Cluster
    • Provides explanations for shard allocations in the cluster GET
    • Provides explanations for shard allocations in the cluster POST
    • Updates the cluster voting config exclusions by node ids or node names POST
    • Clears cluster voting config exclusions DELETE
    • Returns cluster-wide settings GET
    • Updates the cluster settings PUT
    • The cluster health API returns a simple status on the health of the cluster GET
    • The cluster health API returns a simple status on the health of the cluster GET
    • Get cluster info GET
    • Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed GET
    • The cluster remote info API allows you to retrieve all of the configured GET
    • Allows to manually change the allocation of individual shards in the cluster POST
    • Returns a comprehensive information about the state of the cluster GET
    • Returns a comprehensive information about the state of the cluster GET
    • Returns a comprehensive information about the state of the cluster GET
    • Returns cluster statistics GET
    • Returns cluster statistics GET
    • Ping the cluster HEAD
    • You can use this API to clear the archived repositories metering information in the cluster DELETE
    • You can use the cluster repositories metering API to retrieve repositories metering information in a cluster GET
    • This API yields a breakdown of the hot threads on each selected node in the cluster GET
    • This API yields a breakdown of the hot threads on each selected node in the cluster GET
    • Returns cluster nodes information GET
    • Returns cluster nodes information GET
    • Returns cluster nodes information GET
    • Returns cluster nodes information GET
    • Reloads the keystore on nodes in the cluster POST
    • Reloads the keystore on nodes in the cluster POST
    • Returns cluster nodes statistics GET
    • Returns cluster nodes statistics GET
    • Returns cluster nodes statistics GET
    • Returns cluster nodes statistics GET
    • Returns cluster nodes statistics GET
    • Returns cluster nodes statistics GET
    • Returns information on the usage of features GET
    • Returns information on the usage of features GET
    • Returns information on the usage of features GET
    • Returns information on the usage of features GET
  • Cluster - Health
    • Returns the health of the cluster GET
    • Returns the health of the cluster GET
  • Connector
    • Check in a connector PUT
    • Get a connector GET
    • Create or update a connector PUT
    • Delete a connector DELETE
    • Update the connector last sync stats PUT
    • 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
  • Cross-cluster replication
    • Gets configured auto-follow patterns GET
    • Creates a new named collection of auto-follow patterns against a specified remote cluster PUT
    • Deletes auto-follow patterns DELETE
    • Creates a new follower index configured to follow the referenced leader index PUT
    • Retrieves information about all follower indices, including parameters and status for each follower index GET
    • Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices GET
    • Removes the follower retention leases from the leader POST
    • Gets configured auto-follow patterns GET
    • Pauses an auto-follow pattern POST
    • Pauses a follower index POST
    • Resumes an auto-follow pattern that has been paused POST
    • Resumes a follower index that has been paused POST
    • Gets all stats related to cross-cluster replication GET
    • Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication POST
  • Data stream
    • Get data streams GET
    • Create a data stream PUT
    • Get data stream stats GET
    • Get data stream stats GET
    • 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
    • Throttle a delete by query operation 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
    • 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
    • Creates the enrich index for an existing enrich policy PUT
    • Get an enrich policy GET
    • Get enrich stats 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
  • Features
    • Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot GET
    • Resets the internal state of features, usually by deleting system indices POST
  • Fleet
    • Returns the current global checkpoints for an index 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
    • 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
    • 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
    • Clears the caches of one or more indices POST
    • Clears the caches of one or more indices POST
    • Clones an existing index PUT
    • Clones an existing index POST
    • Closes an index 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
    • Update data stream lifecycles PUT
    • 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
    • Returns information about whether a particular index template exists HEAD
    • Get index templates GET
    • Create or update an index template PUT
    • Create or update an index template POST
    • Deletes a legacy index template DELETE
    • Check existence of index templates HEAD
    • Analyzes the disk usage of each field of an index or data stream POST
    • Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval POST
    • Get aliases GET
    • Check aliases HEAD
    • Get the status for a data stream lifecycle GET
    • Returns field usage information for each shard and field of an index GET
    • Flushes one or more data streams or indices GET
    • Flushes one or more data streams or indices POST
    • Flushes one or more data streams or indices GET
    • Flushes one or more data streams or indices POST
    • Performs the force merge operation on one or more indices POST
    • Performs the force merge operation on one or more indices 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
    • Opens a closed index POST
    • Promotes a data stream from a replicated data stream managed by CCR to a regular data stream POST
    • Returns information about ongoing and completed shard recoveries for one or more indices GET
    • Returns information about ongoing and completed shard recoveries for one or more indices GET
    • Refresh an index GET
    • Refresh an index POST
    • Refresh an index GET
    • Refresh an index POST
    • Reloads an index's search analyzers and their resources GET
    • Reloads an index's search analyzers and their resources POST
    • Resolves the specified index expressions to return information about each cluster, including GET
    • 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
    • Returns low-level information about the Lucene segments in index shards GET
    • Returns low-level information about the Lucene segments in index shards GET
    • Retrieves store information about replica shards in one or more indices GET
    • Retrieves store information about replica shards in one or more indices GET
    • Shrinks an existing index into a new index with fewer primary shards PUT
    • Shrinks an existing index into a new index with fewer primary shards POST
    • Simulate an index POST
    • Simulate an index template POST
    • Simulate an index template POST
    • Splits an existing index into a new index with more primary shards PUT
    • Splits an existing index into a new index with more primary shards POST
    • Returns statistics for one or more indices GET
    • Returns statistics for one or more indices GET
    • Returns statistics for one or more indices GET
    • Returns statistics for one or more indices GET
    • Unfreezes 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
    • Retrieves a lifecycle policy GET
    • Creates a lifecycle policy PUT
    • Deletes the specified lifecycle policy definition DELETE
    • Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step GET
    • Retrieves a lifecycle policy GET
    • Retrieves the current index lifecycle management (ILM) status GET
    • Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and POST
    • Manually moves an index into the specified step and executes that step POST
    • Removes the assigned lifecycle policy and stops managing the specified index POST
    • Retries executing the policy for an index that is in the ERROR step POST
    • Start the index lifecycle management (ILM) plugin POST
    • Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin 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 geoip database configurations GET
    • Returns information about one or more geoip database configurations PUT
    • Deletes a geoip database configuration DELETE
    • Returns information about one or more ingest pipelines GET
    • Creates or updates an ingest pipeline PUT
    • Deletes one or more existing ingest pipeline DELETE
    • Gets download statistics for GeoIP2 databases used with the geoip processor GET
    • Returns information about one or more geoip database configurations GET
    • 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
    • Updates the license for the cluster PUT
    • Updates the license for the cluster POST
    • Deletes licensing information for the cluster DELETE
    • Retrieves information about the status of the basic license GET
    • Retrieves information about the status of the trial license GET
    • The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features POST
    • The start trial API enables you to start a 30-day trial, which gives access to all subscription features POST
  • 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
    • Get machine learning memory usage info GET
    • Get machine learning memory usage info GET
    • Return ML defaults and limits GET
    • Set upgrade_mode for ML indices POST
    • Validates an anomaly detection job POST
    • Validates an anomaly detection detector 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 datafeeds usage info GET
    • Get datafeeds usage info 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 jobs usage info GET
    • Get anomaly detection jobs usage info 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 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
    • 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
    • Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version GET
    • Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version GET
    • Find out whether system features need to be upgraded or not GET
    • Begin upgrades for system features POST
  • Monitoring
    • Used by the monitoring features to send monitoring data PUT
    • Used by the monitoring features to send monitoring data POST
    • Used by the monitoring features to send monitoring data PUT
    • Used by the monitoring features to send monitoring data POST
  • Node lifecycle
    • Retrieve status of a node or nodes that are currently marked as shutting down GET
    • Adds a node to be shut down PUT
    • Removes a node from the shutdown list DELETE
    • Retrieve status of a node or nodes that are currently marked as shutting down GET
  • 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
  • Rollup
    • Retrieves the configuration, stats, and status of rollup jobs GET
    • Creates a rollup job PUT
    • Deletes an existing rollup job DELETE
    • Retrieves the configuration, stats, and status of rollup jobs GET
    • Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern GET
    • Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern GET
    • Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored) GET
    • Enables searching rolled-up data using the standard Query DSL GET
    • Enables searching rolled-up data using the standard Query DSL POST
    • Starts an existing, stopped rollup job POST
    • Stops an existing, started rollup job 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 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
    • Performs a kNN search GET
    • Performs a kNN search 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
    • Returns information about the indices and shards that a search request would be executed against GET
    • Returns information about the indices and shards that a search request would be executed against POST
    • Returns information about the indices and shards that a search request would be executed against GET
    • Returns information about the indices and shards that a search request would be executed against 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
  • Searchable snapshots
    • Retrieve node-level cache statistics about searchable snapshots GET
    • Retrieve node-level cache statistics about searchable snapshots GET
    • Clear the cache of searchable snapshots POST
    • Clear the cache of searchable snapshots POST
    • Mount a snapshot as a searchable index POST
    • Retrieve shard-level statistics about searchable snapshots GET
    • Retrieve shard-level statistics about searchable snapshots GET
  • Security
    • Activate a user profile POST
    • Authenticate a user GET
    • Get roles GET
    • Bulk create or update roles POST
    • Bulk delete roles DELETE
    • 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 service account token PUT
    • Create a service account token POST
    • Delete service account tokens DELETE
    • Create a service account token 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 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
    • 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 user profile data PUT
    • Update user profile data POST
    • Get SSL certificates GET
  • Snapshot and restore
    • Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots POST
    • Clones indices from one snapshot into another snapshot in the same repository PUT
    • Returns information about a snapshot GET
    • Creates a snapshot in a repository PUT
    • Creates a snapshot in a repository POST
    • Deletes one or more snapshots DELETE
    • Returns information about a repository GET
    • Creates a repository PUT
    • Creates a repository POST
    • Deletes a repository DELETE
    • Returns information about a repository GET
    • Verifies the integrity of the contents of a snapshot repository POST
    • Restores a snapshot POST
    • Returns information about the status of a snapshot GET
    • Returns information about the status of a snapshot GET
    • Returns information about the status of a snapshot GET
    • Verifies a repository POST
  • Snapshot lifecycle management
    • Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts GET
    • Creates or updates a snapshot lifecycle policy PUT
    • Deletes an existing snapshot lifecycle policy DELETE
    • Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time PUT
    • Deletes any snapshots that are expired according to the policy's retention rules POST
    • Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts GET
    • Returns global and policy-level statistics about actions taken by snapshot lifecycle management GET
    • Retrieves the status of snapshot lifecycle management (SLM) GET
    • Turns on snapshot lifecycle management (SLM) POST
    • Turns off snapshot lifecycle management (SLM) POST
  • 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
    • Cancels a task, if it can be cancelled through an API POST
    • Cancels a task, if it can be cancelled through an API POST
    • Get task information GET
    • The task management API returns information about tasks currently executing on one or more nodes in the cluster GET
  • Text structure
    • Finds the structure of a text file POST
    • Tests a Grok pattern on some text GET
    • Tests a Grok pattern on some text 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
    • Upgrades all transforms POST
  • Usage
    • Provides general information about the installed X-Pack features GET
    • This API provides information about which features are currently enabled and available under the current license and some usage statistics GET
  • Watcher
    • Acknowledges a watch, manually throttling the execution of the watch's actions PUT
    • Acknowledges a watch, manually throttling the execution of the watch's actions POST
    • Acknowledges a watch, manually throttling the execution of the watch's actions PUT
    • Acknowledges a watch, manually throttling the execution of the watch's actions POST
    • Activates a currently inactive watch PUT
    • Activates a currently inactive watch POST
    • Deactivates a currently active watch PUT
    • Deactivates a currently active watch POST
    • Retrieves a watch by its ID GET
    • Creates a new watch, or updates an existing one PUT
    • Creates a new watch, or updates an existing one POST
    • Removes a watch from Watcher DELETE
    • This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes PUT
    • This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes POST
    • This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes PUT
    • This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes POST
    • Retrieves stored watches GET
    • Retrieves stored watches POST
    • Starts Watcher if it is not already running POST
    • Retrieves the current Watcher metrics GET
    • Retrieves the current Watcher metrics GET
    • Stops Watcher if it is running POST
Powered by Bump.sh

Search