elasticsearch

package module
v8.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2024 License: Apache-2.0 Imports: 18 Imported by: 752

README

go-elasticsearch

The official Go client for Elasticsearch.

Download the latest version of Elasticsearch or sign-up for a free trial of Elastic Cloud.

GoDoc Go Report Card codecov.io Build Unit Integration API

Compatibility

Go

Starting from version 8.12.0, this library follow the Go language policy. Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

Elasticsearch

Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.

When using Go modules, include the version in the import path, and specify either an explicit version or a branch:

require github.com/elastic/go-elasticsearch/v8 v8.0.0
require github.com/elastic/go-elasticsearch/v7 7.17

It's possible to use multiple versions of the client in a single project:

// go.mod
github.com/elastic/go-elasticsearch/v7 v7.17.0
github.com/elastic/go-elasticsearch/v8 v8.0.0

// main.go
import (
  elasticsearch7 "github.com/elastic/go-elasticsearch/v7"
  elasticsearch8 "github.com/elastic/go-elasticsearch/v8"
)
// ...
es7, _ := elasticsearch7.NewDefaultClient()
es8, _ := elasticsearch8.NewDefaultClient()

The main branch of the client is compatible with the current master branch of Elasticsearch.

Installation

Refer to the Installation section of the getting started documentation.

Connecting

Refer to the Connecting section of the getting started documentation.

Operations

Helpers

The esutil package provides convenience helpers for working with the client. At the moment, it provides the esutil.JSONReader() and the esutil.BulkIndexer helpers.

Examples

The _examples folder contains a number of recipes and comprehensive examples to get you started with the client, including configuration and customization of the client, using a custom certificate authority (CA) for security (TLS), mocking the transport for unit tests, embedding the client in a custom type, building queries, performing requests individually and in bulk, and parsing the responses.

License

This software is licensed under the Apache 2 license. See NOTICE.

Documentation

Overview

Package elasticsearch provides a Go client for Elasticsearch.

Create the client with the NewDefaultClient function:

elasticsearch.NewDefaultClient()

The ELASTICSEARCH_URL environment variable is used instead of the default URL, when set. Use a comma to separate multiple URLs.

To configure the client, pass a Config object to the NewClient function:

cfg := elasticsearch.Config{
  Addresses: []string{
    "http://localhost:9200",
    "http://localhost:9201",
  },
  Username: "foo",
  Password: "bar",
  Transport: &http.Transport{
    MaxIdleConnsPerHost:   10,
    ResponseHeaderTimeout: time.Second,
    DialContext:           (&net.Dialer{Timeout: time.Second}).DialContext,
    TLSClientConfig: &tls.Config{
      MinVersion:         tls.VersionTLS12,
    },
  },
}

elasticsearch.NewClient(cfg)

When using the Elastic Service (https://elastic.co/cloud), you can use CloudID instead of Addresses. When either Addresses or CloudID is set, the ELASTICSEARCH_URL environment variable is ignored.

See the elasticsearch_integration_test.go file and the _examples folder for more information.

Call the Elasticsearch APIs by invoking the corresponding methods on the client:

res, err := es.Info()
if err != nil {
  log.Fatalf("Error getting response: %s", err)
}

log.Println(res)

See the github.com/elastic/go-elasticsearch/esapi package for more information about using the API.

See the github.com/elastic/elastic-transport-go package for more information about configuring the transport.

Index

Examples

Constants

View Source
const (

	// Version returns the package version as a string.
	Version = version.Client

	// HeaderClientMeta Key for the HTTP Header related to telemetry data sent with
	// each request to Elasticsearch.
	HeaderClientMeta = "x-elastic-client-meta"
)

Variables

This section is empty.

Functions

func NewOpenTelemetryInstrumentation added in v8.12.0

func NewOpenTelemetryInstrumentation(provider trace.TracerProvider, captureSearchBody bool) elastictransport.Instrumentation

NewOpenTelemetryInstrumentation provides the OpenTelemetry integration for both low-level and TypedAPI. provider is optional, if nil is passed the integration will retrieve the provider set globally by otel. captureSearchBody allows to define if the search queries body should be included in the span. Search endpoints are:

search
async_search.submit
msearch
eql.search
terms_enum
search_template
msearch_template
render_search_template

Types

type BaseClient added in v8.4.0

type BaseClient struct {
	Transport elastictransport.Interface
	// contains filtered or unexported fields
}

BaseClient represents the Elasticsearch client.

func (*BaseClient) DiscoverNodes added in v8.4.0

func (c *BaseClient) DiscoverNodes() error

DiscoverNodes reloads the client connections by fetching information from the cluster.

func (*BaseClient) InstrumentationEnabled added in v8.12.0

func (c *BaseClient) InstrumentationEnabled() elastictransport.Instrumentation

InstrumentationEnabled propagates back to the client the Instrumentation provided by the transport.

func (*BaseClient) Metrics added in v8.4.0

func (c *BaseClient) Metrics() (elastictransport.Metrics, error)

Metrics returns the client metrics.

func (*BaseClient) Perform added in v8.4.0

func (c *BaseClient) Perform(req *http.Request) (*http.Response, error)

Perform delegates to Transport to execute a request and return a response.

type Client

type Client struct {
	BaseClient
	*esapi.API
}

Client represents the Functional Options API.

func NewClient

func NewClient(cfg Config) (*Client, error)

NewClient creates a new client with configuration from cfg.

It will use http://localhost:9200 as the default address.

It will use the ELASTICSEARCH_URL environment variable, if set, to configure the addresses; use a comma to separate multiple URLs.

If either cfg.Addresses or cfg.CloudID is set, the ELASTICSEARCH_URL environment variable is ignored.

It's an error to set both cfg.Addresses and cfg.CloudID.

Example
cfg := elasticsearch.Config{
	Addresses: []string{
		"http://localhost:9200",
	},
	Username: "foo",
	Password: "bar",
	Transport: &http.Transport{
		MaxIdleConnsPerHost:   10,
		ResponseHeaderTimeout: time.Second,
		DialContext:           (&net.Dialer{Timeout: time.Second}).DialContext,
		TLSClientConfig: &tls.Config{
			MinVersion: tls.VersionTLS12,
		},
	},
}

es, _ := elasticsearch.NewClient(cfg)
log.Print(es.Transport.(*elastictransport.Client).URLs())
Output:

Example (Logger)
// import "github.com/elastic/go-elasticsearch/v8/elastictransport"

// Use one of the bundled loggers:
//
// * elastictransport.TextLogger
// * elastictransport.ColorLogger
// * elastictransport.CurlLogger
// * elastictransport.JSONLogger

cfg := elasticsearch.Config{
	Logger: &elastictransport.ColorLogger{Output: os.Stdout},
}

elasticsearch.NewClient(cfg)
Output:

func NewDefaultClient

func NewDefaultClient() (*Client, error)

NewDefaultClient creates a new client with default options.

It will use http://localhost:9200 as the default address.

It will use the ELASTICSEARCH_URL environment variable, if set, to configure the addresses; use a comma to separate multiple URLs.

Example
es, err := elasticsearch.NewDefaultClient()
if err != nil {
	log.Fatalf("Error creating the client: %s\n", err)
}

res, err := es.Info()
if err != nil {
	log.Fatalf("Error getting the response: %s\n", err)
}
defer res.Body.Close()

log.Print(es.Transport.(*elastictransport.Client).URLs())
Output:

type Config

type Config struct {
	Addresses []string // A list of Elasticsearch nodes to use.
	Username  string   // Username for HTTP Basic Authentication.
	Password  string   // Password for HTTP Basic Authentication.

	CloudID                string // Endpoint for the Elastic Service (https://elastic.co/cloud).
	APIKey                 string // Base64-encoded token for authorization; if set, overrides username/password and service token.
	ServiceToken           string // Service token for authorization; if set, overrides username/password.
	CertificateFingerprint string // SHA256 hex fingerprint given by Elasticsearch on first launch.

	Header http.Header // Global HTTP request header.

	// PEM-encoded certificate authorities.
	// When set, an empty certificate pool will be created, and the certificates will be appended to it.
	// The option is only valid when the transport is not specified, or when it's http.Transport.
	CACert []byte

	RetryOnStatus []int                           // List of status codes for retry. Default: 502, 503, 504.
	DisableRetry  bool                            // Default: false.
	MaxRetries    int                             // Default: 3.
	RetryOnError  func(*http.Request, error) bool // Optional function allowing to indicate which error should be retried. Default: nil.

	CompressRequestBody      bool // Default: false.
	CompressRequestBodyLevel int  // Default: gzip.DefaultCompression.
	PoolCompressor           bool // If true, a sync.Pool based gzip writer is used. Default: false.

	DiscoverNodesOnStart  bool          // Discover nodes when initializing the client. Default: false.
	DiscoverNodesInterval time.Duration // Discover nodes periodically. Default: disabled.

	EnableMetrics           bool // Enable the metrics collection.
	EnableDebugLogger       bool // Enable the debug logging.
	EnableCompatibilityMode bool // Enable sends compatibility header

	DisableMetaHeader bool // Disable the additional "X-Elastic-Client-Meta" HTTP header.

	RetryBackoff func(attempt int) time.Duration // Optional backoff duration. Default: nil.

	Transport http.RoundTripper         // The HTTP transport object.
	Logger    elastictransport.Logger   // The logger object.
	Selector  elastictransport.Selector // The selector object.

	// Optional constructor function for a custom ConnectionPool. Default: nil.
	ConnectionPoolFunc func([]*elastictransport.Connection, elastictransport.Selector) elastictransport.ConnectionPool

	Instrumentation elastictransport.Instrumentation // Enable instrumentation throughout the client.
}

Config represents the client configuration.

type TypedClient added in v8.4.0

type TypedClient struct {
	BaseClient
	*typedapi.API
}

TypedClient represents the Typed API.

func NewTypedClient added in v8.4.0

func NewTypedClient(cfg Config) (*TypedClient, error)

NewTypedClient create a new client with the configuration from cfg.

This version uses the same configuration as NewClient.

It will return the client with the TypedAPI.

Directories

Path Synopsis
Package esapi provides the Go API for Elasticsearch.
Package esapi provides the Go API for Elasticsearch.
Package esutil provides helper utilities to the Go client for Elasticsearch.
Package esutil provides helper utilities to the Go client for Elasticsearch.
internal
asyncsearch/delete
Deletes an async search by ID.
Deletes an async search by ID.
asyncsearch/get
Retrieves the results of a previously submitted async search request given its ID.
Retrieves the results of a previously submitted async search request given its ID.
asyncsearch/status
Retrieves the status of a previously submitted async search request given its ID.
Retrieves the status of a previously submitted async search request given its ID.
asyncsearch/submit
Executes a search request asynchronously.
Executes a search request asynchronously.
autoscaling/deleteautoscalingpolicy
Deletes an autoscaling policy.
Deletes an autoscaling policy.
autoscaling/getautoscalingcapacity
Gets the current autoscaling capacity based on the configured autoscaling policy.
Gets the current autoscaling capacity based on the configured autoscaling policy.
autoscaling/getautoscalingpolicy
Retrieves an autoscaling policy.
Retrieves an autoscaling policy.
autoscaling/putautoscalingpolicy
Creates a new autoscaling policy.
Creates a new autoscaling policy.
cat/aliases
Shows information about currently configured aliases to indices including filter and routing infos.
Shows information about currently configured aliases to indices including filter and routing infos.
cat/allocation
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
cat/componenttemplates
Returns information about existing component_templates templates.
Returns information about existing component_templates templates.
cat/count
Provides quick access to the document count of the entire cluster, or individual indices.
Provides quick access to the document count of the entire cluster, or individual indices.
cat/fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
cat/health
Returns a concise representation of the cluster health.
Returns a concise representation of the cluster health.
cat/help
Returns help for the Cat APIs.
Returns help for the Cat APIs.
cat/indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
cat/master
Returns information about the master node.
Returns information about the master node.
cat/mldatafeeds
Gets configuration and usage information about datafeeds.
Gets configuration and usage information about datafeeds.
cat/mldataframeanalytics
Gets configuration and usage information about data frame analytics jobs.
Gets configuration and usage information about data frame analytics jobs.
cat/mljobs
Gets configuration and usage information about anomaly detection jobs.
Gets configuration and usage information about anomaly detection jobs.
cat/mltrainedmodels
Gets configuration and usage information about inference trained models.
Gets configuration and usage information about inference trained models.
cat/nodeattrs
Returns information about custom node attributes.
Returns information about custom node attributes.
cat/nodes
Returns basic statistics about performance of cluster nodes.
Returns basic statistics about performance of cluster nodes.
cat/pendingtasks
Returns a concise representation of the cluster pending tasks.
Returns a concise representation of the cluster pending tasks.
cat/plugins
Returns information about installed plugins across nodes node.
Returns information about installed plugins across nodes node.
cat/recovery
Returns information about index shard recoveries, both on-going completed.
Returns information about index shard recoveries, both on-going completed.
cat/repositories
Returns information about snapshot repositories registered in the cluster.
Returns information about snapshot repositories registered in the cluster.
cat/segments
Provides low-level information about the segments in the shards of an index.
Provides low-level information about the segments in the shards of an index.
cat/shards
Provides a detailed view of shard allocation on nodes.
Provides a detailed view of shard allocation on nodes.
cat/snapshots
Returns all snapshots in a specific repository.
Returns all snapshots in a specific repository.
cat/tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.
Returns information about the tasks currently executing on one or more nodes in the cluster.
cat/templates
Returns information about existing templates.
Returns information about existing templates.
cat/threadpool
Returns cluster-wide thread pool statistics per node.
Returns cluster-wide thread pool statistics per node.
cat/transforms
Gets configuration and usage information about transforms.
Gets configuration and usage information about transforms.
ccr/deleteautofollowpattern
Deletes auto-follow patterns.
Deletes auto-follow patterns.
ccr/follow
Creates a new follower index configured to follow the referenced leader index.
Creates a new follower index configured to follow the referenced leader index.
ccr/followinfo
Retrieves information about all follower indices, including parameters and status for each follower index
Retrieves information about all follower indices, including parameters and status for each follower index
ccr/followstats
Retrieves follower stats.
Retrieves follower stats.
ccr/forgetfollower
Removes the follower retention leases from the leader.
Removes the follower retention leases from the leader.
ccr/getautofollowpattern
Gets configured auto-follow patterns.
Gets configured auto-follow patterns.
ccr/pauseautofollowpattern
Pauses an auto-follow pattern
Pauses an auto-follow pattern
ccr/pausefollow
Pauses a follower index.
Pauses a follower index.
ccr/putautofollowpattern
Creates a new named collection of auto-follow patterns against a specified remote cluster.
Creates a new named collection of auto-follow patterns against a specified remote cluster.
ccr/resumeautofollowpattern
Resumes an auto-follow pattern that has been paused
Resumes an auto-follow pattern that has been paused
ccr/resumefollow
Resumes a follower index that has been paused
Resumes a follower index that has been paused
ccr/stats
Gets all stats related to cross-cluster replication.
Gets all stats related to cross-cluster replication.
ccr/unfollow
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
cluster/allocationexplain
Provides explanations for shard allocations in the cluster.
Provides explanations for shard allocations in the cluster.
cluster/deletecomponenttemplate
Deletes a component template
Deletes a component template
cluster/deletevotingconfigexclusions
Clears cluster voting config exclusions.
Clears cluster voting config exclusions.
cluster/existscomponenttemplate
Returns information about whether a particular component template exist
Returns information about whether a particular component template exist
cluster/getcomponenttemplate
Returns one or more component templates
Returns one or more component templates
cluster/getsettings
Returns cluster settings.
Returns cluster settings.
cluster/health
Returns basic information about the health of the cluster.
Returns basic information about the health of the cluster.
cluster/info
Returns different information about the cluster.
Returns different information about the cluster.
cluster/pendingtasks
Returns a list of any cluster-level changes (e.g.
Returns a list of any cluster-level changes (e.g.
cluster/postvotingconfigexclusions
Updates the cluster voting config exclusions by node ids or node names.
Updates the cluster voting config exclusions by node ids or node names.
cluster/putcomponenttemplate
Creates or updates a component template
Creates or updates a component template
cluster/putsettings
Updates the cluster settings.
Updates the cluster settings.
cluster/remoteinfo
Returns the information about configured remote clusters.
Returns the information about configured remote clusters.
cluster/reroute
Allows to manually change the allocation of individual shards in the cluster.
Allows to manually change the allocation of individual shards in the cluster.
cluster/state
Returns a comprehensive information about the state of the cluster.
Returns a comprehensive information about the state of the cluster.
cluster/stats
Returns high-level overview of cluster statistics.
Returns high-level overview of cluster statistics.
core/bulk
Allows to perform multiple index/update/delete operations in a single request.
Allows to perform multiple index/update/delete operations in a single request.
core/clearscroll
Explicitly clears the search context for a scroll.
Explicitly clears the search context for a scroll.
core/closepointintime
Close a point in time
Close a point in time
core/count
Returns number of documents matching a query.
Returns number of documents matching a query.
core/create
Creates a new document in the index.
Creates a new document in the index.
core/delete
Removes a document from the index.
Removes a document from the index.
core/deletebyquery
Deletes documents matching the provided query.
Deletes documents matching the provided query.
core/deletebyqueryrethrottle
Changes the number of requests per second for a particular Delete By Query operation.
Changes the number of requests per second for a particular Delete By Query operation.
core/deletescript
Deletes a script.
Deletes a script.
core/exists
Returns information about whether a document exists in an index.
Returns information about whether a document exists in an index.
core/existssource
Returns information about whether a document source exists in an index.
Returns information about whether a document source exists in an index.
core/explain
Returns information about why a specific matches (or doesn't match) a query.
Returns information about why a specific matches (or doesn't match) a query.
core/fieldcaps
Returns the information about the capabilities of fields among multiple indices.
Returns the information about the capabilities of fields among multiple indices.
core/get
Returns a document.
Returns a document.
core/getscript
Returns a script.
Returns a script.
core/getscriptcontext
Returns all script contexts.
Returns all script contexts.
core/getscriptlanguages
Returns available script types, languages and contexts
Returns available script types, languages and contexts
core/getsource
Returns the source of a document.
Returns the source of a document.
core/healthreport
Returns the health of the cluster.
Returns the health of the cluster.
core/index
Creates or updates a document in an index.
Creates or updates a document in an index.
core/info
Returns basic information about the cluster.
Returns basic information about the cluster.
core/knnsearch
Performs a kNN search.
Performs a kNN search.
core/mget
Allows to get multiple documents in one request.
Allows to get multiple documents in one request.
core/msearch
Allows to execute several search operations in one request.
Allows to execute several search operations in one request.
core/msearchtemplate
Allows to execute several search template operations in one request.
Allows to execute several search template operations in one request.
core/mtermvectors
Returns multiple termvectors in one request.
Returns multiple termvectors in one request.
core/openpointintime
Open a point in time that can be used in subsequent searches
Open a point in time that can be used in subsequent searches
core/ping
Returns whether the cluster is running.
Returns whether the cluster is running.
core/putscript
Creates or updates a script.
Creates or updates a script.
core/rankeval
Allows to evaluate the quality of ranked search results over a set of typical search queries
Allows to evaluate the quality of ranked search results over a set of typical search queries
core/reindex
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
core/reindexrethrottle
Changes the number of requests per second for a particular Reindex operation.
Changes the number of requests per second for a particular Reindex operation.
core/rendersearchtemplate
Allows to use the Mustache language to pre-render a search definition.
Allows to use the Mustache language to pre-render a search definition.
core/scriptspainlessexecute
Allows an arbitrary script to be executed and a result to be returned
Allows an arbitrary script to be executed and a result to be returned
core/scroll
Allows to retrieve a large numbers of results from a single search request.
Allows to retrieve a large numbers of results from a single search request.
core/search
Returns results matching a query.
Returns results matching a query.
core/searchmvt
Searches a vector tile for geospatial values.
Searches a vector tile for geospatial values.
core/searchshards
Returns information about the indices and shards that a search request would be executed against.
Returns information about the indices and shards that a search request would be executed against.
core/searchtemplate
Allows to use the Mustache language to pre-render a search definition.
Allows to use the Mustache language to pre-render a search definition.
core/termsenum
The terms enum API can be used to discover terms in the index that begin with the provided string.
The terms enum API can be used to discover terms in the index that begin with the provided string.
core/termvectors
Returns information and statistics about terms in the fields of a particular document.
Returns information and statistics about terms in the fields of a particular document.
core/update
Updates a document with a script or partial document.
Updates a document with a script or partial document.
core/updatebyquery
Updates documents that match the specified query.
Updates documents that match the specified query.
core/updatebyqueryrethrottle
Changes the number of requests per second for a particular Update By Query operation.
Changes the number of requests per second for a particular Update By Query operation.
danglingindices/deletedanglingindex
Deletes the specified dangling index
Deletes the specified dangling index
danglingindices/importdanglingindex
Imports the specified dangling index
Imports the specified dangling index
danglingindices/listdanglingindices
Returns all dangling indices.
Returns all dangling indices.
enrich/deletepolicy
Deletes an existing enrich policy and its enrich index.
Deletes an existing enrich policy and its enrich index.
enrich/executepolicy
Creates the enrich index for an existing enrich policy.
Creates the enrich index for an existing enrich policy.
enrich/getpolicy
Gets information about an enrich policy.
Gets information about an enrich policy.
enrich/putpolicy
Creates a new enrich policy.
Creates a new enrich policy.
enrich/stats
Gets enrich coordinator statistics and information about enrich policies that are currently executing.
Gets enrich coordinator statistics and information about enrich policies that are currently executing.
eql/delete
Deletes an async EQL search by ID.
Deletes an async EQL search by ID.
eql/get
Returns async results from previously executed Event Query Language (EQL) search
Returns async results from previously executed Event Query Language (EQL) search
eql/getstatus
Returns the status of a previously submitted async or stored Event Query Language (EQL) search
Returns the status of a previously submitted async or stored Event Query Language (EQL) search
eql/search
Returns results matching a query expressed in Event Query Language (EQL)
Returns results matching a query expressed in Event Query Language (EQL)
esql/query
Executes an ESQL request
Executes an ESQL request
features/getfeatures
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
features/resetfeatures
Resets the internal state of features, usually by deleting system indices
Resets the internal state of features, usually by deleting system indices
fleet/globalcheckpoints
Returns the current global checkpoints for an index.
Returns the current global checkpoints for an index.
fleet/msearch
Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh.
Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh.
fleet/postsecret
Creates a secret stored by Fleet.
Creates a secret stored by Fleet.
fleet/search
Search API where the search will only be executed after specified checkpoints are available due to a refresh.
Search API where the search will only be executed after specified checkpoints are available due to a refresh.
graph/explore
Explore extracted and summarized information about the documents and terms in an index.
Explore extracted and summarized information about the documents and terms in an index.
ilm/deletelifecycle
Deletes the specified lifecycle policy definition.
Deletes the specified lifecycle policy definition.
ilm/explainlifecycle
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
ilm/getlifecycle
Returns the specified policy definition.
Returns the specified policy definition.
ilm/getstatus
Retrieves the current index lifecycle management (ILM) status.
Retrieves the current index lifecycle management (ILM) status.
ilm/migratetodatatiers
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
ilm/movetostep
Manually moves an index into the specified step and executes that step.
Manually moves an index into the specified step and executes that step.
ilm/putlifecycle
Creates a lifecycle policy
Creates a lifecycle policy
ilm/removepolicy
Removes the assigned lifecycle policy and stops managing the specified index
Removes the assigned lifecycle policy and stops managing the specified index
ilm/retry
Retries executing the policy for an index that is in the ERROR step.
Retries executing the policy for an index that is in the ERROR step.
ilm/start
Start the index lifecycle management (ILM) plugin.
Start the index lifecycle management (ILM) plugin.
ilm/stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
indices/addblock
Adds a block to an index.
Adds a block to an index.
indices/analyze
Performs the analysis process on a text and return the tokens breakdown of the text.
Performs the analysis process on a text and return the tokens breakdown of the text.
indices/clearcache
Clears all or specific caches for one or more indices.
Clears all or specific caches for one or more indices.
indices/clone
Clones an index
Clones an index
indices/close
Closes an index.
Closes an index.
indices/create
Creates an index with optional settings and mappings.
Creates an index with optional settings and mappings.
indices/createdatastream
Creates a data stream
Creates a data stream
indices/datastreamsstats
Provides statistics on operations happening in a data stream.
Provides statistics on operations happening in a data stream.
indices/delete
Deletes an index.
Deletes an index.
indices/deletealias
Deletes an alias.
Deletes an alias.
indices/deletedatalifecycle
Deletes the data stream lifecycle of the selected data streams.
Deletes the data stream lifecycle of the selected data streams.
indices/deletedatastream
Deletes a data stream.
Deletes a data stream.
indices/deleteindextemplate
Deletes an index template.
Deletes an index template.
indices/deletetemplate
Deletes an index template.
Deletes an index template.
indices/diskusage
Analyzes the disk usage of each field of an index or data stream
Analyzes the disk usage of each field of an index or data stream
indices/downsample
Downsample an index
Downsample an index
indices/exists
Returns information about whether a particular index exists.
Returns information about whether a particular index exists.
indices/existsalias
Returns information about whether a particular alias exists.
Returns information about whether a particular alias exists.
indices/existsindextemplate
Returns information about whether a particular index template exists.
Returns information about whether a particular index template exists.
indices/existstemplate
Returns information about whether a particular index template exists.
Returns information about whether a particular index template exists.
indices/explaindatalifecycle
Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
indices/fieldusagestats
Returns the field usage stats for each field of an index
Returns the field usage stats for each field of an index
indices/flush
Performs the flush operation on one or more indices.
Performs the flush operation on one or more indices.
indices/forcemerge
Performs the force merge operation on one or more indices.
Performs the force merge operation on one or more indices.
indices/get
Returns information about one or more indices.
Returns information about one or more indices.
indices/getalias
Returns an alias.
Returns an alias.
indices/getdatalifecycle
Returns the data stream lifecycle of the selected data streams.
Returns the data stream lifecycle of the selected data streams.
indices/getdatastream
Returns data streams.
Returns data streams.
indices/getfieldmapping
Returns mapping for one or more fields.
Returns mapping for one or more fields.
indices/getindextemplate
Returns an index template.
Returns an index template.
indices/getmapping
Returns mappings for one or more indices.
Returns mappings for one or more indices.
indices/getsettings
Returns settings for one or more indices.
Returns settings for one or more indices.
indices/gettemplate
Returns an index template.
Returns an index template.
indices/migratetodatastream
Migrates an alias to a data stream
Migrates an alias to a data stream
indices/modifydatastream
Modifies a data stream
Modifies a data stream
indices/open
Opens an index.
Opens an index.
indices/promotedatastream
Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
indices/putalias
Creates or updates an alias.
Creates or updates an alias.
indices/putdatalifecycle
Updates the data stream lifecycle of the selected data streams.
Updates the data stream lifecycle of the selected data streams.
indices/putindextemplate
Creates or updates an index template.
Creates or updates an index template.
indices/putmapping
Updates the index mappings.
Updates the index mappings.
indices/putsettings
Updates the index settings.
Updates the index settings.
indices/puttemplate
Creates or updates an index template.
Creates or updates an index template.
indices/recovery
Returns information about ongoing index shard recoveries.
Returns information about ongoing index shard recoveries.
indices/refresh
Performs the refresh operation in one or more indices.
Performs the refresh operation in one or more indices.
indices/reloadsearchanalyzers
Reloads an index's search analyzers and their resources.
Reloads an index's search analyzers and their resources.
indices/resolvecluster
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
indices/resolveindex
Returns information about any matching indices, aliases, and data streams
Returns information about any matching indices, aliases, and data streams
indices/rollover
Updates an alias to point to a new index when the existing index is considered to be too large or too old.
Updates an alias to point to a new index when the existing index is considered to be too large or too old.
indices/segments
Provides low-level information about segments in a Lucene index.
Provides low-level information about segments in a Lucene index.
indices/shardstores
Provides store information for shard copies of indices.
Provides store information for shard copies of indices.
indices/shrink
Allow to shrink an existing index into a new index with fewer primary shards.
Allow to shrink an existing index into a new index with fewer primary shards.
indices/simulateindextemplate
Simulate matching the given index name against the index templates in the system
Simulate matching the given index name against the index templates in the system
indices/simulatetemplate
Simulate resolving the given template name or body
Simulate resolving the given template name or body
indices/split
Allows you to split an existing index into a new index with more primary shards.
Allows you to split an existing index into a new index with more primary shards.
indices/stats
Provides statistics on operations happening in an index.
Provides statistics on operations happening in an index.
indices/unfreeze
Unfreezes an index.
Unfreezes an index.
indices/updatealiases
Updates index aliases.
Updates index aliases.
indices/validatequery
Allows a user to validate a potentially expensive query without executing it.
Allows a user to validate a potentially expensive query without executing it.
inference/deletemodel
Delete model in the Inference API
Delete model in the Inference API
inference/getmodel
Get a model in the Inference API
Get a model in the Inference API
inference/inference
Perform inference on a model
Perform inference on a model
inference/putmodel
Configure a model for use in the Inference API
Configure a model for use in the Inference API
ingest/deletepipeline
Deletes a pipeline.
Deletes a pipeline.
ingest/geoipstats
Returns statistical information about geoip databases
Returns statistical information about geoip databases
ingest/getpipeline
Returns a pipeline.
Returns a pipeline.
ingest/processorgrok
Returns a list of the built-in patterns.
Returns a list of the built-in patterns.
ingest/putpipeline
Creates or updates a pipeline.
Creates or updates a pipeline.
ingest/simulate
Allows to simulate a pipeline with example documents.
Allows to simulate a pipeline with example documents.
license/delete
Deletes licensing information for the cluster
Deletes licensing information for the cluster
license/get
Retrieves licensing information for the cluster
Retrieves licensing information for the cluster
license/getbasicstatus
Retrieves information about the status of the basic license.
Retrieves information about the status of the basic license.
license/gettrialstatus
Retrieves information about the status of the trial license.
Retrieves information about the status of the trial license.
license/post
Updates the license for the cluster.
Updates the license for the cluster.
license/poststartbasic
Starts an indefinite basic license.
Starts an indefinite basic license.
license/poststarttrial
starts a limited time trial license.
starts a limited time trial license.
logstash/deletepipeline
Deletes Logstash Pipelines used by Central Management
Deletes Logstash Pipelines used by Central Management
logstash/getpipeline
Retrieves Logstash Pipelines used by Central Management
Retrieves Logstash Pipelines used by Central Management
logstash/putpipeline
Adds and updates Logstash Pipelines used for Central Management
Adds and updates Logstash Pipelines used for Central Management
migration/deprecations
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
migration/getfeatureupgradestatus
Find out whether system features need to be upgraded or not
Find out whether system features need to be upgraded or not
migration/postfeatureupgrade
Begin upgrades for system features
Begin upgrades for system features
ml/cleartrainedmodeldeploymentcache
Clear the cached results from a trained model deployment
Clear the cached results from a trained model deployment
ml/closejob
Closes one or more anomaly detection jobs.
Closes one or more anomaly detection jobs.
ml/deletecalendar
Deletes a calendar.
Deletes a calendar.
ml/deletecalendarevent
Deletes scheduled events from a calendar.
Deletes scheduled events from a calendar.
ml/deletecalendarjob
Deletes anomaly detection jobs from a calendar.
Deletes anomaly detection jobs from a calendar.
ml/deletedatafeed
Deletes an existing datafeed.
Deletes an existing datafeed.
ml/deletedataframeanalytics
Deletes an existing data frame analytics job.
Deletes an existing data frame analytics job.
ml/deleteexpireddata
Deletes expired and unused machine learning data.
Deletes expired and unused machine learning data.
ml/deletefilter
Deletes a filter.
Deletes a filter.
ml/deleteforecast
Deletes forecasts from a machine learning job.
Deletes forecasts from a machine learning job.
ml/deletejob
Deletes an existing anomaly detection job.
Deletes an existing anomaly detection job.
ml/deletemodelsnapshot
Deletes an existing model snapshot.
Deletes an existing model snapshot.
ml/deletetrainedmodel
Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
ml/deletetrainedmodelalias
Deletes a model alias that refers to the trained model
Deletes a model alias that refers to the trained model
ml/estimatemodelmemory
Estimates the model memory
Estimates the model memory
ml/evaluatedataframe
Evaluates the data frame analytics for an annotated index.
Evaluates the data frame analytics for an annotated index.
ml/explaindataframeanalytics
Explains a data frame analytics config.
Explains a data frame analytics config.
ml/flushjob
Forces any buffered data to be processed by the job.
Forces any buffered data to be processed by the job.
ml/forecast
Predicts the future behavior of a time series by using its historical behavior.
Predicts the future behavior of a time series by using its historical behavior.
ml/getbuckets
Retrieves anomaly detection job results for one or more buckets.
Retrieves anomaly detection job results for one or more buckets.
ml/getcalendarevents
Retrieves information about the scheduled events in calendars.
Retrieves information about the scheduled events in calendars.
ml/getcalendars
Retrieves configuration information for calendars.
Retrieves configuration information for calendars.
ml/getcategories
Retrieves anomaly detection job results for one or more categories.
Retrieves anomaly detection job results for one or more categories.
ml/getdatafeeds
Retrieves configuration information for datafeeds.
Retrieves configuration information for datafeeds.
ml/getdatafeedstats
Retrieves usage information for datafeeds.
Retrieves usage information for datafeeds.
ml/getdataframeanalytics
Retrieves configuration information for data frame analytics jobs.
Retrieves configuration information for data frame analytics jobs.
ml/getdataframeanalyticsstats
Retrieves usage information for data frame analytics jobs.
Retrieves usage information for data frame analytics jobs.
ml/getfilters
Retrieves filters.
Retrieves filters.
ml/getinfluencers
Retrieves anomaly detection job results for one or more influencers.
Retrieves anomaly detection job results for one or more influencers.
ml/getjobs
Retrieves configuration information for anomaly detection jobs.
Retrieves configuration information for anomaly detection jobs.
ml/getjobstats
Retrieves usage information for anomaly detection jobs.
Retrieves usage information for anomaly detection jobs.
ml/getmemorystats
Returns information on how ML is using memory.
Returns information on how ML is using memory.
ml/getmodelsnapshots
Retrieves information about model snapshots.
Retrieves information about model snapshots.
ml/getmodelsnapshotupgradestats
Gets stats for anomaly detection job model snapshot upgrades that are in progress.
Gets stats for anomaly detection job model snapshot upgrades that are in progress.
ml/getoverallbuckets
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
ml/getrecords
Retrieves anomaly records for an anomaly detection job.
Retrieves anomaly records for an anomaly detection job.
ml/gettrainedmodels
Retrieves configuration information for a trained inference model.
Retrieves configuration information for a trained inference model.
ml/gettrainedmodelsstats
Retrieves usage information for trained inference models.
Retrieves usage information for trained inference models.
ml/infertrainedmodel
Evaluate a trained model.
Evaluate a trained model.
ml/info
Returns defaults and limits used by machine learning.
Returns defaults and limits used by machine learning.
ml/openjob
Opens one or more anomaly detection jobs.
Opens one or more anomaly detection jobs.
ml/postcalendarevents
Posts scheduled events in a calendar.
Posts scheduled events in a calendar.
ml/postdata
Sends data to an anomaly detection job for analysis.
Sends data to an anomaly detection job for analysis.
ml/previewdatafeed
Previews a datafeed.
Previews a datafeed.
ml/previewdataframeanalytics
Previews that will be analyzed given a data frame analytics config.
Previews that will be analyzed given a data frame analytics config.
ml/putcalendar
Instantiates a calendar.
Instantiates a calendar.
ml/putcalendarjob
Adds an anomaly detection job to a calendar.
Adds an anomaly detection job to a calendar.
ml/putdatafeed
Instantiates a datafeed.
Instantiates a datafeed.
ml/putdataframeanalytics
Instantiates a data frame analytics job.
Instantiates a data frame analytics job.
ml/putfilter
Instantiates a filter.
Instantiates a filter.
ml/putjob
Instantiates an anomaly detection job.
Instantiates an anomaly detection job.
ml/puttrainedmodel
Creates an inference trained model.
Creates an inference trained model.
ml/puttrainedmodelalias
Creates a new model alias (or reassigns an existing one) to refer to the trained model
Creates a new model alias (or reassigns an existing one) to refer to the trained model
ml/puttrainedmodeldefinitionpart
Creates part of a trained model definition
Creates part of a trained model definition
ml/puttrainedmodelvocabulary
Creates a trained model vocabulary
Creates a trained model vocabulary
ml/resetjob
Resets an existing anomaly detection job.
Resets an existing anomaly detection job.
ml/revertmodelsnapshot
Reverts to a specific snapshot.
Reverts to a specific snapshot.
ml/setupgrademode
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
ml/startdatafeed
Starts one or more datafeeds.
Starts one or more datafeeds.
ml/startdataframeanalytics
Starts a data frame analytics job.
Starts a data frame analytics job.
ml/starttrainedmodeldeployment
Start a trained model deployment.
Start a trained model deployment.
ml/stopdatafeed
Stops one or more datafeeds.
Stops one or more datafeeds.
ml/stopdataframeanalytics
Stops one or more data frame analytics jobs.
Stops one or more data frame analytics jobs.
ml/stoptrainedmodeldeployment
Stop a trained model deployment.
Stop a trained model deployment.
ml/updatedatafeed
Updates certain properties of a datafeed.
Updates certain properties of a datafeed.
ml/updatedataframeanalytics
Updates certain properties of a data frame analytics job.
Updates certain properties of a data frame analytics job.
ml/updatefilter
Updates the description of a filter, adds items, or removes items.
Updates the description of a filter, adds items, or removes items.
ml/updatejob
Updates certain properties of an anomaly detection job.
Updates certain properties of an anomaly detection job.
ml/updatemodelsnapshot
Updates certain properties of a snapshot.
Updates certain properties of a snapshot.
ml/updatetrainedmodeldeployment
Updates certain properties of trained model deployment.
Updates certain properties of trained model deployment.
ml/upgradejobsnapshot
Upgrades a given job snapshot to the current major version.
Upgrades a given job snapshot to the current major version.
ml/validate
Validates an anomaly detection job.
Validates an anomaly detection job.
ml/validatedetector
Validates an anomaly detection detector.
Validates an anomaly detection detector.
monitoring/bulk
Used by the monitoring features to send monitoring data.
Used by the monitoring features to send monitoring data.
nodes/clearrepositoriesmeteringarchive
Removes the archived repositories metering information present in the cluster.
Removes the archived repositories metering information present in the cluster.
nodes/getrepositoriesmeteringinfo
Returns cluster repositories metering information.
Returns cluster repositories metering information.
nodes/hotthreads
Returns information about hot threads on each node in the cluster.
Returns information about hot threads on each node in the cluster.
nodes/info
Returns information about nodes in the cluster.
Returns information about nodes in the cluster.
nodes/reloadsecuresettings
Reloads secure settings.
Reloads secure settings.
nodes/stats
Returns statistical information about nodes in the cluster.
Returns statistical information about nodes in the cluster.
nodes/usage
Returns low-level information about REST actions usage on nodes.
Returns low-level information about REST actions usage on nodes.
queryruleset/delete
Deletes a query ruleset.
Deletes a query ruleset.
queryruleset/get
Returns the details about a query ruleset.
Returns the details about a query ruleset.
queryruleset/list
Lists query rulesets.
Lists query rulesets.
queryruleset/put
Creates or updates a query ruleset.
Creates or updates a query ruleset.
rollup/deletejob
Deletes an existing rollup job.
Deletes an existing rollup job.
rollup/getjobs
Retrieves the configuration, stats, and status of rollup jobs.
Retrieves the configuration, stats, and status of rollup jobs.
rollup/getrollupcaps
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
rollup/getrollupindexcaps
Returns the rollup capabilities of all jobs inside of a rollup index (e.g.
Returns the rollup capabilities of all jobs inside of a rollup index (e.g.
rollup/putjob
Creates a rollup job.
Creates a rollup job.
rollup/rollupsearch
Enables searching rolled-up data using the standard query DSL.
Enables searching rolled-up data using the standard query DSL.
rollup/startjob
Starts an existing, stopped rollup job.
Starts an existing, stopped rollup job.
rollup/stopjob
Stops an existing, started rollup job.
Stops an existing, started rollup job.
searchablesnapshots/cachestats
Retrieve node-level cache statistics about searchable snapshots.
Retrieve node-level cache statistics about searchable snapshots.
searchablesnapshots/clearcache
Clear the cache of searchable snapshots.
Clear the cache of searchable snapshots.
searchablesnapshots/mount
Mount a snapshot as a searchable index.
Mount a snapshot as a searchable index.
searchablesnapshots/stats
Retrieve shard-level statistics about searchable snapshots.
Retrieve shard-level statistics about searchable snapshots.
searchapplication/delete
Deletes a search application.
Deletes a search application.
searchapplication/deletebehavioralanalytics
Delete a behavioral analytics collection.
Delete a behavioral analytics collection.
searchapplication/get
Returns the details about a search application.
Returns the details about a search application.
searchapplication/getbehavioralanalytics
Returns the existing behavioral analytics collections.
Returns the existing behavioral analytics collections.
searchapplication/list
Returns the existing search applications.
Returns the existing search applications.
searchapplication/put
Creates or updates a search application.
Creates or updates a search application.
searchapplication/putbehavioralanalytics
Creates a behavioral analytics collection.
Creates a behavioral analytics collection.
searchapplication/search
Perform a search against a search application
Perform a search against a search application
security/activateuserprofile
Creates or updates the user profile on behalf of another user.
Creates or updates the user profile on behalf of another user.
security/authenticate
Enables authentication as a user and retrieve information about the authenticated user.
Enables authentication as a user and retrieve information about the authenticated user.
security/bulkupdateapikeys
Updates the attributes of multiple existing API keys.
Updates the attributes of multiple existing API keys.
security/changepassword
Changes the passwords of users in the native realm and built-in users.
Changes the passwords of users in the native realm and built-in users.
security/clearapikeycache
Clear a subset or all entries from the API key cache.
Clear a subset or all entries from the API key cache.
security/clearcachedprivileges
Evicts application privileges from the native application privileges cache.
Evicts application privileges from the native application privileges cache.
security/clearcachedrealms
Evicts users from the user cache.
Evicts users from the user cache.
security/clearcachedroles
Evicts roles from the native role cache.
Evicts roles from the native role cache.
security/clearcachedservicetokens
Evicts tokens from the service account token caches.
Evicts tokens from the service account token caches.
security/createapikey
Creates an API key for access without requiring basic authentication.
Creates an API key for access without requiring basic authentication.
security/createcrossclusterapikey
Creates a cross-cluster API key for API key based remote cluster access.
Creates a cross-cluster API key for API key based remote cluster access.
security/createservicetoken
Creates a service account token for access without requiring basic authentication.
Creates a service account token for access without requiring basic authentication.
security/deleteprivileges
Removes application privileges.
Removes application privileges.
security/deleterole
Removes roles in the native realm.
Removes roles in the native realm.
security/deleterolemapping
Removes role mappings.
Removes role mappings.
security/deleteservicetoken
Deletes a service account token.
Deletes a service account token.
security/deleteuser
Deletes users from the native realm.
Deletes users from the native realm.
security/disableuser
Disables users in the native realm.
Disables users in the native realm.
security/disableuserprofile
Disables a user profile so it's not visible in user profile searches.
Disables a user profile so it's not visible in user profile searches.
security/enableuser
Enables users in the native realm.
Enables users in the native realm.
security/enableuserprofile
Enables a user profile so it's visible in user profile searches.
Enables a user profile so it's visible in user profile searches.
security/enrollkibana
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
security/enrollnode
Allows a new node to enroll to an existing cluster with security enabled.
Allows a new node to enroll to an existing cluster with security enabled.
security/getapikey
Retrieves information for one or more API keys.
Retrieves information for one or more API keys.
security/getbuiltinprivileges
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
security/getprivileges
Retrieves application privileges.
Retrieves application privileges.
security/getrole
Retrieves roles in the native realm.
Retrieves roles in the native realm.
security/getrolemapping
Retrieves role mappings.
Retrieves role mappings.
security/getserviceaccounts
Retrieves information about service accounts.
Retrieves information about service accounts.
security/getservicecredentials
Retrieves information of all service credentials for a service account.
Retrieves information of all service credentials for a service account.
security/getsettings
Retrieve settings for the security system indices
Retrieve settings for the security system indices
security/gettoken
Creates a bearer token for access without requiring basic authentication.
Creates a bearer token for access without requiring basic authentication.
security/getuser
Retrieves information about users in the native realm and built-in users.
Retrieves information about users in the native realm and built-in users.
security/getuserprivileges
Retrieves security privileges for the logged in user.
Retrieves security privileges for the logged in user.
security/getuserprofile
Retrieves user profiles for the given unique ID(s).
Retrieves user profiles for the given unique ID(s).
security/grantapikey
Creates an API key on behalf of another user.
Creates an API key on behalf of another user.
security/hasprivileges
Determines whether the specified user has a specified list of privileges.
Determines whether the specified user has a specified list of privileges.
security/hasprivilegesuserprofile
Determines whether the users associated with the specified profile IDs have all the requested privileges.
Determines whether the users associated with the specified profile IDs have all the requested privileges.
security/invalidateapikey
Invalidates one or more API keys.
Invalidates one or more API keys.
security/invalidatetoken
Invalidates one or more access tokens or refresh tokens.
Invalidates one or more access tokens or refresh tokens.
security/oidcauthenticate
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
security/oidclogout
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
security/oidcprepareauthentication
Creates an OAuth 2.0 authentication request as a URL string
Creates an OAuth 2.0 authentication request as a URL string
security/putprivileges
Adds or updates application privileges.
Adds or updates application privileges.
security/putrole
Adds and updates roles in the native realm.
Adds and updates roles in the native realm.
security/putrolemapping
Creates and updates role mappings.
Creates and updates role mappings.
security/putuser
Adds and updates users in the native realm.
Adds and updates users in the native realm.
security/queryapikeys
Retrieves information for API keys using a subset of query DSL
Retrieves information for API keys using a subset of query DSL
security/samlauthenticate
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
security/samlcompletelogout
Verifies the logout response sent from the SAML IdP
Verifies the logout response sent from the SAML IdP
security/samlinvalidate
Consumes a SAML LogoutRequest
Consumes a SAML LogoutRequest
security/samllogout
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
security/samlprepareauthentication
Creates a SAML authentication request
Creates a SAML authentication request
security/samlserviceprovidermetadata
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
security/suggestuserprofiles
Get suggestions for user profiles that match specified search criteria.
Get suggestions for user profiles that match specified search criteria.
security/updateapikey
Updates attributes of an existing API key.
Updates attributes of an existing API key.
security/updatesettings
Update settings for the security system index
Update settings for the security system index
security/updateuserprofiledata
Update application specific data for the user profile of the given unique ID.
Update application specific data for the user profile of the given unique ID.
shutdown/deletenode
Removes a node from the shutdown list.
Removes a node from the shutdown list.
shutdown/getnode
Retrieve status of a node or nodes that are currently marked as shutting down.
Retrieve status of a node or nodes that are currently marked as shutting down.
shutdown/putnode
Adds a node to be shut down.
Adds a node to be shut down.
slm/deletelifecycle
Deletes an existing snapshot lifecycle policy.
Deletes an existing snapshot lifecycle policy.
slm/executelifecycle
Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
slm/executeretention
Deletes any snapshots that are expired according to the policy's retention rules.
Deletes any snapshots that are expired according to the policy's retention rules.
slm/getlifecycle
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
slm/getstats
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
slm/getstatus
Retrieves the status of snapshot lifecycle management (SLM).
Retrieves the status of snapshot lifecycle management (SLM).
slm/putlifecycle
Creates or updates a snapshot lifecycle policy.
Creates or updates a snapshot lifecycle policy.
slm/start
Turns on snapshot lifecycle management (SLM).
Turns on snapshot lifecycle management (SLM).
slm/stop
Turns off snapshot lifecycle management (SLM).
Turns off snapshot lifecycle management (SLM).
snapshot/cleanuprepository
Removes stale data from repository.
Removes stale data from repository.
snapshot/clone
Clones indices from one snapshot into another snapshot in the same repository.
Clones indices from one snapshot into another snapshot in the same repository.
snapshot/create
Creates a snapshot in a repository.
Creates a snapshot in a repository.
snapshot/createrepository
Creates a repository.
Creates a repository.
snapshot/delete
Deletes one or more snapshots.
Deletes one or more snapshots.
snapshot/deleterepository
Deletes a repository.
Deletes a repository.
snapshot/get
Returns information about a snapshot.
Returns information about a snapshot.
snapshot/getrepository
Returns information about a repository.
Returns information about a repository.
snapshot/restore
Restores a snapshot.
Restores a snapshot.
snapshot/status
Returns information about the status of a snapshot.
Returns information about the status of a snapshot.
snapshot/verifyrepository
Verifies a repository.
Verifies a repository.
some
Package some provides helpers to allow users to user inline pointers on primitive types for the TypedAPI.
Package some provides helpers to allow users to user inline pointers on primitive types for the TypedAPI.
sql/clearcursor
Clears the SQL cursor
Clears the SQL cursor
sql/deleteasync
Deletes an async SQL search or a stored synchronous SQL search.
Deletes an async SQL search or a stored synchronous SQL search.
sql/getasync
Returns the current status and available results for an async SQL search or stored synchronous SQL search
Returns the current status and available results for an async SQL search or stored synchronous SQL search
sql/getasyncstatus
Returns the current status of an async SQL search or a stored synchronous SQL search
Returns the current status of an async SQL search or a stored synchronous SQL search
sql/query
Executes a SQL request
Executes a SQL request
sql/translate
Translates SQL into Elasticsearch queries
Translates SQL into Elasticsearch queries
ssl/certificates
Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
synonyms/deletesynonym
Deletes a synonym set
Deletes a synonym set
synonyms/deletesynonymrule
Deletes a synonym rule in a synonym set
Deletes a synonym rule in a synonym set
synonyms/getsynonym
Retrieves a synonym set
Retrieves a synonym set
synonyms/getsynonymrule
Retrieves a synonym rule from a synonym set
Retrieves a synonym rule from a synonym set
synonyms/getsynonymssets
Retrieves a summary of all defined synonym sets
Retrieves a summary of all defined synonym sets
synonyms/putsynonym
Creates or updates a synonyms set
Creates or updates a synonyms set
synonyms/putsynonymrule
Creates or updates a synonym rule in a synonym set
Creates or updates a synonym rule in a synonym set
tasks/cancel
Cancels a task, if it can be cancelled through an API.
Cancels a task, if it can be cancelled through an API.
tasks/get
Returns information about a task.
Returns information about a task.
tasks/list
Returns a list of tasks.
Returns a list of tasks.
textstructure/findstructure
Finds the structure of a text file.
Finds the structure of a text file.
textstructure/testgrokpattern
Tests a Grok pattern on some text.
Tests a Grok pattern on some text.
transform/deletetransform
Deletes an existing transform.
Deletes an existing transform.
transform/gettransform
Retrieves configuration information for transforms.
Retrieves configuration information for transforms.
transform/gettransformstats
Retrieves usage information for transforms.
Retrieves usage information for transforms.
transform/previewtransform
Previews a transform.
Previews a transform.
transform/puttransform
Instantiates a transform.
Instantiates a transform.
transform/resettransform
Resets an existing transform.
Resets an existing transform.
transform/schedulenowtransform
Schedules now a transform.
Schedules now a transform.
transform/starttransform
Starts one or more transforms.
Starts one or more transforms.
transform/stoptransform
Stops one or more transforms.
Stops one or more transforms.
transform/updatetransform
Updates certain properties of a transform.
Updates certain properties of a transform.
transform/upgradetransforms
Upgrades all transforms.
Upgrades all transforms.
types/enums/accesstokengranttype
Package accesstokengranttype
Package accesstokengranttype
types/enums/acknowledgementoptions
Package acknowledgementoptions
Package acknowledgementoptions
types/enums/actionexecutionmode
Package actionexecutionmode
Package actionexecutionmode
types/enums/actionstatusoptions
Package actionstatusoptions
Package actionstatusoptions
types/enums/actiontype
Package actiontype
Package actiontype
types/enums/allocationexplaindecision
Package allocationexplaindecision
Package allocationexplaindecision
types/enums/apikeygranttype
Package apikeygranttype
Package apikeygranttype
types/enums/appliesto
Package appliesto
Package appliesto
types/enums/boundaryscanner
Package boundaryscanner
Package boundaryscanner
types/enums/bytes
Package bytes
Package bytes
types/enums/calendarinterval
Package calendarinterval
Package calendarinterval
types/enums/cardinalityexecutionmode
Package cardinalityexecutionmode
Package cardinalityexecutionmode
types/enums/catanomalydetectorcolumn
Package catanomalydetectorcolumn
Package catanomalydetectorcolumn
types/enums/catdatafeedcolumn
Package catdatafeedcolumn
Package catdatafeedcolumn
types/enums/catdfacolumn
Package catdfacolumn
Package catdfacolumn
types/enums/categorizationstatus
Package categorizationstatus
Package categorizationstatus
types/enums/cattrainedmodelscolumn
Package cattrainedmodelscolumn
Package cattrainedmodelscolumn
types/enums/cattransformcolumn
Package cattransformcolumn
Package cattransformcolumn
types/enums/childscoremode
Package childscoremode
Package childscoremode
types/enums/chunkingmode
Package chunkingmode
Package chunkingmode
types/enums/clusterinfotarget
Package clusterinfotarget
Package clusterinfotarget
types/enums/clusterprivilege
Package clusterprivilege
Package clusterprivilege
types/enums/clustersearchstatus
Package clustersearchstatus
Package clustersearchstatus
types/enums/combinedfieldsoperator
Package combinedfieldsoperator
Package combinedfieldsoperator
types/enums/combinedfieldszeroterms
Package combinedfieldszeroterms
Package combinedfieldszeroterms
types/enums/conditionop
Package conditionop
Package conditionop
types/enums/conditionoperator
Package conditionoperator
Package conditionoperator
types/enums/conditiontype
Package conditiontype
Package conditiontype
types/enums/conflicts
Package conflicts
Package conflicts
types/enums/connectionscheme
Package connectionscheme
Package connectionscheme
types/enums/converttype
Package converttype
Package converttype
types/enums/dataattachmentformat
Package dataattachmentformat
Package dataattachmentformat
types/enums/datafeedstate
Package datafeedstate
Package datafeedstate
types/enums/dataframestate
Package dataframestate
Package dataframestate
types/enums/day
Package day
Package day
types/enums/decision
Package decision
Package decision
types/enums/delimitedpayloadencoding
Package delimitedpayloadencoding
Package delimitedpayloadencoding
types/enums/deploymentallocationstate
Package deploymentallocationstate
Package deploymentallocationstate
types/enums/deploymentassignmentstate
Package deploymentassignmentstate
Package deploymentassignmentstate
types/enums/deploymentstate
Package deploymentstate
Package deploymentstate
types/enums/deprecationlevel
Package deprecationlevel
Package deprecationlevel
types/enums/dfiindependencemeasure
Package dfiindependencemeasure
Package dfiindependencemeasure
types/enums/dfraftereffect
Package dfraftereffect
Package dfraftereffect
types/enums/dfrbasicmodel
Package dfrbasicmodel
Package dfrbasicmodel
types/enums/distanceunit
Package distanceunit
Package distanceunit
types/enums/dynamicmapping
Package dynamicmapping
Package dynamicmapping
types/enums/edgengramside
Package edgengramside
Package edgengramside
types/enums/emailpriority
Package emailpriority
Package emailpriority
types/enums/enrichpolicyphase
Package enrichpolicyphase
Package enrichpolicyphase
types/enums/excludefrequent
Package excludefrequent
Package excludefrequent
types/enums/executionphase
Package executionphase
Package executionphase
types/enums/executionstatus
Package executionstatus
Package executionstatus
types/enums/expandwildcard
Package expandwildcard
Package expandwildcard
types/enums/feature
Package feature
Package feature
types/enums/fieldsortnumerictype
Package fieldsortnumerictype
Package fieldsortnumerictype
types/enums/fieldtype
Package fieldtype
Package fieldtype
types/enums/fieldvaluefactormodifier
Package fieldvaluefactormodifier
Package fieldvaluefactormodifier
types/enums/filtertype
Package filtertype
Package filtertype
types/enums/followerindexstatus
Package followerindexstatus
Package followerindexstatus
types/enums/functionboostmode
Package functionboostmode
Package functionboostmode
types/enums/functionscoremode
Package functionscoremode
Package functionscoremode
types/enums/gappolicy
Package gappolicy
Package gappolicy
types/enums/geodistancetype
Package geodistancetype
Package geodistancetype
types/enums/geoexecution
Package geoexecution
Package geoexecution
types/enums/geoorientation
Package geoorientation
Package geoorientation
types/enums/geoshaperelation
Package geoshaperelation
Package geoshaperelation
types/enums/geostrategy
Package geostrategy
Package geostrategy
types/enums/geovalidationmethod
Package geovalidationmethod
Package geovalidationmethod
types/enums/granttype
Package granttype
Package granttype
types/enums/gridaggregationtype
Package gridaggregationtype
Package gridaggregationtype
types/enums/gridtype
Package gridtype
Package gridtype
types/enums/groupby
Package groupby
Package groupby
types/enums/healthstatus
Package healthstatus
Package healthstatus
types/enums/highlighterencoder
Package highlighterencoder
Package highlighterencoder
types/enums/highlighterfragmenter
Package highlighterfragmenter
Package highlighterfragmenter
types/enums/highlighterorder
Package highlighterorder
Package highlighterorder
types/enums/highlightertagsschema
Package highlightertagsschema
Package highlightertagsschema
types/enums/highlightertype
Package highlightertype
Package highlightertype
types/enums/holtwinterstype
Package holtwinterstype
Package holtwinterstype
types/enums/httpinputmethod
Package httpinputmethod
Package httpinputmethod
types/enums/ibdistribution
Package ibdistribution
Package ibdistribution
types/enums/iblambda
Package iblambda
Package iblambda
types/enums/icucollationalternate
Package icucollationalternate
Package icucollationalternate
types/enums/icucollationcasefirst
Package icucollationcasefirst
Package icucollationcasefirst
types/enums/icucollationdecomposition
Package icucollationdecomposition
Package icucollationdecomposition
types/enums/icucollationstrength
Package icucollationstrength
Package icucollationstrength
types/enums/icunormalizationmode
Package icunormalizationmode
Package icunormalizationmode
types/enums/icunormalizationtype
Package icunormalizationtype
Package icunormalizationtype
types/enums/icutransformdirection
Package icutransformdirection
Package icutransformdirection
types/enums/impactarea
Package impactarea
Package impactarea
types/enums/include
Package include
Package include
types/enums/indexcheckonstartup
Package indexcheckonstartup
Package indexcheckonstartup
types/enums/indexingjobstate
Package indexingjobstate
Package indexingjobstate
types/enums/indexmetadatastate
Package indexmetadatastate
Package indexmetadatastate
types/enums/indexoptions
Package indexoptions
Package indexoptions
types/enums/indexprivilege
Package indexprivilege
Package indexprivilege
types/enums/indexroutingallocationoptions
Package indexroutingallocationoptions
Package indexroutingallocationoptions
types/enums/indexroutingrebalanceoptions
Package indexroutingrebalanceoptions
Package indexroutingrebalanceoptions
types/enums/indicatorhealthstatus
Package indicatorhealthstatus
Package indicatorhealthstatus
types/enums/indicesblockoptions
Package indicesblockoptions
Package indicesblockoptions
types/enums/inputtype
Package inputtype
Package inputtype
types/enums/jobblockedreason
Package jobblockedreason
Package jobblockedreason
types/enums/jobstate
Package jobstate
Package jobstate
types/enums/jsonprocessorconflictstrategy
Package jsonprocessorconflictstrategy
Package jsonprocessorconflictstrategy
types/enums/keeptypesmode
Package keeptypesmode
Package keeptypesmode
types/enums/kuromojitokenizationmode
Package kuromojitokenizationmode
Package kuromojitokenizationmode
types/enums/language
Package language
Package language
types/enums/level
Package level
Package level
types/enums/licensestatus
Package licensestatus
Package licensestatus
types/enums/licensetype
Package licensetype
Package licensetype
types/enums/lifecycleoperationmode
Package lifecycleoperationmode
Package lifecycleoperationmode
types/enums/managedby
Package managedby
Package managedby
types/enums/matchtype
Package matchtype
Package matchtype
types/enums/memorystatus
Package memorystatus
Package memorystatus
types/enums/metric
Package metric
Package metric
types/enums/migrationstatus
Package migrationstatus
Package migrationstatus
types/enums/minimuminterval
Package minimuminterval
Package minimuminterval
types/enums/missingorder
Package missingorder
Package missingorder
types/enums/month
Package month
Package month
types/enums/multivaluemode
Package multivaluemode
Package multivaluemode
types/enums/noderole
Package noderole
Package noderole
types/enums/noridecompoundmode
Package noridecompoundmode
Package noridecompoundmode
types/enums/normalization
Package normalization
Package normalization
types/enums/normalizemethod
Package normalizemethod
Package normalizemethod
types/enums/numericfielddataformat
Package numericfielddataformat
Package numericfielddataformat
types/enums/onscripterror
Package onscripterror
Package onscripterror
types/enums/operationtype
Package operationtype
Package operationtype
types/enums/operator
Package operator
Package operator
types/enums/optype
Package optype
Package optype
types/enums/pagerdutycontexttype
Package pagerdutycontexttype
Package pagerdutycontexttype
types/enums/pagerdutyeventtype
Package pagerdutyeventtype
Package pagerdutyeventtype
types/enums/phoneticencoder
Package phoneticencoder
Package phoneticencoder
types/enums/phoneticlanguage
Package phoneticlanguage
Package phoneticlanguage
types/enums/phoneticnametype
Package phoneticnametype
Package phoneticnametype
types/enums/phoneticruletype
Package phoneticruletype
Package phoneticruletype
types/enums/policytype
Package policytype
Package policytype
types/enums/quantifier
Package quantifier
Package quantifier
types/enums/queryrulecriteriatype
Package queryrulecriteriatype
Package queryrulecriteriatype
types/enums/queryruletype
Package queryruletype
Package queryruletype
types/enums/rangerelation
Package rangerelation
Package rangerelation
types/enums/ratemode
Package ratemode
Package ratemode
types/enums/refresh
Package refresh
Package refresh
types/enums/responsecontenttype
Package responsecontenttype
Package responsecontenttype
types/enums/result
Package result
Package result
types/enums/resultposition
Package resultposition
Package resultposition
types/enums/routingstate
Package routingstate
Package routingstate
types/enums/ruleaction
Package ruleaction
Package ruleaction
types/enums/runtimefieldtype
Package runtimefieldtype
Package runtimefieldtype
types/enums/sampleraggregationexecutionhint
Package sampleraggregationexecutionhint
Package sampleraggregationexecutionhint
types/enums/scoremode
Package scoremode
Package scoremode
types/enums/scriptlanguage
Package scriptlanguage
Package scriptlanguage
types/enums/scriptsorttype
Package scriptsorttype
Package scriptsorttype
types/enums/searchtype
Package searchtype
Package searchtype
types/enums/segmentsortmissing
Package segmentsortmissing
Package segmentsortmissing
types/enums/segmentsortmode
Package segmentsortmode
Package segmentsortmode
types/enums/segmentsortorder
Package segmentsortorder
Package segmentsortorder
types/enums/shapetype
Package shapetype
Package shapetype
types/enums/shardroutingstate
Package shardroutingstate
Package shardroutingstate
types/enums/shardsstatsstage
Package shardsstatsstage
Package shardsstatsstage
types/enums/shardstoreallocation
Package shardstoreallocation
Package shardstoreallocation
types/enums/shardstorestatus
Package shardstorestatus
Package shardstorestatus
types/enums/shutdownstatus
Package shutdownstatus
Package shutdownstatus
types/enums/shutdowntype
Package shutdowntype
Package shutdowntype
types/enums/simplequerystringflag
Package simplequerystringflag
Package simplequerystringflag
types/enums/slicescalculation
Package slicescalculation
Package slicescalculation
types/enums/snapshotsort
Package snapshotsort
Package snapshotsort
types/enums/snapshotupgradestate
Package snapshotupgradestate
Package snapshotupgradestate
types/enums/snowballlanguage
Package snowballlanguage
Package snowballlanguage
types/enums/sortmode
Package sortmode
Package sortmode
types/enums/sortorder
Package sortorder
Package sortorder
types/enums/sourcefieldmode
Package sourcefieldmode
Package sourcefieldmode
types/enums/statslevel
Package statslevel
Package statslevel
types/enums/storagetype
Package storagetype
Package storagetype
types/enums/stringdistance
Package stringdistance
Package stringdistance
types/enums/suggestmode
Package suggestmode
Package suggestmode
types/enums/suggestsort
Package suggestsort
Package suggestsort
types/enums/synonymformat
Package synonymformat
Package synonymformat
types/enums/tasktype
Package tasktype
Package tasktype
types/enums/templateformat
Package templateformat
Package templateformat
types/enums/termsaggregationcollectmode
Package termsaggregationcollectmode
Package termsaggregationcollectmode
types/enums/termsaggregationexecutionhint
Package termsaggregationexecutionhint
Package termsaggregationexecutionhint
types/enums/termvectoroption
Package termvectoroption
Package termvectoroption
types/enums/textquerytype
Package textquerytype
Package textquerytype
types/enums/threadtype
Package threadtype
Package threadtype
types/enums/timeseriesmetrictype
Package timeseriesmetrictype
Package timeseriesmetrictype
types/enums/timeunit
Package timeunit
Package timeunit
types/enums/tokenchar
Package tokenchar
Package tokenchar
types/enums/tokenizationtruncate
Package tokenizationtruncate
Package tokenizationtruncate
types/enums/totalhitsrelation
Package totalhitsrelation
Package totalhitsrelation
types/enums/trainedmodeltype
Package trainedmodeltype
Package trainedmodeltype
types/enums/trainingpriority
Package trainingpriority
Package trainingpriority
types/enums/translogdurability
Package translogdurability
Package translogdurability
types/enums/ttesttype
Package ttesttype
Package ttesttype
types/enums/type_
Package type_
Package type_
types/enums/unassignedinformationreason
Package unassignedinformationreason
Package unassignedinformationreason
types/enums/useragentproperty
Package useragentproperty
Package useragentproperty
types/enums/valuetype
Package valuetype
Package valuetype
types/enums/versiontype
Package versiontype
Package versiontype
types/enums/waitforactiveshardoptions
Package waitforactiveshardoptions
Package waitforactiveshardoptions
types/enums/waitforevents
Package waitforevents
Package waitforevents
types/enums/watchermetric
Package watchermetric
Package watchermetric
types/enums/watcherstate
Package watcherstate
Package watcherstate
types/enums/zerotermsquery
Package zerotermsquery
Package zerotermsquery
watcher/ackwatch
Acknowledges a watch, manually throttling the execution of the watch's actions.
Acknowledges a watch, manually throttling the execution of the watch's actions.
watcher/activatewatch
Activates a currently inactive watch.
Activates a currently inactive watch.
watcher/deactivatewatch
Deactivates a currently active watch.
Deactivates a currently active watch.
watcher/deletewatch
Removes a watch from Watcher.
Removes a watch from Watcher.
watcher/executewatch
Forces the execution of a stored watch.
Forces the execution of a stored watch.
watcher/getsettings
Retrieve settings for the watcher system index
Retrieve settings for the watcher system index
watcher/getwatch
Retrieves a watch by its ID.
Retrieves a watch by its ID.
watcher/putwatch
Creates a new watch, or updates an existing one.
Creates a new watch, or updates an existing one.
watcher/querywatches
Retrieves stored watches.
Retrieves stored watches.
watcher/start
Starts Watcher if it is not already running.
Starts Watcher if it is not already running.
watcher/stats
Retrieves the current Watcher metrics.
Retrieves the current Watcher metrics.
watcher/stop
Stops Watcher if it is running.
Stops Watcher if it is running.
watcher/updatesettings
Update settings for the watcher system index
Update settings for the watcher system index
xpack/info
Retrieves information about the installed X-Pack features.
Retrieves information about the installed X-Pack features.
xpack/usage
Retrieves usage information about the installed X-Pack features.
Retrieves usage information about the installed X-Pack features.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL