api.rst

Elasticsearch API Reference

All the API calls map the raw REST API as closely as possible, including the distinction between required and optional arguments to the calls. Keyword arguments are required for all

Note

Some API parameters in Elasticsearch are reserved keywords in Python. For example the from query parameter for pagination would be aliased as from_.

Elasticsearch

Elasticsearch

Async Search

AsyncSearchClient

Autoscaling

AutoscalingClient

Cat

CatClient

Cross-Cluster Replication (CCR)

CcrClient

Cluster

ClusterClient

Dangling Indices

DanglingIndicesClient

Enrich Policies

EnrichClient

Event Query Language (EQL)

EqlClient

Snapshottable Features

FeaturesClient

Fleet

FleetClient

Graph Explore

GraphClient

Index Lifecycle Management (ILM)

IlmClient

Indices

IndicesClient

Ingest Pipelines

IngestClient

License

LicenseClient

Logstash

LogstashClient

Migration

MigrationClient

Machine Learning (ML)

MlClient

Monitoring

MonitoringClient

Nodes

NodesClient

Rollup Indices

RollupClient

Searchable Snapshots

SearchableSnapshotsClient

Security

SecurityClient

Shutdown

ShutdownClient

Snapshot Lifecycle Management (SLM)

SlmClient

Snapshots

SnapshotClient

SQL

SqlClient

TLS/SSL

SslClient

Tasks

TasksClient

Text Structure

TextStructureClient

Transforms

TransformClient

Watcher

WatcherClient

X-Pack

XPackClient