Skip to content
Changelog

Report a bug

Elasticsearch integration: operations for AI agents

Elasticsearch connects to Type.com as an integration. This page lists the 825 operations documented for Claude and Codex in Type.com: 402 read, 210 write, 213 destructive.

About Elasticsearch

Elasticsearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases. It provides real-time search and analytics for all types of data.

Categories: Developer Tools & IT

How to connect Elasticsearch to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

825 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

825 operations listed.

Search

  • Read

    Get async search results

    Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.

  • Read

    Get the async search status

    Get the status of a previously submitted async search request given its identifier, without retrieving search results.

  • Read

    Run a scrolling search

    IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the searchafter parameter with a point in time (PIT).

  • Read

    Run a scrolling search

    IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the searchafter parameter with a point in time (PIT).

  • Read

    Count search results

    Get the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses matchall to count all the documents.

  • Read

    Count search results

    Get the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses matchall to count all the documents.

  • Read

    Count search results

    Get the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses matchall to count all the documents.

  • Read

    Count search results

    Get the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses matchall to count all the documents.

  • Read

    Explain a document match result

    Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document. Required authorization Index privileges: read

  • Read

    Get the field capabilities

    Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field.

  • Read

    Get the field capabilities

    Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field.

  • Read

    Get the field capabilities

    Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field.

  • Read

    Get the field capabilities

    Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field.

  • Read

    Run multiple searches

    The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.

  • Read

    Run multiple searches

    The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.

  • Read

    Run multiple templated searches

    Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines.

  • Read

    Run multiple templated searches

    Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines.

  • Read

    Evaluate ranked search results

    Evaluate the quality of ranked search results over a set of typical search queries. Required authorization Index privileges: read

  • Read

    Evaluate ranked search results

    Evaluate the quality of ranked search results over a set of typical search queries. Required authorization Index privileges: read

  • Read

    Render a search template

    Render a search template as a search request body. Required authorization Index privileges: read

  • Read

    Render a search template

    Render a search template as a search request body. Required authorization Index privileges: read

  • Read

    Run a search

    Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

  • Read

    Search a vector tile

    Search a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results as a binary mapbox vector tile.

  • Read

    Search a vector tile

    Search a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results as a binary mapbox vector tile.

  • Read

    Get the search shards

    Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

  • Read

    Get the search shards

    Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

  • Read

    Get the search shards

    Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

  • Read

    Get the search shards

    Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

  • Read

    Run a search with a search template

    Required authorization Index privileges: read

  • Read

    Run a search with a search template

    Required authorization Index privileges: read

  • Read

    Get terms in an index

    Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios. info The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted.

  • Read

    Get terms in an index

    Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios. info The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted.

  • Write

    Run an async search

    When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.

  • Write

    Run an async search

    When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.

  • Write

    Run a scrolling search

    IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the searchafter parameter with a point in time (PIT).

  • Write

    Run a scrolling search

    IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the searchafter parameter with a point in time (PIT).

  • Write

    Explain a document match result

    Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document. Required authorization Index privileges: read

  • Write

    Run multiple searches

    The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.

  • Write

    Run multiple searches

    The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.

  • Write

    Run multiple templated searches

    Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines.

  • Write

    Run multiple templated searches

    Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines.

  • Write

    Open a point in time

    A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated.

  • Write

    Evaluate ranked search results

    Evaluate the quality of ranked search results over a set of typical search queries. Required authorization Index privileges: read

  • Write

    Evaluate ranked search results

    Evaluate the quality of ranked search results over a set of typical search queries. Required authorization Index privileges: read

  • Write

    Render a search template

    Render a search template as a search request body. Required authorization Index privileges: read

  • Write

    Render a search template

    Render a search template as a search request body. Required authorization Index privileges: read

  • Write

    Run a search

    Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

  • Write

    Run a search

    Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

  • Write

    Run a search with a search template

    Required authorization Index privileges: read

  • Write

    Run a search with a search template

    Required authorization Index privileges: read

  • Destructive

    Delete an async search

    If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted.

  • Destructive

    Clear a scrolling search

    Clear the search context and results for a scrolling search.

  • Destructive

    Clear a scrolling search

    Clear the search context and results for a scrolling search.

  • Destructive

    Close a point in time

    A point in time must be opened explicitly before being used in search requests. The keepalive parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the keepalive period has elapsed.

Document

  • Read

    Get a document by its ID

    Get a document and its source or stored fields from an index. By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).

  • Read

    Check a document

    Verify that a document exists. For example, check to see if a document with the id 0 exists: HEAD my-index-000001/doc/0 If the document exists, the API returns a status code of 200 - OK. If the document doesn’t exist, the API returns 404 - Not Found.

  • Read

    Get a document's source

    Get the source of a document. For example: GET my-index-000001/source/1 You can use the source filtering parameters to control which parts of the source are returned: GET my-index-000001/source/1/?sourceincludes=.id&sourceexcludes=entities Required authorization Index privileges…

  • Read

    Check for a document source

    Check whether a document source exists in an index. For example: HEAD my-index-000001/source/1 A document's source is not available if it is disabled in the mapping. Required authorization Index privileges: read

  • Read

    Get multiple documents

    Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

  • Read

    Get multiple documents

    Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

  • Read

    Get multiple documents

    Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

  • Read

    Get multiple documents

    Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

  • Read

    Get multiple term vectors

    Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI.

  • Read

    Get multiple term vectors

    Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI.

  • Read

    Get multiple term vectors

    Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI.

  • Read

    Get multiple term vectors

    Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI.

  • Read

    Get term vector information

    Get information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.

  • Read

    Get term vector information

    Get information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.

  • Read

    Get term vector information

    Get information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.

  • Read

    Get term vector information

    Get information and statistics about terms in the fields of a particular document. You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.

  • Write

    Bulk index or delete documents

    Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

  • Write

    Bulk index or delete documents

    Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

  • Write

    Create a new document in the index

    You can index a new JSON document with the / /doc/ or / /create/ APIs Using create guarantees that the document is indexed only if it does not already exist. It returns a 409 response when a document with a same ID already exists in the index.

  • Write

    Create or update a document in an index

    Add a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

  • Write

    Throttle a delete by query operation

    Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

  • Write

    Create or update a document in an index

    Add a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

  • Write

    Reindex documents

    Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source.

  • Write

    Throttle a reindex operation

    Change the maximum number of documents to index per second for a particular reindex operation.

  • Write

    Update a document

    Update a document by running a script or passing a partial document. If the Elasticsearch security features are enabled, you must have the index or write index privilege for the target index or index alias. The script can update, delete, or skip modifying the document.

  • Write

    Update documents

    Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

  • Write

    Throttle an update by query operation

    Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

  • Destructive

    Bulk index or delete documents

    Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

  • Destructive

    Bulk index or delete documents

    Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

  • Destructive

    Create a new document in the index

    You can index a new JSON document with the / /doc/ or / /create/ APIs Using create guarantees that the document is indexed only if it does not already exist. It returns a 409 response when a document with a same ID already exists in the index.

  • Destructive

    Create or update a document in an index

    Add a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

  • Destructive

    Delete a document

    Remove a JSON document from the specified index. NOTE: You cannot send deletion requests directly to a data stream. To delete a document in a data stream, you must target the backing index containing the document.

  • Destructive

    Delete documents

    Deletes documents that match the specified query. If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: read delete or write You can specify the query criteria in the request URI or the reque…

Reindex

  • Read

    Get the status and progress of a specific reindex task

    This API follows reindex tasks across node-shutdown relocations, so callers can keep using the original task ID throughout the lifetime of the operation. Returned task IDs and timings reflect the original task, not its relocated successor. Relocated task IDs are also supported.

  • Read

    Get information about all currently running reindex tasks

    Reindex tasks that are mid-relocation between nodes are reported once, under their original task ID, so callers do not see duplicates across the relocation chain.

  • Destructive

    Cancel an ongoing reindex task

    If waitforcompletion is true (the default), the response contains the final task state after cancellation. If waitforcompletion is false, the response contains only acknowledged: true.

Cat

  • Read

    Get a compact list of aliases

    Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications.

  • Read

    Get a compact list of aliases

    Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications.

  • Read

    Get shard allocation information

    Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get shard allocation information

    Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get circuit breakers statistics

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. Required authorization Cluster privileges: monitor

  • Read

    Get circuit breakers statistics

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. Required authorization Cluster privileges: monitor

  • Read

    Get a compact list of component templates

    Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

  • Read

    Get a compact list of component templates

    Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

  • Read

    Get a document count

    Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

  • Read

    Get a document count

    Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

  • Read

    Get a document count

    Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

  • Read

    Get a document count

    Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

  • Read

    Get field data cache information

    Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get field data cache information

    Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get a compact cluster health summary

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters.

  • Read

    Get CAT help

    Get help for the CAT APIs.

  • Read

    Get a compact list of indices

    Get high-level information about indices in a cluster, including backing indices for data streams.

  • Read

    Get a compact list of indices

    Get high-level information about indices in a cluster, including backing indices for data streams.

  • Read

    Get master node information

    Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get data frame analytics jobs

    Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications.

  • Read

    Get data frame analytics jobs

    Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications.

  • Read

    Get datafeeds

    Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitorml, monitor, manageml, or manage cluster privileges to use this API.

  • Read

    Get datafeeds

    Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitorml, monitor, manageml, or manage cluster privileges to use this API.

  • Read

    Get anomaly detection jobs

    Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitorml, monitor, manageml, or manage cluster privileges to use this API.

  • Read

    Get anomaly detection jobs

    Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitorml, monitor, manageml, or manage cluster privileges to use this API.

  • Read

    Get trained models

    Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications.

  • Read

    Get trained models

    Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications.

  • Read

    Get node attribute information

    Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

  • Read

    Get a compact list of nodes

    Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

  • Read

    Get pending task information

    Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get plugin information

    Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

  • Read

    Get shard recovery information

    Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard.

  • Read

    Get shard recovery information

    Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard.

  • Read

    Get a compact list of snapshot repositories

    Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

  • Read

    Get segment information

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get segment information

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get shard information

    Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get shard information

    Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

  • Read

    Get a compact list of snapshots

    Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get a compact list of snapshots

    Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get a compact list of running tasks

    Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

  • Read

    Get index template information

    Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get index template information

    Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get thread pool statistics

    Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get thread pool statistics

    Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

  • Read

    Get transform information

    Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

  • Read

    Get transform information

    Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Ccr

  • Read

    Get auto-follow patterns

    Get cross-cluster replication auto-follow patterns. Required authorization Cluster privileges: manageccr

  • Read

    Get follower information

    Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. Required authorization Cluster privileges: monitor

  • Read

    Get follower stats

    Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. Required authorization Cluster privileges: monitor

  • Read

    Get auto-follow patterns

    Get cross-cluster replication auto-follow patterns. Required authorization Cluster privileges: manageccr

  • Read

    Get cross-cluster replication stats

    This API returns stats about auto-following and the same shard-level stats as the get follower stats API. Required authorization Cluster privileges: monitor

  • Write

    Forget a follower

    Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index.

  • Write

    Pause an auto-follow pattern

    Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored.

  • Write

    Pause a follower

    Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.

  • Write

    Resume an auto-follow pattern

    Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.

  • Write

    Resume a follower

    Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks.

  • Write

    Unfollow an index

    Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

  • Destructive

    Create or update auto-follow patterns

    Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.

  • Destructive

    Delete auto-follow patterns

    Delete a collection of cross-cluster replication auto-follow patterns. Required authorization Cluster privileges: manageccr

  • Destructive

    Create a follower

    Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.

Cluster

  • Read

    Explain the shard allocations

    Get explanations for shard allocations in the cluster. This API accepts the currentnode, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.

  • Read

    Get cluster-wide settings

    By default, it returns only settings that have been explicitly defined. Required authorization Cluster privileges: monitor

  • Read

    Get the cluster health status

    You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red.

  • Read

    Get the cluster health status

    You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red.

  • Read

    Get cluster subsystem info

    Returns basic information about the cluster.

  • Read

    Get the pending cluster tasks

    Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API returns a list of any pending updates to the cluster state.

  • Read

    Get remote cluster information

    Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. info This API returns information that reflects current state on the local cluster.

  • Read

    Get the cluster state

    Get comprehensive information about the state of the cluster.

  • Read

    Get the cluster state

    Get comprehensive information about the state of the cluster.

  • Read

    Get the cluster state

    Get comprehensive information about the state of the cluster.

  • Read

    Get cluster statistics

    Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). Required authorization Cluster privileges: monitor

  • Read

    Get cluster statistics

    Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). Required authorization Cluster privileges: monitor

  • Read

    Ping the cluster

    Get information about whether the cluster is running.

  • Read

    Get cluster repositories metering

    Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.

  • Read

    Get the hot threads for nodes

    Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. Required authorization Cluster privileges: monitor,manage

  • Read

    Get the hot threads for nodes

    Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node information

    By default, the API returns all attributes and core settings for cluster nodes.

  • Read

    Get node information

    By default, the API returns all attributes and core settings for cluster nodes.

  • Read

    Get node information

    By default, the API returns all attributes and core settings for cluster nodes.

  • Read

    Get node information

    By default, the API returns all attributes and core settings for cluster nodes.

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get node statistics

    Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. Required authorization Cluster privileges: monitor,manage

  • Read

    Get feature usage information

    Required authorization Cluster privileges: monitor,manage

  • Read

    Get feature usage information

    Required authorization Cluster privileges: monitor,manage

  • Read

    Get feature usage information

    Required authorization Cluster privileges: monitor,manage

  • Read

    Get feature usage information

    Required authorization Cluster privileges: monitor,manage

  • Write

    Explain the shard allocations

    Get explanations for shard allocations in the cluster. This API accepts the currentnode, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.

  • Write

    Update voting configuration exclusions

    Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.

  • Write

    Reroute the cluster

    Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.

  • Write

    Reload the keystore on nodes in the cluster

    Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster.

  • Write

    Reload the keystore on nodes in the cluster

    Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster.

  • Destructive

    Clear cluster voting config exclusions

    Remove master-eligible nodes from the voting configuration exclusion list.

  • Destructive

    Update the cluster settings

    Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in elasticsearch.yml.

  • Destructive

    Clear the archived repositories metering

    Clear the archived repositories metering information in the cluster. Required authorization Cluster privileges: monitor,manage

Indices

  • Read

    Get component templates

    Get information about component templates. Required authorization Cluster privileges: manageindextemplates

  • Read

    Check component templates

    Returns information about whether a particular component template exists.

  • Read

    Get component templates

    Get information about component templates. Required authorization Cluster privileges: manageindextemplates

  • Read

    Get the dangling indices

    If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

  • Read

    Get tokens from text analysis

    The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The index.analyze.maxtokencount setting enables you to limit the number of tokens that can be produced.

  • Read

    Get tokens from text analysis

    The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The index.analyze.maxtokencount setting enables you to limit the number of tokens that can be produced.

  • Read

    Get tokens from text analysis

    The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The index.analyze.maxtokencount setting enables you to limit the number of tokens that can be produced.

  • Read

    Get tokens from text analysis

    The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The index.analyze.maxtokencount setting enables you to limit the number of tokens that can be produced.

  • Read

    Get index information

    Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices. Required authorization Index privileges: viewindexmetadata,manage

  • Read

    Check indices

    Check if one or more indices, index aliases, or data streams exist.

  • Read

    Get aliases

    Retrieves information for one or more data stream or index aliases. Required authorization Index privileges: viewindexmetadata

  • Read

    Check aliases

    Check if one or more data stream or index aliases exist.

  • Read

    Get index templates

    Get information about one or more index templates. Required authorization Cluster privileges: manageindextemplates

  • Read

    Check index templates

    Check whether index templates exist. Required authorization Cluster privileges: manageindextemplates

  • Read

    Check existence of index templates

    Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

  • Read

    Get aliases

    Retrieves information for one or more data stream or index aliases. Required authorization Index privileges: viewindexmetadata

  • Read

    Check aliases

    Check if one or more data stream or index aliases exist.

  • Read

    Get field usage stats

    Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster.

  • Read

    Flush data streams or indices

    Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.

  • Read

    Flush data streams or indices

    Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.

  • Read

    Get aliases

    Retrieves information for one or more data stream or index aliases. Required authorization Index privileges: viewindexmetadata

  • Read

    Get aliases

    Retrieves information for one or more data stream or index aliases. Required authorization Index privileges: viewindexmetadata

  • Read

    Get field mapping definitions

    Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

  • Read

    Get field mapping definitions

    Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

  • Read

    Get index templates

    Get information about one or more index templates. Required authorization Cluster privileges: manageindextemplates

  • Read

    Get mapping definitions

    For data streams, the API retrieves mappings for the stream’s backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get mapping definitions

    For data streams, the API retrieves mappings for the stream’s backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index settings

    Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index settings

    Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index settings

    Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index settings

    Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index recovery information

    Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices. All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.

  • Read

    Get index recovery information

    Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices. All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.

  • Read

    Refresh an index

    A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

  • Read

    Refresh an index

    A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

  • Read

    Reload search analyzers

    Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

  • Read

    Resolve the cluster

    Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.

  • Read

    Resolve the cluster

    Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.

  • Read

    Resolve indices

    Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. Required authorization Index privileges: viewindexmetadata

  • Read

    Get index segments

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices. Required authorization Index privileges: monitor

  • Read

    Get index segments

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices. Required authorization Index privileges: monitor

  • Read

    Get index shard stores

    Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices. The index shard stores API returns the following information: The node on which each replica shard exists.

  • Read

    Get index shard stores

    Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices. The index shard stores API returns the following information: The node on which each replica shard exists.

  • Read

    Get index statistics

    For data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total aggregations. primaries are the values for only the primary shards.

  • Read

    Get index statistics

    For data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total aggregations. primaries are the values for only the primary shards.

  • Read

    Get index statistics

    For data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total aggregations. primaries are the values for only the primary shards.

  • Read

    Get index statistics

    For data streams, the API retrieves statistics for the stream's backing indices. By default, the returned statistics are index-level with primaries and total aggregations. primaries are the values for only the primary shards.

  • Read

    Validate a query

    Validates a query without running it.

  • Read

    Validate a query

    Validates a query without running it.

  • Read

    Validate a query

    Validates a query without running it.

  • Read

    Validate a query

    Validates a query without running it.

  • Write

    Create or update a component template

    Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composedof list.

  • Write

    Import a dangling index

    If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

  • Write

    Clear the cache

    Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices. By default, the clear cache API clears all caches. To clear only specific caches, use the fielddata, query, or request parameters.

  • Write

    Clear the cache

    Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices. By default, the clear cache API clears all caches. To clear only specific caches, use the fielddata, query, or request parameters.

  • Write

    Clone an index

    Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index.

  • Write

    Close an index

    A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index.

  • Write

    Create or update an alias

    Adds a data stream or index to an alias.

  • Write

    Create or update an alias

    Adds a data stream or index to an alias.

  • Write

    Create or update an index template

    Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation.

  • Write

    Analyze the index disk usage

    Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

  • Write

    Flush data streams or indices

    Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.

  • Write

    Flush data streams or indices

    Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.

  • Write

    Force a merge

    Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing indices.

  • Write

    Force a merge

    Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing indices.

  • Write

    Update field mappings

    Add new fields to an existing data stream or index. You can use the update mapping API to: - Add a new field to an existing index - Update mappings for multiple indices in a single request - Add new properties to an object field - Enable multi-fields for an existing field - Upda…

  • Write

    Open a closed index

    For data streams, the API opens any closed backing indices. A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index.

  • Write

    Refresh an index

    A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

  • Write

    Refresh an index

    A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

  • Write

    Reload search analyzers

    Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

  • Write

    Resolve indices

    Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. Required authorization Index privileges: viewindexmetadata

  • Write

    Roll over to a new index

    TIP: To automate rollovers, use index lifecycle management (ILM) in deployments that support it. Serverless does not support ILM. For data streams in Serverless, use data stream lifecycle instead. The rollover API creates a new index for a data stream or index alias.

  • Write

    Roll over to a new index

    TIP: To automate rollovers, use index lifecycle management (ILM) in deployments that support it. Serverless does not support ILM. For data streams in Serverless, use data stream lifecycle instead. The rollover API creates a new index for a data stream or index alias.

  • Write

    Shrink an index

    Shrink an index into a new index with fewer primary shards. Before you can shrink an index: The index must be read-only. A copy of every shard in the index must reside on the same node. The index must have a green health status.

  • Write

    Simulate an index

    Get the index configuration that would be applied to the specified index from an existing index template. Required authorization Cluster privileges: manageindextemplates

  • Write

    Simulate an index template

    Get the index configuration that would be applied by a particular index template. Required authorization Cluster privileges: manageindextemplates

  • Write

    Simulate an index template

    Get the index configuration that would be applied by a particular index template. Required authorization Cluster privileges: manageindextemplates

  • Write

    Split an index

    Split an index into a new index with more primary shards. Before you can split an index: The index must be read-only. The cluster health status must be green.

  • Write

    Update aliases and delete indices atomically

    Applies one or more actions in a single request: - Add a data stream or index to an alias. - Remove a data stream or index from an alias. - Delete an index in that same request, so the deletion and the alias changes are applied together.

  • Destructive

    Create or update a component template

    Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composedof list.

  • Destructive

    Delete component templates

    Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. Required authorization Cluster privileges: manageindextemplates

  • Destructive

    Delete a dangling index

    If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

  • Destructive

    Add an index block

    Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

  • Destructive

    Remove an index block

    Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types. Required authorization Index privileges: manage

  • Destructive

    Clone an index

    Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index.

  • Destructive

    Create an index

    You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following: Settings for the index. Mappings for fields in the index.

  • Destructive

    Delete indices

    Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards. You cannot delete the current write index of a data stream.

  • Destructive

    Create or update an alias

    Adds a data stream or index to an alias.

  • Destructive

    Delete an alias

    Removes a data stream or index from an alias. Required authorization Index privileges: manage

  • Destructive

    Create or update an alias

    Adds a data stream or index to an alias.

  • Destructive

    Delete an alias

    Removes a data stream or index from an alias. Required authorization Index privileges: manage

  • Destructive

    Delete data stream lifecycles

    Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. Required authorization Index privileges: managedatastreamlifecycle

  • Destructive

    Create or update an index template

    Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation.

  • Destructive

    Delete an index template

    The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

  • Destructive

    Update field mappings

    Add new fields to an existing data stream or index. You can use the update mapping API to: - Add a new field to an existing index - Update mappings for multiple indices in a single request - Add new properties to an object field - Enable multi-fields for an existing field - Upda…

  • Destructive

    Update index settings

    Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the default value, use a null value.

  • Destructive

    Update index settings

    Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the default value, use a null value.

  • Destructive

    Shrink an index

    Shrink an index into a new index with fewer primary shards. Before you can shrink an index: The index must be read-only. A copy of every shard in the index must reside on the same node. The index must have a green health status.

  • Destructive

    Split an index

    Split an index into a new index with more primary shards. Before you can split an index: The index must be read-only. The cluster health status must be green.

Connector

  • Read

    Get a connector

    Get the details about a connector.

  • Read

    Get all connectors

    Get information about all connectors.

  • Read

    Get a connector sync job

    GET /_connector/_sync_job/{connector_sync_job_id}

  • Read

    Get all connector sync jobs

    Get information about all stored connector sync jobs listed by their creation date in ascending order.

  • Write

    Create a connector

    Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.

  • Write

    Create a connector sync job

    Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

  • Destructive

    Check in a connector

    Update the lastseen field in the connector and set it to the current timestamp.

  • Destructive

    Create or update a connector

    PUT /_connector/{connector_id}

  • Destructive

    Delete a connector

    Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.

  • Destructive

    Create or update a connector

    PUT /_connector

  • Destructive

    Cancel a connector sync job

    Cancel a connector sync job, which sets the status to cancelling and updates cancellationrequestedat to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

  • Destructive

    Check in a connector sync job

    Check in a connector sync job and set the lastseen field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.

  • Destructive

    Claim a connector sync job

    This action updates the job status to inprogress and sets the lastseen and startedat timestamps to the current time. Additionally, it can set the synccursor property for the sync job. This API is not intended for direct connector management by users.

  • Destructive

    Delete a connector sync job

    Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

  • Destructive

    Set a connector sync job error

    Set the error field for a connector sync job and set its status to error. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

  • Destructive

    Set the connector sync job stats

    Stats include: deleteddocumentcount, indexeddocumentcount, indexeddocumentvolume, and totaldocumentcount. You can also update lastseen. This API is mainly used by the connector service for updating sync job information.

  • Destructive

    Activate the connector draft filter

    Activates the valid draft filtering for a connector.

  • Destructive

    Update the connector API key ID

    Update the apikeyid and apikeysecretid fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors.

  • Destructive

    Update the connector configuration

    Update the configuration field in the connector document.

  • Destructive

    Update the connector error field

    Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

  • Destructive

    Update the connector features

    Update the connector features in the connector document. This API can be used to control the following aspects of a connector: document-level security incremental syncs advanced sync rules basic sync rules Normally, the running connector service automatically manages these featu…

  • Destructive

    Update the connector filtering

    Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service.

  • Destructive

    Update the connector draft filtering validation

    Update the draft filtering validation info for a connector.

  • Destructive

    Update the connector index name

    Update the indexname field of a connector, specifying the index where the data ingested by the connector is stored.

  • Destructive

    Update the connector name and description

    PUT /_connector/{connector_id}/_name

  • Destructive

    Update the connector isnative flag

    Update the connector isnative flag

  • Destructive

    Update the connector pipeline

    When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

  • Destructive

    Update the connector scheduling

    PUT /_connector/{connector_id}/_scheduling

  • Destructive

    Update the connector service type

    PUT /_connector/{connector_id}/_service_type

  • Destructive

    Update the connector status

    PUT /_connector/{connector_id}/_status

Script

  • Read

    Get a script or search template

    Retrieves a stored script or search template. Required authorization Cluster privileges: manage

  • Read

    Get script contexts

    Get a list of supported script contexts and their methods. Required authorization Cluster privileges: manage

  • Read

    Get script languages

    Get a list of available script types, languages, and contexts. Required authorization Cluster privileges: manage

  • Read

    Run a script

    Runs a script and returns a result. Use this API to build and test scripts, such as when defining a script for a runtime field. This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.

  • Write

    Create or update a script or search template

    Creates or updates a stored script or search template. Required authorization Cluster privileges: manage

  • Write

    Create or update a script or search template

    Creates or updates a stored script or search template. Required authorization Cluster privileges: manage

  • Write

    Run a script

    Runs a script and returns a result. Use this API to build and test scripts, such as when defining a script for a runtime field. This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.

  • Destructive

    Create or update a script or search template

    Creates or updates a stored script or search template. Required authorization Cluster privileges: manage

  • Destructive

    Delete a script or search template

    Deletes a stored script or search template. Required authorization Cluster privileges: manage

  • Destructive

    Create or update a script or search template

    Creates or updates a stored script or search template. Required authorization Cluster privileges: manage

Security

  • Read

    Authenticate a user

    Authenticates a user and returns information about the authenticated user. Include the user information in a basic auth header.

  • Read

    Get roles

    Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. Required authorization Cluster privileges: readsecurity

  • Read

    Get API key information

    Retrieves information for one or more API keys. NOTE: If you have only the manageownapikey privilege, this API returns only the API keys that you own.

  • Read

    Get application privileges

    To use this API, you must have one of the following privileges: The readsecurity cluster privilege (or a greater privilege such as managesecurity or all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Read

    Get roles

    Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. Required authorization Cluster privileges: readsecurity

  • Read

    Get role mappings

    Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

  • Read

    Get users

    Get information about users in the native realm and built-in users. Required authorization Cluster privileges: readsecurity

  • Read

    Get service accounts

    Get a list of service accounts that match the provided path parameters. Built-in service accounts ship with Elasticsearch in the elastic namespace; user-managed service accounts are created with the put user-managed service account API.

  • Read

    Enroll Kibana

    Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. NOTE: This API is currently intended for internal use only by Kibana.

  • Read

    Enroll a node

    Enroll a new node to allow it to join an existing cluster with security features enabled. The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.

  • Read

    Get builtin privileges

    Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. Required authorization Cluster privileges: managesecurity

  • Read

    Get application privileges

    To use this API, you must have one of the following privileges: The readsecurity cluster privilege (or a greater privilege such as managesecurity or all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Read

    Get application privileges

    To use this API, you must have one of the following privileges: The readsecurity cluster privilege (or a greater privilege such as managesecurity or all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Read

    Get role mappings

    Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

  • Read

    Get service accounts

    Get a list of service accounts that match the provided path parameters. Built-in service accounts ship with Elasticsearch in the elastic namespace; user-managed service accounts are created with the put user-managed service account API.

  • Read

    Get service accounts

    Get a list of service accounts that match the provided path parameters. Built-in service accounts ship with Elasticsearch in the elastic namespace; user-managed service accounts are created with the put user-managed service account API.

  • Read

    Get service account credentials

    To use this API, you must have at least the readsecurity cluster privilege (or a greater privilege such as manageserviceaccount or managesecurity).

  • Read

    Get security index settings

    Get the user-configurable settings for the security internal index (.security and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown.

  • Read

    Get security stats

    Gather security usage statistics from all node(s) within the cluster. Required authorization Cluster privileges: monitor

  • Read

    Get a token

    Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.

  • Read

    Get users

    Get information about users in the native realm and built-in users. Required authorization Cluster privileges: readsecurity

  • Read

    Get user privileges

    Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

  • Read

    Get a user profile

    Get a user's profile using the unique profile ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.

  • Read

    Check user privileges

    Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

  • Read

    Check user privileges

    Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

  • Read

    Check user privileges

    Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

  • Read

    Check user privileges

    Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature.

  • Read

    Check user profile privileges

    Determine whether the users associated with the specified user profile IDs have all the requested privileges. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Read

    Check user profile privileges

    Determine whether the users associated with the specified user profile IDs have all the requested privileges. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Read

    Find API keys with a query

    Get a paginated list of API keys and their information. You can optionally filter the results with a query. To use this API, you must have at least the manageownapikey or the readsecurity cluster privileges.

  • Read

    Find API keys with a query

    Get a paginated list of API keys and their information. You can optionally filter the results with a query. To use this API, you must have at least the manageownapikey or the readsecurity cluster privileges.

  • Read

    Find roles with a query

    Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones.

  • Read

    Find roles with a query

    Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones.

  • Read

    Find users with a query

    Get information for users in a paginated manner. You can optionally filter the results with a query. NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. Required authorization Cluster privileges: readsecurity

  • Read

    Find users with a query

    Get information for users in a paginated manner. You can optionally filter the results with a query. NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. Required authorization Cluster privileges: readsecurity

  • Read

    Create SAML service provider metadata

    Generate SAML metadata for a SAML 2.0 Service Provider. The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.

  • Read

    Suggest a user profile

    Get suggestions for user profiles that match specified search criteria. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Read

    Get SSL certificates

    Get information about the X.509 certificates that are used to encrypt communications in the cluster.

  • Write

    Reset the project encryption key

    Destroy the current project encryption key (PEK) and generate a new one. This is the recovery path for when the on-disk encrypted PEK becomes permanently inaccessible, for example because the key encryption material protecting it was lost.

  • Write

    Activate a user profile

    Create or update a user profile on behalf of another user. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Write

    Bulk create or update roles

    The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. Required authorization Cluster privileges: managesecurity

  • Write

    Bulk update API keys

    Update the attributes for multiple API keys. IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.

  • Write

    Change passwords

    Change the passwords of users in the native realm and built-in users.

  • Write

    Change passwords

    Change the passwords of users in the native realm and built-in users.

  • Write

    Clear the API key cache

    Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. Required authorization Cluster privileges: managesecurity

  • Write

    Clear the privileges cache

    Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. Required authorization Cluster privileges: managesecurity

  • Write

    Clear the user cache

    Evict users from the user cache. You can completely clear the cache or evict specific users. User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.

  • Write

    Clear the roles cache

    Evict roles from the native role cache. Required authorization Cluster privileges: managesecurity

  • Write

    Clear service account token caches

    Evict a subset of all entries from the service account token caches. Two separate caches exist for service account tokens: one cache for tokens backed by the servicetokens file, and another for tokens backed by the .security index.

  • Write

    Clone an API key

    Create a copy of an existing API key with a new ID. The cloned key inherits the role descriptors of the source key.

  • Write

    Create an API key

    Create an API key for access without requiring basic authentication. IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error.

  • Write

    Create a cross-cluster API key

    Create an API key of the crosscluster type for the API key based remote cluster access. A crosscluster API key cannot be used to authenticate through the REST interface. IMPORTANT: To authenticate this request you must use a credential that is not an API key.

  • Write

    Create a service account token

    Create a service accounts token for access without requiring basic authentication.

  • Write

    Create a service account token

    Create a service accounts token for access without requiring basic authentication.

  • Write

    Delegate PKI authentication

    This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has delegation.enabled set to true.

  • Write

    Create or update roles

    The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.

  • Write

    Create or update role mappings

    Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.

  • Write

    Create or update users

    Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API.

  • Write

    Disable users

    Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. Required authorization Cluster privileges: managesecurity

  • Write

    Disable a user profile

    Disable user profiles so that they are not visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Write

    Enable users

    Enable users in the native realm. By default, when you create users, they are enabled. Required authorization Cluster privileges: managesecurity

  • Write

    Enable a user profile

    Enable user profiles to make them visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Write

    Create or update application privileges

    To use this API, you must have one of the following privileges: The managesecurity cluster privilege (or a greater privilege such as all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Write

    Grant an API key

    Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.

  • Write

    Authenticate OpenID Connect

    Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.

  • Write

    Logout of OpenID Connect

    Invalidate an access token and a refresh token that were generated as a response to the /security/oidc/authenticate API.

  • Write

    Prepare OpenID connect authentication

    Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.

  • Write

    Authenticate SAML

    Submit a SAML response message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

  • Write

    Logout of SAML completely

    Verifies the logout response sent from the SAML IdP. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

  • Write

    Invalidate SAML

    Submit a SAML LogoutRequest message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

  • Write

    Logout of SAML

    Submits a request to invalidate an access token and refresh token. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

  • Write

    Prepare SAML authentication

    Create a SAML authentication request ( ) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. NOTE: This API is intended for use by custom web applications other than Kibana.

  • Write

    Suggest a user profile

    Get suggestions for user profiles that match specified search criteria. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Write

    Update user profile data

    Update specific data for the user profile that is associated with a unique ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Destructive

    Bulk delete roles

    The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. Required authorization Cluster privileges: managesecurity

  • Destructive

    Change passwords

    Change the passwords of users in the native realm and built-in users.

  • Destructive

    Change passwords

    Change the passwords of users in the native realm and built-in users.

  • Destructive

    Clone an API key

    Create a copy of an existing API key with a new ID. The cloned key inherits the role descriptors of the source key.

  • Destructive

    Create an API key

    Create an API key for access without requiring basic authentication. IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error.

  • Destructive

    Invalidate API keys

    This API invalidates API keys created by the create API key or grant API key APIs.

  • Destructive

    Create a service account token

    Create a service accounts token for access without requiring basic authentication.

  • Destructive

    Delete service account tokens

    Delete service account tokens for a service in a specified namespace.

  • Destructive

    Delete application privileges

    To use this API, you must have one of the following privileges: The managesecurity cluster privilege (or a greater privilege such as all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Destructive

    Create or update roles

    The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.

  • Destructive

    Delete roles

    Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files.

  • Destructive

    Create or update role mappings

    Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.

  • Destructive

    Delete role mappings

    Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files.

  • Destructive

    Create or update users

    Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API.

  • Destructive

    Delete users

    Delete users from the native realm. Required authorization Cluster privileges: managesecurity

  • Destructive

    Create user-managed service accounts

    Create a service account in a namespace of your own, or replace one that already exists. A replacement is not a partial update: every write applies the defaults, so an account that was disabled and is then written again without enabled comes back enabled.

  • Destructive

    Delete user-managed service accounts

    Delete a service account from a namespace of your own. Deleting an account that still has service tokens is rejected unless force is true.

  • Destructive

    Disable users

    Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. Required authorization Cluster privileges: managesecurity

  • Destructive

    Disable a user profile

    Disable user profiles so that they are not visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Destructive

    Enable users

    Enable users in the native realm. By default, when you create users, they are enabled. Required authorization Cluster privileges: managesecurity

  • Destructive

    Enable a user profile

    Enable user profiles to make them visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

  • Destructive

    Create or update application privileges

    To use this API, you must have one of the following privileges: The managesecurity cluster privilege (or a greater privilege such as all). The "Manage Application Privileges" global privilege for the application being referenced in the request.

  • Destructive

    Update security index settings

    Update the user-configurable settings for the security internal index (.security and associated indices). Only a subset of settings are allowed to be modified. This includes index.autoexpandreplicas and index.numberofreplicas.

  • Destructive

    Invalidate a token

    The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the xpack.security.authc.token.timeout setting.

  • Destructive

    Update an API key

    Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata. To use this API, you must have at least the manageownapikey cluster privilege.

  • Destructive

    Update a cross-cluster API key

    Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. To use this API, you must have at least the managesecurity cluster privilege. Users can only update API keys that they created.

  • Destructive

    Update user profile data

    Update specific data for the user profile that is associated with a unique ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.

Enrich

  • Read

    Get an enrich policy

    Returns information about an enrich policy.

  • Read

    Get an enrich policy

    Returns information about an enrich policy.

  • Read

    Get enrich stats

    Returns enrich coordinator statistics and information about enrich policies that are currently executing.

  • Destructive

    Create an enrich policy

    Creates an enrich policy.

  • Destructive

    Delete an enrich policy

    Deletes an existing enrich policy and its enrich index.

  • Destructive

    Run an enrich policy

    Create the enrich index for an existing enrich policy.

Eql

  • Read

    Get async EQL search results

    Get the current status and available results for an async EQL search or a stored synchronous EQL search.

  • Read

    Get the async EQL status

    Get the current status for an async EQL search or a stored synchronous EQL search without returning results.

  • Read

    Get EQL search results

    Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.

  • Destructive

    Delete an async EQL search

    Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.

Esql

  • Read

    Get async ES|QL query results

    Get the current status and available results or stored results for an ES|QL asynchronous query. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.

  • Read

    Get ES|QL data sources

    Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array. Required authorization Cluster privileges: manage

  • Read

    Get ES|QL datasets

    Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array. Required authorization Index privileges: manage

  • Read

    Get an ES|QL view

    Returns a stored ES|QL view. Required authorization Index privileges: readviewmetadata

  • Read

    Get ES|QL data sources

    Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array. Required authorization Cluster privileges: manage

  • Read

    Get ES|QL datasets

    Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array. Required authorization Index privileges: manage

  • Read

    Get a specific running ES|QL query information

    Returns an object extended information about a running ES|QL query. Required authorization Cluster privileges: monitoresql

  • Read

    Get an ES|QL view

    Returns a stored ES|QL view. Required authorization Index privileges: readviewmetadata

  • Read

    Get running ES|QL queries information

    Returns an object containing IDs and other information about the running ES|QL queries. Required authorization Cluster privileges: monitoresql

  • Write

    Run an async ES|QL query

    Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.

  • Write

    Stop async ES|QL query

    This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. Required authorization Index privileges: read

  • Write

    Run an ES|QL query

    Get search results for an ES|QL (Elasticsearch query language) query. Required authorization Index privileges: read

  • Destructive

    Delete an async ES|QL query

    If the query is still running, it is cancelled. Otherwise, the stored results are deleted.

  • Destructive

    Create or update an ES|QL data source

    Creates or replaces a named, type-specific data source configuration for ES|QL data federation. Datasets reference data source configurations to access external data. Names must be lowercase and follow index or alias naming rules. Required authorization Cluster privileges: manage

  • Destructive

    Delete ES|QL data sources

    Deletes one or more data sources used in ES|QL data federation. Fails with 409 if any dataset references one of the named data sources; delete the dependent datasets first. Required authorization Cluster privileges: manage

  • Destructive

    Create or update an ES|QL dataset

    Creates or replaces a dataset that references a data source in ES|QL data federation. Dataset names participate in the index namespace and must follow index or alias naming rules. Returns 404 if the referenced data source does not exist.

  • Destructive

    Delete ES|QL datasets

    Deletes one or more datasets used in ES|QL data federation. If any specified dataset does not exist, the request fails and no datasets are deleted. Required authorization Index privileges: manage

  • Destructive

    Create or update an ES|QL view

    Required authorization Index privileges: createview

  • Destructive

    Delete an ES|QL view

    Deletes a stored ES|QL view. Required authorization Index privileges: deleteview

Features

  • Read

    Get the features

    Get a list of features that can be included in snapshots using the featurestates field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot.

  • Write

    Reset the features

    Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster.

Fleet

  • Read

    Get global checkpoints

    Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project.

  • Read

    Run multiple Fleet searches

    Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the waitforcheckpoints parameter. Required authorization Index privileges: read

  • Read

    Run multiple Fleet searches

    Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the waitforcheckpoints parameter. Required authorization Index privileges: read

  • Write

    Run multiple Fleet searches

    Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the waitforcheckpoints parameter. Required authorization Index privileges: read

  • Write

    Run multiple Fleet searches

    Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the waitforcheckpoints parameter. Required authorization Index privileges: read

  • Write

    Run a Fleet search

    The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. Required authorization Index privileges: read

Graph

  • Read

    Explore graph analytics

    Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.

  • Write

    Explore graph analytics

    Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.

Health report

  • Read

    Get the cluster health

    Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality. Each indicator has a health status of: green, unknown, yellow or red.

  • Read

    Get the cluster health

    Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality. Each indicator has a health status of: green, unknown, yellow or red.

Ilm

  • Read

    Get lifecycle policies

    Required authorization Cluster privileges: manageilm,readilm

  • Read

    Explain the lifecycle state

    Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices.

  • Read

    Get lifecycle policies

    Required authorization Cluster privileges: manageilm,readilm

  • Read

    Get the ILM status

    Get the current index lifecycle management status. Required authorization Cluster privileges: readilm

  • Write

    Migrate to data tiers routing

    Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template.

  • Write

    Move to a lifecycle step

    Manually move an index into a specific step in the lifecycle policy and run that step. WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed.

  • Write

    Retry a policy

    Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step.

  • Write

    Start the ILM plugin

    Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API. Required authorization Cluster privileges: manageilm

  • Write

    Stop the ILM plugin

    Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

  • Destructive

    Create or update a lifecycle policy

    If the specified policy exists, it is replaced and the policy version is incremented. NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. Required authorization Index privileges: manage Cluster privileges: manageilm

  • Destructive

    Delete a lifecycle policy

    You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. Required authorization Cluster privileges: manageilm

  • Destructive

    Remove policies from an index

    Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices. Required authorization Index privileges: manageilm

Migration

  • Read

    Get the migration reindexing status

    Get the status of a migration reindex attempt for a data stream or index.

  • Read

    Get deprecation information

    Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.

  • Read

    Get deprecation information

    Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.

  • Read

    Get feature migration information

    Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

  • Write

    Create an index from a source index

    Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

  • Write

    Reindex legacy backing indices

    Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task.

  • Write

    Start the feature migration

    Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process.

  • Destructive

    Cancel a migration reindex operation

    Cancel a migration reindex attempt for a data stream or index.

  • Destructive

    Create an index from a source index

    Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

Data stream

  • Read

    Get data streams

    Get information about one or more data streams. Required authorization Index privileges: viewindexmetadata

  • Read

    Get data stream stats

    Get statistics for one or more data streams. Required authorization Index privileges: monitor

  • Read

    Get data stream stats

    Get statistics for one or more data streams. Required authorization Index privileges: monitor

  • Read

    Get data stream lifecycles

    Get the data stream lifecycle configuration of one or more data streams. Required authorization Index privileges: managedatastreamlifecycle

  • Read

    Get data stream options

    Get the data stream options configuration of one or more data streams.

  • Read

    Get the status for a data stream lifecycle

    Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

  • Read

    Get data stream lifecycle stats

    Get statistics about the data streams that are managed by a data stream lifecycle. Required authorization Cluster privileges: monitor

  • Read

    Get data streams

    Get information about one or more data streams. Required authorization Index privileges: viewindexmetadata

  • Read

    Get data stream mappings

    Get mapping information for one or more data streams. Required authorization Index privileges: viewindexmetadata

  • Read

    Get data stream settings

    Get setting information for one or more data streams. Required authorization Index privileges: viewindexmetadata

  • Write

    Downsample an index

    Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics: - When running in aggregate mode, it pre-calculates and stores statistical summaries (min, max, sum, valuecount and avg) for each metric field grouped by a config…

  • Write

    Convert an index alias to a data stream

    Converts an index alias to a data stream. You must have a matching index template that is data stream enabled.

  • Write

    Update data streams

    Performs one or more data stream modification actions in a single atomic operation.

  • Write

    Promote a data stream

    Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.

  • Destructive

    Create a data stream

    You must have a matching index template with data stream enabled. Required authorization Index privileges: createindex

  • Destructive

    Delete data streams

    Deletes one or more data streams and their backing indices. Required authorization Index privileges: deleteindex

  • Destructive

    Update data stream lifecycles

    Update the data stream lifecycle of the specified data streams. Required authorization Index privileges: managedatastreamlifecycle

  • Destructive

    Update data stream options

    Update the data stream options of the specified data streams.

  • Destructive

    Delete data stream options

    Removes the data stream options from a data stream.

  • Destructive

    Update data stream mappings

    This API can be used to override mappings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches.

  • Destructive

    Update data stream settings

    NOTE: Available in 8.19. Not available in earlier versions. This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches.

Inference

  • Read

    Get an inference endpoint

    This API requires the monitorinference cluster privilege (the built-in inferenceadmin and inferenceuser roles grant this privilege).

  • Read

    Get an inference endpoint

    This API requires the monitorinference cluster privilege (the built-in inferenceadmin and inferenceuser roles grant this privilege).

  • Read

    Get the inference region policy

    Required authorization Cluster privileges: monitorinference

  • Read

    Get an inference endpoint

    This API requires the monitorinference cluster privilege (the built-in inferenceadmin and inferenceuser roles grant this privilege).

  • Read

    Get an inference endpoint

    This API requires the monitorinference cluster privilege (the built-in inferenceadmin and inferenceuser roles grant this privilege).

  • Write

    Perform streaming chat completion inference on the service

    The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the chatcompletion task type.

  • Write

    Perform completion inference on the service

    Get responses for completion tasks. This API works only with the completion task type.

  • Write

    Perform inference on the service

    This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks.

  • Write

    Perform inference on the service

    This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks.

  • Write

    Perform document extraction inference on the service

    Extract the content of documents, such as PDFs or images of documents, into a textual format. Required authorization Cluster privileges: monitorinference

  • Write

    Perform dense embedding inference on the service

    POST /_inference/embedding/{inference_id}

  • Write

    Perform non-streaming chat completion inference on the service

    The chat completion inference API enables rich responses for chat completion tasks. It only works with the chatcompletion task type. NOTE: The chatcompletion task type supports both streaming and non-streaming.

  • Write

    Perform reranking inference on the service

    Required authorization Cluster privileges: monitorinference

  • Write

    Perform sparse embedding inference on the service

    POST /_inference/sparse_embedding/{inference_id}

  • Write

    Perform streaming completion inference on the service

    Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. This API works only with the completion task type.

  • Write

    Perform text embedding inference on the service

    POST /_inference/text_embedding/{inference_id}

  • Destructive

    Create an inference endpoint

    IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.

  • Destructive

    Delete an inference endpoint

    This API requires the manageinference cluster privilege (the built-in inferenceadmin role grants this privilege).

  • Destructive

    Create an inference endpoint

    IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.

  • Destructive

    Delete an inference endpoint

    This API requires the manageinference cluster privilege (the built-in inferenceadmin role grants this privilege).

  • Destructive

    Create or update the inference region policy

    The region policy restricts inference to a set of allowed geographic areas or cloud service provider regions. Required authorization Cluster privileges: manageinference

  • Destructive

    Delete the inference region policy

    Required authorization Cluster privileges: manageinference

  • Destructive

    Create a AI21 inference endpoint

    Create an inference endpoint to perform an inference task with the ai21 service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an AlibabaCloud AI Search inference endpoint

    Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Amazon Bedrock inference endpoint

    Create an inference endpoint to perform an inference task with the amazonbedrock service. info You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys.

  • Destructive

    Create an Amazon SageMaker inference endpoint

    Create an inference endpoint to perform an inference task with the amazonsagemaker service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Anthropic inference endpoint

    Create an inference endpoint to perform an inference task with the anthropic service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Azure AI studio inference endpoint

    Create an inference endpoint to perform an inference task with the azureaistudio service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Azure OpenAI inference endpoint

    Create an inference endpoint to perform an inference task with the azureopenai service.

  • Destructive

    Create a Cohere inference endpoint

    Create an inference endpoint to perform an inference task with the cohere service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Contextual AI inference endpoint

    Create an inference endpoint to perform an inference task with the contexualai service. To review the available rerank models, refer to . Required authorization Cluster privileges: manageinference

  • Destructive

    Create a custom inference endpoint

    The custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations. The custom service gives you the ability to define the headers, url, query parameters, request body, and secrets.

  • Destructive

    Create a DeepSeek inference endpoint

    Create an inference endpoint to perform an inference task with the deepseek service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Elasticsearch inference endpoint

    Create an inference endpoint to perform an inference task with the elasticsearch service. info Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.

  • Destructive

    Create a Fireworks AI inference endpoint

    Create an inference endpoint to perform an inference task with the fireworksai service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Google AI Studio inference endpoint

    Create an inference endpoint to perform an inference task with the googleaistudio service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Google Vertex AI inference endpoint

    Create an inference endpoint to perform an inference task with the googlevertexai service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Groq inference endpoint

    Create an inference endpoint to perform an inference task with the groq service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Hugging Face inference endpoint

    Create an inference endpoint to perform an inference task with the huggingface service. Supported tasks include: textembedding, completion, and chatcompletion. To configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.

  • Destructive

    Create an JinaAI inference endpoint

    Create an inference endpoint to perform an inference task with the jinaai service. To review the available rerank models, refer to . To review the available embedding and textembedding models, refer to . Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Llama inference endpoint

    Create an inference endpoint to perform an inference task with the llama service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Mistral inference endpoint

    Create an inference endpoint to perform an inference task with the mistral service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an Nvidia inference endpoint

    Create an inference endpoint to perform an inference task with the nvidia service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an OpenAI inference endpoint

    Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs. Required authorization Cluster privileges: manageinference

  • Destructive

    Create an OpenShift AI inference endpoint

    Create an inference endpoint to perform an inference task with the openshiftai service. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a VoyageAI inference endpoint

    Create an inference endpoint to perform an inference task with the voyageai service. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. Required authorization Cluster privileges: manageinference

  • Destructive

    Create a Watsonx inference endpoint

    Create an inference endpoint to perform an inference task with the watsonxai service. You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service.

  • Destructive

    Update an inference endpoint

    Modify tasksettings, secrets (within servicesettings), or numallocations for an inference endpoint, depending on the specific endpoint service and tasktype.

  • Destructive

    Update an inference endpoint

    Modify tasksettings, secrets (within servicesettings), or numallocations for an inference endpoint, depending on the specific endpoint service and tasktype.

Info

  • Read

    Get cluster info

    Get basic build, version, and cluster information. ::: In Serverless, version.number always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated.

Ingest

  • Read

    Get GeoIP database configurations

    Get information about one or more IP geolocation database configurations.

  • Read

    Get IP geolocation database configurations

    Required authorization Cluster privileges: manage

  • Read

    Get pipelines

    Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.

  • Read

    Get GeoIP statistics

    Get download statistics for GeoIP2 databases that are used with the GeoIP processor.

  • Read

    Get GeoIP database configurations

    Get information about one or more IP geolocation database configurations.

  • Read

    Get IP geolocation database configurations

    Required authorization Cluster privileges: manage

  • Read

    Get pipelines

    Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.

  • Read

    Run a grok processor

    Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.

  • Read

    Simulate a pipeline

    Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. Required authorization Cluster privileges: readpipeline

  • Read

    Simulate a pipeline

    Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. Required authorization Cluster privileges: readpipeline

  • Read

    Simulate data ingestion

    Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.

  • Read

    Simulate data ingestion

    Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.

  • Write

    Simulate a pipeline

    Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. Required authorization Cluster privileges: readpipeline

  • Write

    Simulate a pipeline

    Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. Required authorization Cluster privileges: readpipeline

  • Write

    Simulate data ingestion

    Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.

  • Write

    Simulate data ingestion

    Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.

  • Destructive

    Create or update a GeoIP database configuration

    Refer to the create or update IP geolocation database configuration API.

  • Destructive

    Delete GeoIP database configurations

    Delete one or more IP geolocation database configurations.

  • Destructive

    Create or update an IP geolocation database configuration

    Required authorization Cluster privileges: manage

  • Destructive

    Delete IP geolocation database configurations

    Required authorization Cluster privileges: manage

  • Destructive

    Create or update a pipeline

    Changes made using this API take effect immediately.

  • Destructive

    Delete pipelines

    Delete one or more ingest pipelines.

License

  • Read

    Get license information

    Get information about your Elastic license including its type, its status, when it was issued, and when it expires. info If the master node is generating a new cluster state, the get license API may return a 404 Not Found response.

  • Read

    Get the basic license status

    Required authorization Cluster privileges: monitor

  • Read

    Get the trial status

    Required authorization Cluster privileges: monitor

  • Write

    Update the license

    You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.

  • Write

    Start a basic license

    Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license.

  • Write

    Start a trial

    Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.

  • Destructive

    Update the license

    You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.

  • Destructive

    Delete the license

    When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API. Required authorization Cluster privileges: manage

Logstash

  • Read

    Get Logstash pipelines

    Get pipelines that are used for Logstash Central Management. Required authorization Cluster privileges: managelogstashpipelines

  • Read

    Get Logstash pipelines

    Get pipelines that are used for Logstash Central Management. Required authorization Cluster privileges: managelogstashpipelines

  • Destructive

    Create or update a Logstash pipeline

    Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. Required authorization Cluster privileges: managelogstashpipelines

  • Destructive

    Delete a Logstash pipeline

    Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. Required authorization Cluster privileges: managelogstashpipelines

Ml trained model

  • Read

    Get trained model configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get trained model configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get trained models usage info

    You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. Required authorization Cluster privileges: monitorml

  • Read

    Get trained models usage info

    You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. Required authorization Cluster privileges: monitorml

  • Write

    Clear trained model deployment cache

    Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node.

  • Write

    Evaluate a trained model

    POST /_ml/trained_models/{model_id}/_infer

  • Write

    Start a trained model deployment

    It allocates the model to every machine learning node. Required authorization Cluster privileges: manageml

  • Write

    Stop a trained model deployment

    Required authorization Cluster privileges: manageml

  • Write

    Update a trained model deployment

    Required authorization Cluster privileges: manageml

  • Destructive

    Create a trained model

    Enable you to supply a trained model that is not created by data frame analytics. Required authorization Cluster privileges: manageml

  • Destructive

    Delete an unreferenced trained model

    The request deletes a trained inference model that is not referenced by an ingest pipeline. Required authorization Cluster privileges: manageml

  • Destructive

    Create or update a trained model alias

    A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors.

  • Destructive

    Delete a trained model alias

    This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the modelid, this API returns an error. Required authorization Cluster privileges: manageml

  • Destructive

    Create part of a trained model definition

    Required authorization Cluster privileges: manageml

  • Destructive

    Create a trained model vocabulary

    This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in inferenceconfig..vocabulary of the trained model definition. Required authorization Cluster privileges: manageml

Ml anomaly

  • Read

    Get calendar configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get calendar configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get datafeeds configuration info

    You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using all, by specifying as the , or by omitting the .

  • Read

    Get filters

    You can get a single filter or all filters. Required authorization Cluster privileges: manageml

  • Read

    Get anomaly detection jobs configuration info

    You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using all, by specifying as the , or by omitting the .

  • Read

    Get model snapshots info

    Required authorization Cluster privileges: monitorml

  • Read

    Get model snapshots info

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for buckets

    The API presents a chronological view of the records, grouped by bucket. Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for buckets

    The API presents a chronological view of the records, grouped by bucket. Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for buckets

    The API presents a chronological view of the records, grouped by bucket. Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for buckets

    The API presents a chronological view of the records, grouped by bucket. Required authorization Cluster privileges: monitorml

  • Read

    Get info about events in calendars

    Required authorization Cluster privileges: monitorml

  • Read

    Get calendar configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get calendar configuration info

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for categories

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for categories

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for categories

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for categories

    Required authorization Cluster privileges: monitorml

  • Read

    Get datafeed stats

    You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using all, by specifying as the , or by omitting the .

  • Read

    Get datafeed stats

    You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using all, by specifying as the , or by omitting the .

  • Read

    Get datafeeds configuration info

    You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using all, by specifying as the , or by omitting the .

  • Read

    Get filters

    You can get a single filter or all filters. Required authorization Cluster privileges: manageml

  • Read

    Get anomaly detection job results for influencers

    Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencerfieldname is specified in the job configuration. Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job results for influencers

    Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencerfieldname is specified in the job configuration. Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job stats

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection job stats

    Required authorization Cluster privileges: monitorml

  • Read

    Get anomaly detection jobs configuration info

    You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using all, by specifying as the , or by omitting the .

  • Read

    Get anomaly detection job model snapshot upgrade usage info

    Required authorization Cluster privileges: monitorml

  • Read

    Get model snapshots info

    Required authorization Cluster privileges: monitorml

  • Read

    Get model snapshots info

    Required authorization Cluster privileges: monitorml

  • Read

    Get overall bucket results

    Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The overallscore is calculated by combining the scores of all the buckets within the overall bucket span.

  • Read

    Get overall bucket results

    Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The overallscore is calculated by combining the scores of all the buckets within the overall bucket span.

  • Read

    Get anomaly records for an anomaly detection job

    Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data.

  • Read

    Get anomaly records for an anomaly detection job

    Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data.

  • Read

    Preview a datafeed

    This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API.

  • Read

    Preview a datafeed

    This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API.

  • Read

    Preview a datafeed

    This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API.

  • Read

    Preview a datafeed

    This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API.

  • Write

    Close anomaly detection jobs

    A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.

  • Write

    Predict future behavior of a time series

    Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an overfieldname in its configuration. Forcasts predict future behavior based on historical data.

  • Write

    Estimate job model memory usage

    Make an estimation of the memory usage for an anomaly detection job model. The estimate is based on analysis configuration details for the job and cardinality estimates for the fields it references. Required authorization Cluster privileges: manageml

  • Write

    Add scheduled events to the calendar

    Required authorization Cluster privileges: manageml

  • Write

    Open anomaly detection jobs

    An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model.

  • Write

    Reset an anomaly detection job

    All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. Required authorization Cluster privileges: manageml

  • Write

    Revert to a snapshot

    The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event.

  • Write

    Start datafeeds

    A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.

  • Write

    Stop datafeeds

    A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Required authorization Cluster privileges: manageml

  • Write

    Update a datafeed

    You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles.

  • Write

    Update a filter

    Updates the description of a filter, adds items, or removes items from the list. Required authorization Cluster privileges: manageml

  • Write

    Update an anomaly detection job

    Updates certain properties of an anomaly detection job. Required authorization Cluster privileges: manageml

  • Write

    Update a snapshot

    Updates certain properties of a snapshot. Required authorization Cluster privileges: manageml

  • Write

    Upgrade a snapshot

    Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version.

  • Destructive

    Create a calendar

    Required authorization Cluster privileges: manageml

  • Destructive

    Delete a calendar

    Remove all scheduled events from a calendar, then delete it. Required authorization Cluster privileges: manageml

  • Destructive

    Delete events from a calendar

    DELETE /_ml/calendars/{calendar_id}/events/{event_id}

  • Destructive

    Add anomaly detection job to calendar

    Required authorization Cluster privileges: manageml

  • Destructive

    Delete anomaly jobs from a calendar

    Required authorization Cluster privileges: manageml

  • Destructive

    Create a datafeed

    Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (frequency).

  • Destructive

    Delete a datafeed

    Required authorization Cluster privileges: manageml

  • Destructive

    Delete expired ML data

    Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted.

  • Destructive

    Delete expired ML data

    Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted.

  • Destructive

    Create a filter

    A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the customrules property of detector configuration objects. Required authorization Cluster privileges: manageml

  • Destructive

    Delete a filter

    If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. Required authorization Cluster privileges: manageml

  • Destructive

    Delete forecasts from a job

    By default, forecasts are retained for 14 days. You can specify a different retention period with the expiresin parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

  • Destructive

    Delete forecasts from a job

    By default, forecasts are retained for 14 days. You can specify a different retention period with the expiresin parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

  • Destructive

    Create an anomaly detection job

    If you include a datafeedconfig, you must have read index privileges on the source index. If you include a datafeedconfig but do not provide a query, the datafeed uses {"matchall": {"boost": 1}}. Required authorization Index privileges: read Cluster privileges: manageml

  • Destructive

    Delete an anomaly detection job

    All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed.

  • Destructive

    Delete a model snapshot

    You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the modelsnapshotid in the results from the get jobs API. Required authorization Cluster privileges: manageml

Ml data frame

  • Read

    Get data frame analytics job configuration info

    You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. Required authorization Cluster privileges: monitorml

  • Read

    Explain data frame analytics config

    This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: which fields are included or not in the analysis and why, how much memory is estimated to be required.

  • Read

    Explain data frame analytics config

    This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: which fields are included or not in the analysis and why, how much memory is estimated to be required.

  • Read

    Get data frame analytics job configuration info

    You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. Required authorization Cluster privileges: monitorml

  • Read

    Get data frame analytics job stats

    Required authorization Cluster privileges: monitorml

  • Read

    Get data frame analytics job stats

    Required authorization Cluster privileges: monitorml

  • Read

    Preview features used by data frame analytics

    Preview the extracted features used by a data frame analytics config. Required authorization Cluster privileges: monitorml

  • Read

    Preview features used by data frame analytics

    Preview the extracted features used by a data frame analytics config. Required authorization Cluster privileges: monitorml

  • Read

    Preview features used by data frame analytics

    Preview the extracted features used by a data frame analytics config. Required authorization Cluster privileges: monitorml

  • Read

    Preview features used by data frame analytics

    Preview the extracted features used by a data frame analytics config. Required authorization Cluster privileges: monitorml

  • Write

    Evaluate data frame analytics

    The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.

  • Write

    Explain data frame analytics config

    This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: which fields are included or not in the analysis and why, how much memory is estimated to be required.

  • Write

    Explain data frame analytics config

    This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: which fields are included or not in the analysis and why, how much memory is estimated to be required.

  • Write

    Start a data frame analytics job

    A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job.

  • Write

    Stop data frame analytics jobs

    A data frame analytics job can be started and stopped multiple times throughout its lifecycle. Required authorization Cluster privileges: manageml

  • Write

    Update a data frame analytics job

    Required authorization Index privileges: read,createindex,manage,index,viewindexmetadata Cluster privileges: manageml

  • Destructive

    Create a data frame analytics job

    This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. By default, the query used in the source configuration is {"matchall": {}}.

  • Destructive

    Delete a data frame analytics job

    Required authorization Cluster privileges: manageml

Ml

  • Read

    Get machine learning memory usage info

    Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. Required authorization Cluster privileges: monitorml

  • Read

    Get machine learning memory usage info

    Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. Required authorization Cluster privileges: monitorml

  • Read

    Get machine learning information

    Get defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used.

  • Write

    Set upgrademode for ML indices

    Sets a cluster wide upgrademode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices.

Query rules

  • Read

    Get a query rule

    Get details about a query rule within a query ruleset. Required authorization Cluster privileges: managesearchqueryrules

  • Read

    Get a query ruleset

    Get details about a query ruleset. Required authorization Cluster privileges: managesearchqueryrules

  • Read

    Get all query rulesets

    Get summarized information about the query rulesets. Required authorization Cluster privileges: managesearchqueryrules

  • Write

    Test a query ruleset

    Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. Required authorization Cluster privileges: managesearchqueryrules

  • Destructive

    Create or update a query rule

    Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors.

  • Destructive

    Delete a query rule

    Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. Required authorization Cluster privileges: managesearchqueryrules

  • Destructive

    Create or update a query ruleset

    There is a limit of 100 rules per ruleset. This limit can be increased by using the xpack.applications.rules.maxrulesperruleset cluster setting.

  • Destructive

    Delete a query ruleset

    Remove a query ruleset and its associated data. This is a destructive action that is not recoverable. Required authorization Cluster privileges: managesearchqueryrules

Search application

  • Read

    Get search application details

    Required authorization Cluster privileges: managesearchapplication

  • Read

    Get search applications

    Get information about search applications. Required authorization Cluster privileges: managesearchapplication

  • Write

    Render a search application query

    Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.

  • Write

    Run a search application search

    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.

  • Destructive

    Create or update a search application

    Required authorization Index privileges: manage Cluster privileges: managesearchapplication

  • Destructive

    Delete a search application

    Remove a search application and its associated alias. Indices attached to the search application are not removed. Required authorization Index privileges: manage Cluster privileges: managesearchapplication

Searchable snapshots

  • Read

    Get cache statistics

    Get statistics about the shared cache for partially mounted indices. Required authorization Cluster privileges: manage

  • Read

    Get cache statistics

    Get statistics about the shared cache for partially mounted indices. Required authorization Cluster privileges: manage

  • Read

    Get searchable snapshot statistics

    Required authorization Index privileges: manage Cluster privileges: manage

  • Read

    Get searchable snapshot statistics

    Required authorization Index privileges: manage Cluster privileges: manage

  • Write

    Clear the searchable snapshots shared cache

    Clear indices and data streams from the shared cache for partially mounted indices. Required authorization Index privileges: manage Cluster privileges: manage

  • Write

    Clear the searchable snapshots shared cache

    Clear indices and data streams from the shared cache for partially mounted indices. Required authorization Index privileges: manage Cluster privileges: manage

  • Write

    Mount a snapshot

    Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. Required authorization Index privileges: manage Cluster privileges: manage

Slm

  • Read

    Get policy information

    Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. Required authorization Cluster privileges: manageslm

  • Read

    Get policy information

    Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. Required authorization Cluster privileges: manageslm

  • Read

    Get snapshot lifecycle management statistics

    Get global and policy-level statistics about actions taken by snapshot lifecycle management. Required authorization Cluster privileges: manageslm

  • Read

    Get the snapshot lifecycle management status

    Required authorization Cluster privileges: readslm

  • Write

    Run a retention policy

    Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule. Required authorization Cluster privileges: manageslm

  • Write

    Start snapshot lifecycle management

    Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API. Required authorization Cluster privileges: manageslm

  • Write

    Stop snapshot lifecycle management

    Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.

  • Destructive

    Create or update a policy

    Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored. Required authorization Index privileges: manage Cluster privileges: manageslm

  • Destructive

    Delete a policy

    Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. Required authorization Cluster privileges: manageslm

  • Destructive

    Run a policy

    Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

Snapshot

  • Read

    Get snapshot information

    NOTE: The after parameter and next field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.

  • Read

    Get snapshot repository information

    Required authorization Cluster privileges: monitorsnapshot

  • Read

    Get snapshot repository information

    Required authorization Cluster privileges: monitorsnapshot

  • Read

    Get the snapshot status

    Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.

  • Read

    Get the snapshot status

    Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.

  • Read

    Get the snapshot status

    Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.

  • Write

    Clean up the snapshot repository

    Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. Required authorization Cluster privileges: manage

  • Write

    Create a snapshot

    Take a snapshot of a cluster or of data streams and indices. Required authorization Cluster privileges: createsnapshot

  • Write

    Create or update a snapshot repository

    IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, cluster.blocks.

  • Write

    Analyze a snapshot repository

    Performs operations on a snapshot repository in order to check for incorrect behaviour. There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.

  • Write

    Verify the repository integrity

    Verify the integrity of the contents of a snapshot repository.

  • Write

    Restore a snapshot

    Restore a snapshot of a cluster or data streams and indices. You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible.

  • Write

    Verify a snapshot repository

    Check for common misconfigurations in a snapshot repository. Required authorization Cluster privileges: manage

  • Destructive

    Clone a snapshot

    Clone part of all of a snapshot into another snapshot in the same repository. Required authorization Cluster privileges: manage

  • Destructive

    Create a snapshot

    Take a snapshot of a cluster or of data streams and indices. Required authorization Cluster privileges: createsnapshot

  • Destructive

    Delete snapshots

    Required authorization Cluster privileges: manage

  • Destructive

    Create or update a snapshot repository

    IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, cluster.blocks.

  • Destructive

    Delete snapshot repositories

    When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. Required authorization Cluster privileges: manage

Sql

  • Read

    Get async SQL search results

    Get the current status and available results for an async SQL search or stored synchronous SQL search. If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

  • Read

    Get the async SQL search status

    Get the current status of an async SQL search or a stored synchronous SQL search. Required authorization Cluster privileges: monitor

  • Read

    Get SQL search results

    Run an SQL request. Required authorization Index privileges: read

  • Read

    Get SQL search results

    Run an SQL request. Required authorization Index privileges: read

  • Read

    Translate SQL into Elasticsearch queries

    Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding cursor. Required authorization Index privileges: read

  • Write

    Clear an SQL search cursor

    POST /_sql/close

  • Write

    Translate SQL into Elasticsearch queries

    Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding cursor. Required authorization Index privileges: read

  • Destructive

    Delete an async SQL search

    Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: Users with the canceltask cluster privilege.

Streams

  • Read

    Get the status of streams

    Get the current status for all types of streams. Required authorization Cluster privileges: monitor

  • Write

    Disable a named stream

    Turn off the named stream feature for this cluster. Required authorization Cluster privileges: manage

  • Write

    Enable a named stream

    Turn on the named stream feature for this cluster. NOTE: To protect existing data, this feature can be turned on only if the cluster does not have existing indices or data streams that match the pattern | . for the enabled stream type name.

Synonyms

  • Read

    Get a synonym set

    Required authorization Cluster privileges: managesearchsynonyms

  • Read

    Get a synonym rule

    Get a synonym rule from a synonym set. Required authorization Cluster privileges: managesearchsynonyms

  • Read

    Get all synonym sets

    Get a summary of all defined synonym sets. Required authorization Cluster privileges: managesearchsynonyms

  • Destructive

    Create or update a synonym set

    Synonym sets are limited to a maximum of 100,000 synonym rules per set by default. This limit is configurable using the synonyms.maxsynonymrules cluster setting.

  • Destructive

    Delete a synonym set

    You can only delete a synonyms set that is not in use by any index analyzer. Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers.

  • Destructive

    Create or update a synonym rule

    Create or update a synonym rule in a synonym set. If any of the synonym rules included is invalid, the API returns an error. When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.

  • Destructive

    Delete a synonym rule

    Delete a synonym rule from a synonym set. Required authorization Cluster privileges: managesearchsynonyms

Tasks

  • Read

    Get task information

    Get information about a task currently running in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

  • Read

    Get all tasks

    Get information about the tasks currently running on one or more nodes in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

  • Destructive

    Cancel a task

    WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

  • Destructive

    Cancel a task

    WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

Text structure

  • Read

    Find the structure of a text field

    Find the structure of a text field in an Elasticsearch index. This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.

  • Read

    Find the structure of text messages

    Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

  • Read

    Find the structure of text messages

    Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

  • Read

    Find the structure of a text file

    The text file must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.

  • Read

    Test a Grok pattern

    Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

  • Write

    Test a Grok pattern

    Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

Transform

  • Read

    Get transforms

    Get configuration information for transforms. Required authorization Cluster privileges: monitortransform

  • Read

    Get node stats

    Get per-node information about transform usage.

  • Read

    Get transforms

    Get configuration information for transforms. Required authorization Cluster privileges: monitortransform

  • Read

    Get transform stats

    Get usage information for transforms. Required authorization Index privileges: read,viewindexmetadata Cluster privileges: monitortransform

  • Read

    Preview a transform

    Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index.

  • Read

    Preview a transform

    Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index.

  • Read

    Preview a transform

    Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index.

  • Read

    Preview a transform

    Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index.

  • Write

    Reset a transform

    Before you can reset it, you must stop it; alternatively, use the force query parameter. If the destination index was created by the transform, it is deleted. Required authorization Cluster privileges: managetransform

  • Write

    Schedule a transform to start now

    Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval.

  • Write

    Set upgrademode for transform indices

    Sets a cluster wide upgrademode setting that prepares transform indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your transform indices. In those circumstances, there must be no transforms running.

  • Write

    Start a transform

    When you start a transform, it creates the destination index if it does not already exist. The numberofshards is set to 1 and the autoexpandreplicas is set to 0-1.

  • Write

    Stop transforms

    Stops one or more transforms. Required authorization Cluster privileges: managetransform

  • Write

    Update a transform

    Updates certain properties of a transform. All updated properties except description do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint.

  • Write

    Upgrade all transforms

    Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version.

  • Destructive

    Create a transform

    Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame).

  • Destructive

    Delete a transform

    Required authorization Cluster privileges: managetransform

Watcher

  • Read

    Get a watch

    Required authorization Cluster privileges: monitorwatcher

  • Read

    Get Watcher index settings

    Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.autoexpandreplicas and index.numberofreplicas.

  • Read

    Query watches

    Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the id and metadata. fields are queryable or sortable. Required authorization Cluster privileges: monitorwatcher

  • Read

    Query watches

    Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the id and metadata. fields are queryable or sortable. Required authorization Cluster privileges: monitorwatcher

  • Read

    Get Watcher statistics

    This API always returns basic metrics. You retrieve more metrics by using the metric parameter. Required authorization Cluster privileges: monitorwatcher

  • Read

    Get Watcher statistics

    This API always returns basic metrics. You retrieve more metrics by using the metric parameter. Required authorization Cluster privileges: monitorwatcher

  • Write

    Acknowledge a watch

    Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the status.actions. .ack.state structure.

  • Write

    Acknowledge a watch

    Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the status.actions. .ack.state structure.

  • Write

    Activate a watch

    A watch can be either active or inactive. Required authorization Cluster privileges: managewatcher

  • Write

    Deactivate a watch

    A watch can be either active or inactive. Required authorization Cluster privileges: managewatcher

  • Write

    Create or update a watch

    When a watch is registered, a new document that represents the watch is added to the .watches index and its trigger is immediately registered with the relevant trigger engine. Typically for the schedule trigger, the scheduler is the trigger engine.

  • Write

    Run a watch

    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. For testing and debugging purposes, you also have fine-grained control on how the watch runs.

  • Write

    Run a watch

    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. For testing and debugging purposes, you also have fine-grained control on how the watch runs.

  • Write

    Start the watch service

    Start the Watcher service if it is not already running. Required authorization Cluster privileges: managewatcher

  • Write

    Stop the watch service

    Stop the Watcher service if it is running. Required authorization Cluster privileges: managewatcher

  • Destructive

    Acknowledge a watch

    Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the status.actions. .ack.state structure.

  • Destructive

    Acknowledge a watch

    Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the status.actions. .ack.state structure.

  • Destructive

    Activate a watch

    A watch can be either active or inactive. Required authorization Cluster privileges: managewatcher

  • Destructive

    Deactivate a watch

    A watch can be either active or inactive. Required authorization Cluster privileges: managewatcher

  • Destructive

    Create or update a watch

    When a watch is registered, a new document that represents the watch is added to the .watches index and its trigger is immediately registered with the relevant trigger engine. Typically for the schedule trigger, the scheduler is the trigger engine.

  • Destructive

    Delete a watch

    When the watch is removed, the document representing the watch in the .watches index is gone and it will never be run again. Deleting a watch does not delete any watch execution records related to this watch from the watch history.

  • Destructive

    Run a watch

    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. For testing and debugging purposes, you also have fine-grained control on how the watch runs.

  • Destructive

    Run a watch

    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. For testing and debugging purposes, you also have fine-grained control on how the watch runs.

  • Destructive

    Update Watcher index settings

    Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.autoexpandreplicas, index.numberofreplicas, index.routing.allocation.exclude., index.routing.allocation.include. and index.routing.allocation.require..

Xpack

  • Read

    Get information

    The information provided by the API includes: Build information including the build number and timestamp. License information about the currently installed license. Feature information for the features that are currently enabled and available under the current license.

  • Read

    Get usage information

    Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. Required authorization Cluster privileges: monitor

See How connections work for access and permissions, or browse all integrations.