package
7.17.10
Repository: https://github.com/elastic/go-elasticsearch.git
Documentation: pkg.go.dev

# Functions

BoolPtr returns a pointer to v.
IntPtr returns a pointer to v.
New creates new API.

# Constants

Version returns the package version as a string.

# Structs

API contains the Elasticsearch APIs.
AsyncSearch contains the AsyncSearch APIs.
AsyncSearchDeleteRequest configures the Async Search Delete API request.
AsyncSearchGetRequest configures the Async Search Get API request.
AsyncSearchStatusRequest configures the Async Search Status API request.
AsyncSearchSubmitRequest configures the Async Search Submit API request.
AutoscalingDeleteAutoscalingPolicyRequest configures the Autoscaling Delete Autoscaling Policy API request.
AutoscalingGetAutoscalingCapacityRequest configures the Autoscaling Get Autoscaling Capacity API request.
AutoscalingGetAutoscalingDecisionRequest configures the Autoscaling Get Autoscaling Decision API request.
AutoscalingGetAutoscalingPolicyRequest configures the Autoscaling Get Autoscaling Policy API request.
AutoscalingPutAutoscalingPolicyRequest configures the Autoscaling Put Autoscaling Policy API request.
BulkRequest configures the Bulk API request.
Cat contains the Cat APIs.
CatAliasesRequest configures the Cat Aliases API request.
CatAllocationRequest configures the Cat Allocation API request.
CatCountRequest configures the Cat Count API request.
CatFielddataRequest configures the Cat Fielddata API request.
CatHealthRequest configures the Cat Health API request.
CatHelpRequest configures the Cat Help API request.
CatIndicesRequest configures the Cat Indices API request.
CatMasterRequest configures the Cat Master API request.
CatMLDatafeedsRequest configures the CatML Datafeeds API request.
CatMLDataFrameAnalyticsRequest configures the CatML Data Frame Analytics API request.
CatMLJobsRequest configures the CatML Jobs API request.
CatMLTrainedModelsRequest configures the CatML Trained Models API request.
CatNodeattrsRequest configures the Cat Nodeattrs API request.
CatNodesRequest configures the Cat Nodes API request.
CatPendingTasksRequest configures the Cat Pending Tasks API request.
CatPluginsRequest configures the Cat Plugins API request.
CatRecoveryRequest configures the Cat Recovery API request.
CatRepositoriesRequest configures the Cat Repositories API request.
CatSegmentsRequest configures the Cat Segments API request.
CatShardsRequest configures the Cat Shards API request.
CatSnapshotsRequest configures the Cat Snapshots API request.
CatTasksRequest configures the Cat Tasks API request.
CatTemplatesRequest configures the Cat Templates API request.
CatThreadPoolRequest configures the Cat Thread Pool API request.
CatTransformsRequest configures the Cat Transforms API request.
CCR contains the CCR APIs.
CCRDeleteAutoFollowPatternRequest configures the CCR Delete Auto Follow Pattern API request.
CCRFollowInfoRequest configures the CCR Follow Info API request.
CCRFollowRequest configures the CCR Follow API request.
CCRFollowStatsRequest configures the CCR Follow Stats API request.
CCRForgetFollowerRequest configures the CCR Forget Follower API request.
CCRGetAutoFollowPatternRequest configures the CCR Get Auto Follow Pattern API request.
CCRPauseAutoFollowPatternRequest configures the CCR Pause Auto Follow Pattern API request.
CCRPauseFollowRequest configures the CCR Pause Follow API request.
CCRPutAutoFollowPatternRequest configures the CCR Put Auto Follow Pattern API request.
CCRResumeAutoFollowPatternRequest configures the CCR Resume Auto Follow Pattern API request.
CCRResumeFollowRequest configures the CCR Resume Follow API request.
CCRStatsRequest configures the CCR Stats API request.
CCRUnfollowRequest configures the CCR Unfollow API request.
ClearScrollRequest configures the Clear Scroll API request.
ClosePointInTimeRequest configures the Close Point In Time API request.
Cluster contains the Cluster APIs.
ClusterAllocationExplainRequest configures the Cluster Allocation Explain API request.
ClusterDeleteComponentTemplateRequest configures the Cluster Delete Component Template API request.
ClusterDeleteVotingConfigExclusionsRequest configures the Cluster Delete Voting Config Exclusions API request.
ClusterExistsComponentTemplateRequest configures the Cluster Exists Component Template API request.
ClusterGetComponentTemplateRequest configures the Cluster Get Component Template API request.
ClusterGetSettingsRequest configures the Cluster Get Settings API request.
ClusterHealthRequest configures the Cluster Health API request.
ClusterPendingTasksRequest configures the Cluster Pending Tasks API request.
ClusterPostVotingConfigExclusionsRequest configures the Cluster Post Voting Config Exclusions API request.
ClusterPutComponentTemplateRequest configures the Cluster Put Component Template API request.
ClusterPutSettingsRequest configures the Cluster Put Settings API request.
ClusterRemoteInfoRequest configures the Cluster Remote Info API request.
ClusterRerouteRequest configures the Cluster Reroute API request.
ClusterStateRequest configures the Cluster State API request.
ClusterStatsRequest configures the Cluster Stats API request.
CountRequest configures the Count API request.
CreateRequest configures the Create API request.
DanglingIndicesDeleteDanglingIndexRequest configures the Dangling Indices Delete Dangling Index API request.
DanglingIndicesImportDanglingIndexRequest configures the Dangling Indices Import Dangling Index API request.
DanglingIndicesListDanglingIndicesRequest configures the Dangling Indices List Dangling Indices API request.
DataFrameTransformDeprecatedDeleteTransformRequest configures the Data Frame Transform Deprecated Delete Transform API request.
DataFrameTransformDeprecatedGetTransformRequest configures the Data Frame Transform Deprecated Get Transform API request.
DataFrameTransformDeprecatedGetTransformStatsRequest configures the Data Frame Transform Deprecated Get Transform Stats API request.
DataFrameTransformDeprecatedPreviewTransformRequest configures the Data Frame Transform Deprecated Preview Transform API request.
DataFrameTransformDeprecatedPutTransformRequest configures the Data Frame Transform Deprecated Put Transform API request.
DataFrameTransformDeprecatedStartTransformRequest configures the Data Frame Transform Deprecated Start Transform API request.
DataFrameTransformDeprecatedStopTransformRequest configures the Data Frame Transform Deprecated Stop Transform API request.
DataFrameTransformDeprecatedUpdateTransformRequest configures the Data Frame Transform Deprecated Update Transform API request.
DeleteByQueryRequest configures the Delete By Query API request.
DeleteByQueryRethrottleRequest configures the Delete By Query Rethrottle API request.
DeleteRequest configures the Delete API request.
DeleteScriptRequest configures the Delete Script API request.
EnrichDeletePolicyRequest configures the Enrich Delete Policy API request.
EnrichExecutePolicyRequest configures the Enrich Execute Policy API request.
EnrichGetPolicyRequest configures the Enrich Get Policy API request.
EnrichPutPolicyRequest configures the Enrich Put Policy API request.
EnrichStatsRequest configures the Enrich Stats API request.
EqlDeleteRequest configures the Eql Delete API request.
EqlGetRequest configures the Eql Get API request.
EqlGetStatusRequest configures the Eql Get Status API request.
EqlSearchRequest configures the Eql Search API request.
ExistsRequest configures the Exists API request.
ExistsSourceRequest configures the Exists Source API request.
ExplainRequest configures the Explain API request.
FeaturesGetFeaturesRequest configures the Features Get Features API request.
FeaturesResetFeaturesRequest configures the Features Reset Features API request.
FieldCapsRequest configures the Field Caps API request.
FleetGlobalCheckpointsRequest configures the Fleet Global Checkpoints API request.
FleetMsearchRequest configures the Fleet Msearch API request.
FleetSearchRequest configures the Fleet Search API request.
GetRequest configures the Get API request.
GetScriptContextRequest configures the Get Script Context API request.
GetScriptLanguagesRequest configures the Get Script Languages API request.
GetScriptRequest configures the Get Script API request.
GetSourceRequest configures the Get Source API request.
GraphExploreRequest configures the Graph Explore API request.
ILM contains the ILM APIs.
ILMDeleteLifecycleRequest configures the ILM Delete Lifecycle API request.
ILMExplainLifecycleRequest configures the ILM Explain Lifecycle API request.
ILMGetLifecycleRequest configures the ILM Get Lifecycle API request.
ILMGetStatusRequest configures the ILM Get Status API request.
ILMMigrateToDataTiersRequest configures the ILM Migrate To Data Tiers API request.
ILMMoveToStepRequest configures the ILM Move To Step API request.
ILMPutLifecycleRequest configures the ILM Put Lifecycle API request.
ILMRemovePolicyRequest configures the ILM Remove Policy API request.
ILMRetryRequest configures the ILM Retry API request.
ILMStartRequest configures the ILM Start API request.
ILMStopRequest configures the ILM Stop API request.
IndexRequest configures the Index API request.
Indices contains the Indices APIs.
IndicesAddBlockRequest configures the Indices Add Block API request.
IndicesAnalyzeRequest configures the Indices Analyze API request.
IndicesClearCacheRequest configures the Indices Clear Cache API request.
IndicesCloneRequest configures the Indices Clone API request.
IndicesCloseRequest configures the Indices Close API request.
IndicesCreateDataStreamRequest configures the Indices Create Data Stream API request.
IndicesCreateRequest configures the Indices Create API request.
IndicesDataStreamsStatsRequest configures the Indices Data Streams Stats API request.
IndicesDeleteAliasRequest configures the Indices Delete Alias API request.
IndicesDeleteDataStreamRequest configures the Indices Delete Data Stream API request.
IndicesDeleteIndexTemplateRequest configures the Indices Delete Index Template API request.
IndicesDeleteRequest configures the Indices Delete API request.
IndicesDeleteTemplateRequest configures the Indices Delete Template API request.
IndicesDiskUsageRequest configures the Indices Disk Usage API request.
IndicesExistsAliasRequest configures the Indices Exists Alias API request.
IndicesExistsDocumentTypeRequest configures the Indices Exists Document Type API request.
IndicesExistsIndexTemplateRequest configures the Indices Exists Index Template API request.
IndicesExistsRequest configures the Indices Exists API request.
IndicesExistsTemplateRequest configures the Indices Exists Template API request.
IndicesFieldUsageStatsRequest configures the Indices Field Usage Stats API request.
IndicesFlushRequest configures the Indices Flush API request.
IndicesFlushSyncedRequest configures the Indices Flush Synced API request.
IndicesForcemergeRequest configures the Indices Forcemerge API request.
IndicesFreezeRequest configures the Indices Freeze API request.
IndicesGetAliasRequest configures the Indices Get Alias API request.
IndicesGetDataStreamRequest configures the Indices Get Data Stream API request.
IndicesGetFieldMappingRequest configures the Indices Get Field Mapping API request.
IndicesGetIndexTemplateRequest configures the Indices Get Index Template API request.
IndicesGetMappingRequest configures the Indices Get Mapping API request.
IndicesGetRequest configures the Indices Get API request.
IndicesGetSettingsRequest configures the Indices Get Settings API request.
IndicesGetTemplateRequest configures the Indices Get Template API request.
IndicesGetUpgradeRequest configures the Indices Get Upgrade API request.
IndicesMigrateToDataStreamRequest configures the Indices Migrate To Data Stream API request.
IndicesModifyDataStreamRequest configures the Indices Modify Data Stream API request.
IndicesOpenRequest configures the Indices Open API request.
IndicesPromoteDataStreamRequest configures the Indices Promote Data Stream API request.
IndicesPutAliasRequest configures the Indices Put Alias API request.
IndicesPutIndexTemplateRequest configures the Indices Put Index Template API request.
IndicesPutMappingRequest configures the Indices Put Mapping API request.
IndicesPutSettingsRequest configures the Indices Put Settings API request.
IndicesPutTemplateRequest configures the Indices Put Template API request.
IndicesRecoveryRequest configures the Indices Recovery API request.
IndicesRefreshRequest configures the Indices Refresh API request.
IndicesReloadSearchAnalyzersRequest configures the Indices Reload Search Analyzers API request.
IndicesResolveIndexRequest configures the Indices Resolve Index API request.
IndicesRolloverRequest configures the Indices Rollover API request.
IndicesSegmentsRequest configures the Indices Segments API request.
IndicesShardStoresRequest configures the Indices Shard Stores API request.
IndicesShrinkRequest configures the Indices Shrink API request.
IndicesSimulateIndexTemplateRequest configures the Indices Simulate Index Template API request.
IndicesSimulateTemplateRequest configures the Indices Simulate Template API request.
IndicesSplitRequest configures the Indices Split API request.
IndicesStatsRequest configures the Indices Stats API request.
IndicesUnfreezeRequest configures the Indices Unfreeze API request.
IndicesUpdateAliasesRequest configures the Indices Update Aliases API request.
IndicesUpgradeRequest configures the Indices Upgrade API request.
IndicesValidateQueryRequest configures the Indices Validate Query API request.
InfoRequest configures the Info API request.
Ingest contains the Ingest APIs.
IngestDeletePipelineRequest configures the Ingest Delete Pipeline API request.
IngestGeoIPStatsRequest configures the Ingest GeoIP Stats API request.
IngestGetPipelineRequest configures the Ingest Get Pipeline API request.
IngestProcessorGrokRequest configures the Ingest Processor Grok API request.
IngestPutPipelineRequest configures the Ingest Put Pipeline API request.
IngestSimulateRequest configures the Ingest Simulate API request.
License contains the License APIs.
LicenseDeleteRequest configures the License Delete API request.
LicenseGetBasicStatusRequest configures the License Get Basic Status API request.
LicenseGetRequest configures the License Get API request.
LicenseGetTrialStatusRequest configures the License Get Trial Status API request.
LicensePostRequest configures the License Post API request.
LicensePostStartBasicRequest configures the License Post Start Basic API request.
LicensePostStartTrialRequest configures the License Post Start Trial API request.
LogstashDeletePipelineRequest configures the Logstash Delete Pipeline API request.
LogstashGetPipelineRequest configures the Logstash Get Pipeline API request.
LogstashPutPipelineRequest configures the Logstash Put Pipeline API request.
MgetRequest configures the Mget API request.
Migration contains the Migration APIs.
MigrationDeprecationsRequest configures the Migration Deprecations API request.
MigrationGetFeatureUpgradeStatusRequest configures the Migration Get Feature Upgrade Status API request.
MigrationPostFeatureUpgradeRequest configures the Migration Post Feature Upgrade API request.
ML contains the ML APIs.
MLCloseJobRequest configures the ML Close Job API request.
MLDeleteCalendarEventRequest configures the ML Delete Calendar Event API request.
MLDeleteCalendarJobRequest configures the ML Delete Calendar Job API request.
MLDeleteCalendarRequest configures the ML Delete Calendar API request.
MLDeleteDatafeedRequest configures the ML Delete Datafeed API request.
MLDeleteDataFrameAnalyticsRequest configures the ML Delete Data Frame Analytics API request.
MLDeleteExpiredDataRequest configures the ML Delete Expired Data API request.
MLDeleteFilterRequest configures the ML Delete Filter API request.
MLDeleteForecastRequest configures the ML Delete Forecast API request.
MLDeleteJobRequest configures the ML Delete Job API request.
MLDeleteModelSnapshotRequest configures the ML Delete Model Snapshot API request.
MLDeleteTrainedModelAliasRequest configures the ML Delete Trained Model Alias API request.
MLDeleteTrainedModelRequest configures the ML Delete Trained Model API request.
MLEstimateModelMemoryRequest configures the ML Estimate Model Memory API request.
MLEvaluateDataFrameRequest configures the ML Evaluate Data Frame API request.
MLExplainDataFrameAnalyticsRequest configures the ML Explain Data Frame Analytics API request.
MLFindFileStructureRequest configures the ML Find File Structure API request.
MLFlushJobRequest configures the ML Flush Job API request.
MLForecastRequest configures the ML Forecast API request.
MLGetBucketsRequest configures the ML Get Buckets API request.
MLGetCalendarEventsRequest configures the ML Get Calendar Events API request.
MLGetCalendarsRequest configures the ML Get Calendars API request.
MLGetCategoriesRequest configures the ML Get Categories API request.
MLGetDatafeedsRequest configures the ML Get Datafeeds API request.
MLGetDatafeedStatsRequest configures the ML Get Datafeed Stats API request.
MLGetDataFrameAnalyticsRequest configures the ML Get Data Frame Analytics API request.
MLGetDataFrameAnalyticsStatsRequest configures the ML Get Data Frame Analytics Stats API request.
MLGetFiltersRequest configures the ML Get Filters API request.
MLGetInfluencersRequest configures the ML Get Influencers API request.
MLGetJobsRequest configures the ML Get Jobs API request.
MLGetJobStatsRequest configures the ML Get Job Stats API request.
MLGetModelSnapshotsRequest configures the ML Get Model Snapshots API request.
MLGetModelSnapshotUpgradeStatsRequest configures the ML Get Model Snapshot Upgrade Stats API request.
MLGetOverallBucketsRequest configures the ML Get Overall Buckets API request.
MLGetRecordsRequest configures the ML Get Records API request.
MLGetTrainedModelsRequest configures the ML Get Trained Models API request.
MLGetTrainedModelsStatsRequest configures the ML Get Trained Models Stats API request.
MLInfoRequest configures the ML Info API request.
MLOpenJobRequest configures the ML Open Job API request.
MLPostCalendarEventsRequest configures the ML Post Calendar Events API request.
MLPostDataRequest configures the ML Post Data API request.
MLPreviewDatafeedRequest configures the ML Preview Datafeed API request.
MLPreviewDataFrameAnalyticsRequest configures the ML Preview Data Frame Analytics API request.
MLPutCalendarJobRequest configures the ML Put Calendar Job API request.
MLPutCalendarRequest configures the ML Put Calendar API request.
MLPutDatafeedRequest configures the ML Put Datafeed API request.
MLPutDataFrameAnalyticsRequest configures the ML Put Data Frame Analytics API request.
MLPutFilterRequest configures the ML Put Filter API request.
MLPutJobRequest configures the ML Put Job API request.
MLPutTrainedModelAliasRequest configures the ML Put Trained Model Alias API request.
MLPutTrainedModelRequest configures the ML Put Trained Model API request.
MLResetJobRequest configures the ML Reset Job API request.
MLRevertModelSnapshotRequest configures the ML Revert Model Snapshot API request.
MLSetUpgradeModeRequest configures the ML Set Upgrade Mode API request.
MLStartDatafeedRequest configures the ML Start Datafeed API request.
MLStartDataFrameAnalyticsRequest configures the ML Start Data Frame Analytics API request.
MLStopDatafeedRequest configures the ML Stop Datafeed API request.
MLStopDataFrameAnalyticsRequest configures the ML Stop Data Frame Analytics API request.
MLUpdateDatafeedRequest configures the ML Update Datafeed API request.
MLUpdateDataFrameAnalyticsRequest configures the ML Update Data Frame Analytics API request.
MLUpdateFilterRequest configures the ML Update Filter API request.
MLUpdateJobRequest configures the ML Update Job API request.
MLUpdateModelSnapshotRequest configures the ML Update Model Snapshot API request.
MLUpgradeJobSnapshotRequest configures the ML Upgrade Job Snapshot API request.
MLValidateDetectorRequest configures the ML Validate Detector API request.
MLValidateRequest configures the ML Validate API request.
Monitoring contains the Monitoring APIs.
MonitoringBulkRequest configures the Monitoring Bulk API request.
MsearchRequest configures the Msearch API request.
MsearchTemplateRequest configures the Msearch Template API request.
MtermvectorsRequest configures the Mtermvectors API request.
Nodes contains the Nodes APIs.
NodesClearMeteringArchiveRequest configures the Nodes Clear Metering Archive API request.
NodesClearRepositoriesMeteringArchiveRequest configures the Nodes Clear Repositories Metering Archive API request.
NodesGetMeteringInfoRequest configures the Nodes Get Metering Info API request.
NodesGetRepositoriesMeteringInfoRequest configures the Nodes Get Repositories Metering Info API request.
NodesHotThreadsRequest configures the Nodes Hot Threads API request.
NodesInfoRequest configures the Nodes Info API request.
NodesReloadSecureSettingsRequest configures the Nodes Reload Secure Settings API request.
NodesStatsRequest configures the Nodes Stats API request.
NodesUsageRequest configures the Nodes Usage API request.
OpenPointInTimeRequest configures the Open Point In Time API request.
PingRequest configures the Ping API request.
PutScriptRequest configures the Put Script API request.
RankEvalRequest configures the Rank Eval API request.
ReindexRequest configures the Reindex API request.
ReindexRethrottleRequest configures the Reindex Rethrottle API request.
Remote contains the Remote APIs.
RenderSearchTemplateRequest configures the Render Search Template API request.
Response represents the API response.
Rollup contains the Rollup APIs.
RollupDeleteJobRequest configures the Rollup Delete Job API request.
RollupGetJobsRequest configures the Rollup Get Jobs API request.
RollupGetRollupCapsRequest configures the Rollup Get Rollup Caps API request.
RollupGetRollupIndexCapsRequest configures the Rollup Get Rollup Index Caps API request.
RollupPutJobRequest configures the Rollup Put Job API request.
RollupRollupRequest configures the Rollup Rollup API request.
RollupRollupSearchRequest configures the Rollup Rollup Search API request.
RollupStartJobRequest configures the Rollup Start Job API request.
RollupStopJobRequest configures the Rollup Stop Job API request.
ScriptsPainlessExecuteRequest configures the Scripts Painless Execute API request.
ScrollRequest configures the Scroll API request.
SearchableSnapshotsCacheStatsRequest configures the Searchable Snapshots Cache Stats API request.
SearchableSnapshotsClearCacheRequest configures the Searchable Snapshots Clear Cache API request.
SearchableSnapshotsMountRequest configures the Searchable Snapshots Mount API request.
SearchableSnapshotsRepositoryStatsRequest configures the Searchable Snapshots Repository Stats API request.
SearchableSnapshotsStatsRequest configures the Searchable Snapshots Stats API request.
SearchMvtRequest configures the Search Mvt API request.
SearchRequest configures the Search API request.
SearchShardsRequest configures the Search Shards API request.
SearchTemplateRequest configures the Search Template API request.
Security contains the Security APIs.
SecurityAuthenticateRequest configures the Security Authenticate API request.
SecurityChangePasswordRequest configures the Security Change Password API request.
SecurityClearAPIKeyCacheRequest configures the Security ClearAPI Key Cache API request.
SecurityClearCachedPrivilegesRequest configures the Security Clear Cached Privileges API request.
SecurityClearCachedRealmsRequest configures the Security Clear Cached Realms API request.
SecurityClearCachedRolesRequest configures the Security Clear Cached Roles API request.
SecurityClearCachedServiceTokensRequest configures the Security Clear Cached Service Tokens API request.
SecurityCreateAPIKeyRequest configures the Security CreateAPI Key API request.
SecurityCreateServiceTokenRequest configures the Security Create Service Token API request.
SecurityDeletePrivilegesRequest configures the Security Delete Privileges API request.
SecurityDeleteRoleMappingRequest configures the Security Delete Role Mapping API request.
SecurityDeleteRoleRequest configures the Security Delete Role API request.
SecurityDeleteServiceTokenRequest configures the Security Delete Service Token API request.
SecurityDeleteUserRequest configures the Security Delete User API request.
SecurityDisableUserRequest configures the Security Disable User API request.
SecurityEnableUserRequest configures the Security Enable User API request.
SecurityGetAPIKeyRequest configures the Security GetAPI Key API request.
SecurityGetBuiltinPrivilegesRequest configures the Security Get Builtin Privileges API request.
SecurityGetPrivilegesRequest configures the Security Get Privileges API request.
SecurityGetRoleMappingRequest configures the Security Get Role Mapping API request.
SecurityGetRoleRequest configures the Security Get Role API request.
SecurityGetServiceAccountsRequest configures the Security Get Service Accounts API request.
SecurityGetServiceCredentialsRequest configures the Security Get Service Credentials API request.
SecurityGetTokenRequest configures the Security Get Token API request.
SecurityGetUserPrivilegesRequest configures the Security Get User Privileges API request.
SecurityGetUserRequest configures the Security Get User API request.
SecurityGrantAPIKeyRequest configures the Security GrantAPI Key API request.
SecurityHasPrivilegesRequest configures the Security Has Privileges API request.
SecurityInvalidateAPIKeyRequest configures the Security InvalidateAPI Key API request.
SecurityInvalidateTokenRequest configures the Security Invalidate Token API request.
SecurityPutPrivilegesRequest configures the Security Put Privileges API request.
SecurityPutRoleMappingRequest configures the Security Put Role Mapping API request.
SecurityPutRoleRequest configures the Security Put Role API request.
SecurityPutUserRequest configures the Security Put User API request.
SecurityQueryAPIKeysRequest configures the Security QueryAPI Keys API request.
SecuritySamlAuthenticateRequest configures the Security Saml Authenticate API request.
SecuritySamlCompleteLogoutRequest configures the Security Saml Complete Logout API request.
SecuritySamlInvalidateRequest configures the Security Saml Invalidate API request.
SecuritySamlLogoutRequest configures the Security Saml Logout API request.
SecuritySamlPrepareAuthenticationRequest configures the Security Saml Prepare Authentication API request.
SecuritySamlServiceProviderMetadataRequest configures the Security Saml Service Provider Metadata API request.
ShutdownDeleteNodeRequest configures the Shutdown Delete Node API request.
ShutdownGetNodeRequest configures the Shutdown Get Node API request.
ShutdownPutNodeRequest configures the Shutdown Put Node API request.
SlmDeleteLifecycleRequest configures the Slm Delete Lifecycle API request.
SlmExecuteLifecycleRequest configures the Slm Execute Lifecycle API request.
SlmExecuteRetentionRequest configures the Slm Execute Retention API request.
SlmGetLifecycleRequest configures the Slm Get Lifecycle API request.
SlmGetStatsRequest configures the Slm Get Stats API request.
SlmGetStatusRequest configures the Slm Get Status API request.
SlmPutLifecycleRequest configures the Slm Put Lifecycle API request.
SlmStartRequest configures the Slm Start API request.
SlmStopRequest configures the Slm Stop API request.
Snapshot contains the Snapshot APIs.
SnapshotCleanupRepositoryRequest configures the Snapshot Cleanup Repository API request.
SnapshotCloneRequest configures the Snapshot Clone API request.
SnapshotCreateRepositoryRequest configures the Snapshot Create Repository API request.
SnapshotCreateRequest configures the Snapshot Create API request.
SnapshotDeleteRepositoryRequest configures the Snapshot Delete Repository API request.
SnapshotDeleteRequest configures the Snapshot Delete API request.
SnapshotGetRepositoryRequest configures the Snapshot Get Repository API request.
SnapshotGetRequest configures the Snapshot Get API request.
SnapshotRepositoryAnalyzeRequest configures the Snapshot Repository Analyze API request.
SnapshotRestoreRequest configures the Snapshot Restore API request.
SnapshotStatusRequest configures the Snapshot Status API request.
SnapshotVerifyRepositoryRequest configures the Snapshot Verify Repository API request.
SQL contains the SQL APIs.
SQLClearCursorRequest configures the SQL Clear Cursor API request.
SQLDeleteAsyncRequest configures the SQL Delete Async API request.
SQLGetAsyncRequest configures the SQL Get Async API request.
SQLGetAsyncStatusRequest configures the SQL Get Async Status API request.
SQLQueryRequest configures the SQL Query API request.
SQLTranslateRequest configures the SQL Translate API request.
SSL contains the SSL APIs.
SSLCertificatesRequest configures the SSL Certificates API request.
Tasks contains the Tasks APIs.
TasksCancelRequest configures the Tasks Cancel API request.
TasksGetRequest configures the Tasks Get API request.
TasksListRequest configures the Tasks List API request.
TermsEnumRequest configures the Terms Enum API request.
TermvectorsRequest configures the Termvectors API request.
TextStructureFindStructureRequest configures the Text Structure Find Structure API request.
TransformDeleteTransformRequest configures the Transform Delete Transform API request.
TransformGetTransformRequest configures the Transform Get Transform API request.
TransformGetTransformStatsRequest configures the Transform Get Transform Stats API request.
TransformPreviewTransformRequest configures the Transform Preview Transform API request.
TransformPutTransformRequest configures the Transform Put Transform API request.
TransformStartTransformRequest configures the Transform Start Transform API request.
TransformStopTransformRequest configures the Transform Stop Transform API request.
TransformUpdateTransformRequest configures the Transform Update Transform API request.
TransformUpgradeTransformsRequest configures the Transform Upgrade Transforms API request.
UpdateByQueryRequest configures the Update By Query API request.
UpdateByQueryRethrottleRequest configures the Update By Query Rethrottle API request.
UpdateRequest configures the Update API request.
Watcher contains the Watcher APIs.
WatcherAckWatchRequest configures the Watcher Ack Watch API request.
WatcherActivateWatchRequest configures the Watcher Activate Watch API request.
WatcherDeactivateWatchRequest configures the Watcher Deactivate Watch API request.
WatcherDeleteWatchRequest configures the Watcher Delete Watch API request.
WatcherExecuteWatchRequest configures the Watcher Execute Watch API request.
WatcherGetWatchRequest configures the Watcher Get Watch API request.
WatcherPutWatchRequest configures the Watcher Put Watch API request.
WatcherQueryWatchesRequest configures the Watcher Query Watches API request.
WatcherStartRequest configures the Watcher Start API request.
WatcherStatsRequest configures the Watcher Stats API request.
WatcherStopRequest configures the Watcher Stop API request.
XPack contains the XPack APIs.
XPackInfoRequest configures the X Pack Info API request.
XPackUsageRequest configures the X Pack Usage API request.

# Interfaces

Request defines the API request.
Transport defines the interface for an API client.

# Type aliases

AsyncSearchDelete - Deletes an async search by ID.
AsyncSearchGet - Retrieves the results of a previously submitted async search request given its ID.
AsyncSearchStatus - Retrieves the status of a previously submitted async search request given its ID.
AsyncSearchSubmit - Executes a search request asynchronously.
AutoscalingDeleteAutoscalingPolicy - Deletes an autoscaling policy.
AutoscalingGetAutoscalingCapacity - Gets the current autoscaling capacity based on the configured autoscaling policy.
AutoscalingGetAutoscalingDecision - Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed.
AutoscalingGetAutoscalingPolicy - Retrieves an autoscaling policy.
AutoscalingPutAutoscalingPolicy - Creates a new autoscaling policy.
Bulk allows to perform multiple index/update/delete operations in a single request.
CatAliases shows information about currently configured aliases to indices including filter and routing infos.
CatAllocation provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
CatCount provides quick access to the document count of the entire cluster, or individual indices.
CatFielddata shows how much heap memory is currently being used by fielddata on every data node in the cluster.
CatHealth returns a concise representation of the cluster health.
CatHelp returns help for the Cat APIs.
CatIndices returns information about indices: number of primaries and replicas, document counts, disk size, ..
CatMaster returns information about the master node.
CatMLDatafeeds - Gets configuration and usage information about datafeeds.
CatMLDataFrameAnalytics - Gets configuration and usage information about data frame analytics jobs.
CatMLJobs - Gets configuration and usage information about anomaly detection jobs.
CatMLTrainedModels - Gets configuration and usage information about inference trained models.
CatNodeattrs returns information about custom node attributes.
CatNodes returns basic statistics about performance of cluster nodes.
CatPendingTasks returns a concise representation of the cluster pending tasks.
CatPlugins returns information about installed plugins across nodes node.
CatRecovery returns information about index shard recoveries, both on-going completed.
CatRepositories returns information about snapshot repositories registered in the cluster.
CatSegments provides low-level information about the segments in the shards of an index.
CatShards provides a detailed view of shard allocation on nodes.
CatSnapshots returns all snapshots in a specific repository.
CatTasks returns information about the tasks currently executing on one or more nodes in the cluster.
CatTemplates returns information about existing templates.
CatThreadPool returns cluster-wide thread pool statistics per node.
CatTransforms - Gets configuration and usage information about transforms.
CCRDeleteAutoFollowPattern - Deletes auto-follow patterns.
CCRFollow - Creates a new follower index configured to follow the referenced leader index.
CCRFollowInfo - Retrieves information about all follower indices, including parameters and status for each follower index See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html.
CCRFollowStats - Retrieves follower stats.
CCRForgetFollower - Removes the follower retention leases from the leader.
CCRGetAutoFollowPattern - Gets configured auto-follow patterns.
CCRPauseAutoFollowPattern - Pauses an auto-follow pattern See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html.
CCRPauseFollow - Pauses a follower index.
CCRPutAutoFollowPattern - Creates a new named collection of auto-follow patterns against a specified remote cluster.
CCRResumeAutoFollowPattern - Resumes an auto-follow pattern that has been paused See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html.
CCRResumeFollow - Resumes a follower index that has been paused See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html.
CCRStats - Gets all stats related to cross-cluster replication.
CCRUnfollow - Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
ClearScroll explicitly clears the search context for a scroll.
ClosePointInTime - Close a point in time See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html.
ClusterAllocationExplain provides explanations for shard allocations in the cluster.
ClusterDeleteComponentTemplate deletes a component template See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.
ClusterDeleteVotingConfigExclusions clears cluster voting config exclusions.
ClusterExistsComponentTemplate returns information about whether a particular component template exist See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.
ClusterGetComponentTemplate returns one or more component templates See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.
ClusterGetSettings returns cluster settings.
ClusterHealth returns basic information about the health of the cluster.
ClusterPendingTasks returns a list of any cluster-level changes (e.g.
ClusterPostVotingConfigExclusions updates the cluster voting config exclusions by node ids or node names.
ClusterPutComponentTemplate creates or updates a component template See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html.
ClusterPutSettings updates the cluster settings.
ClusterRemoteInfo returns the information about configured remote clusters.
ClusterReroute allows to manually change the allocation of individual shards in the cluster.
ClusterState returns a comprehensive information about the state of the cluster.
ClusterStats returns high-level overview of cluster statistics.
Count returns number of documents matching a query.
Create creates a new document in the index.
DanglingIndicesDeleteDanglingIndex deletes the specified dangling index See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html.
DanglingIndicesImportDanglingIndex imports the specified dangling index See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html.
DanglingIndicesListDanglingIndices returns all dangling indices.
DataFrameTransformDeprecatedDeleteTransform - Deletes an existing transform.
DataFrameTransformDeprecatedGetTransform - Retrieves configuration information for transforms.
DataFrameTransformDeprecatedGetTransformStats - Retrieves usage information for transforms.
DataFrameTransformDeprecatedPreviewTransform - Previews a transform.
DataFrameTransformDeprecatedPutTransform - Instantiates a transform.
DataFrameTransformDeprecatedStartTransform - Starts one or more transforms.
DataFrameTransformDeprecatedStopTransform - Stops one or more transforms.
DataFrameTransformDeprecatedUpdateTransform - Updates certain properties of a transform.
Delete removes a document from the index.
DeleteByQuery deletes documents matching the provided query.
DeleteByQueryRethrottle changes the number of requests per second for a particular Delete By Query operation.
DeleteScript deletes a script.
EnrichDeletePolicy - Deletes an existing enrich policy and its enrich index.
EnrichExecutePolicy - Creates the enrich index for an existing enrich policy.
EnrichGetPolicy - Gets information about an enrich policy.
EnrichPutPolicy - Creates a new enrich policy.
EnrichStats - Gets enrich coordinator statistics and information about enrich policies that are currently executing.
EqlDelete - Deletes an async EQL search by ID.
EqlGet - Returns async results from previously executed Event Query Language (EQL) search See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.
EqlGetStatus - Returns the status of a previously submitted async or stored Event Query Language (EQL) search See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.
EqlSearch - Returns results matching a query expressed in Event Query Language (EQL) See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html.
Exists returns information about whether a document exists in an index.
ExistsSource returns information about whether a document source exists in an index.
Explain returns information about why a specific matches (or doesn't match) a query.
FeaturesGetFeatures gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html.
FeaturesResetFeatures resets the internal state of features, usually by deleting system indices This API is experimental.
FieldCaps returns the information about the capabilities of fields among multiple indices.
FleetGlobalCheckpoints returns the current global checkpoints for an index.
FleetMsearch multi Search API where the search will only be executed after specified checkpoints are available due to a refresh.
FleetSearch search API where the search will only be executed after specified checkpoints are available due to a refresh.
Get returns a document.
GetScript returns a script.
GetScriptContext returns all script contexts.
GetScriptLanguages returns available script types, languages and contexts See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html.
GetSource returns the source of a document.
GraphExplore - Explore extracted and summarized information about the documents and terms in an index.
ILMDeleteLifecycle - Deletes the specified lifecycle policy definition.
ILMExplainLifecycle - Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
ILMGetLifecycle - Returns the specified policy definition.
ILMGetStatus - Retrieves the current index lifecycle management (ILM) status.
ILMMigrateToDataTiers - Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html.
ILMMoveToStep - Manually moves an index into the specified step and executes that step.
ILMPutLifecycle - Creates a lifecycle policy See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html.
ILMRemovePolicy - Removes the assigned lifecycle policy and stops managing the specified index See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html.
ILMRetry - Retries executing the policy for an index that is in the ERROR step.
ILMStart - Start the index lifecycle management (ILM) plugin.
ILMStop - Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html.
Index creates or updates a document in an index.
IndicesAddBlock adds a block to an index.
IndicesAnalyze performs the analysis process on a text and return the tokens breakdown of the text.
IndicesClearCache clears all or specific caches for one or more indices.
IndicesClone clones an index See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html.
IndicesClose closes an index.
IndicesCreate creates an index with optional settings and mappings.
IndicesCreateDataStream - Creates a data stream See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.
IndicesDataStreamsStats - Provides statistics on operations happening in a data stream.
IndicesDelete deletes an index.
IndicesDeleteAlias deletes an alias.
IndicesDeleteDataStream - Deletes a data stream.
IndicesDeleteIndexTemplate deletes an index template.
IndicesDeleteTemplate deletes an index template.
IndicesDiskUsage analyzes the disk usage of each field of an index or data stream This API is experimental.
IndicesExists returns information about whether a particular index exists.
IndicesExistsAlias returns information about whether a particular alias exists.
IndicesExistsDocumentType returns information about whether a particular document type exists.
IndicesExistsIndexTemplate returns information about whether a particular index template exists.
IndicesExistsTemplate returns information about whether a particular index template exists.
IndicesFieldUsageStats returns the field usage stats for each field of an index This API is experimental.
IndicesFlush performs the flush operation on one or more indices.
IndicesFlushSynced performs a synced flush operation on one or more indices.
IndicesForcemerge performs the force merge operation on one or more indices.
IndicesFreeze - Freezes an index.
IndicesGet returns information about one or more indices.
IndicesGetAlias returns an alias.
IndicesGetDataStream - Returns data streams.
IndicesGetFieldMapping returns mapping for one or more fields.
IndicesGetIndexTemplate returns an index template.
IndicesGetMapping returns mappings for one or more indices.
IndicesGetSettings returns settings for one or more indices.
IndicesGetTemplate returns an index template.
IndicesGetUpgrade deprecated Returns a progress status of current upgrade.
IndicesMigrateToDataStream - Migrates an alias to a data stream See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.
IndicesModifyDataStream modifies a data stream See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.
IndicesOpen opens an index.
IndicesPromoteDataStream - Promotes a data stream from a replicated data stream managed by CCR to a regular data stream See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html.
IndicesPutAlias creates or updates an alias.
IndicesPutIndexTemplate creates or updates an index template.
IndicesPutMapping updates the index mappings.
IndicesPutSettings updates the index settings.
IndicesPutTemplate creates or updates an index template.
IndicesRecovery returns information about ongoing index shard recoveries.
IndicesRefresh performs the refresh operation in one or more indices.
IndicesReloadSearchAnalyzers - Reloads an index's search analyzers and their resources.
IndicesResolveIndex returns information about any matching indices, aliases, and data streams See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html.
IndicesRollover updates an alias to point to a new index when the existing index is considered to be too large or too old.
IndicesSegments provides low-level information about segments in a Lucene index.
IndicesShardStores provides store information for shard copies of indices.
IndicesShrink allow to shrink an existing index into a new index with fewer primary shards.
IndicesSimulateIndexTemplate simulate matching the given index name against the index templates in the system See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
IndicesSimulateTemplate simulate resolving the given template name or body See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html.
IndicesSplit allows you to split an existing index into a new index with more primary shards.
IndicesStats provides statistics on operations happening in an index.
IndicesUnfreeze - Unfreezes an index.
IndicesUpdateAliases updates index aliases.
IndicesUpgrade deprecated Upgrades to the current version of Lucene.
IndicesValidateQuery allows a user to validate a potentially expensive query without executing it.
Info returns basic information about the cluster.
IngestDeletePipeline deletes a pipeline.
IngestGeoIPStats returns statistical information about geoip databases See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html.
IngestGetPipeline returns a pipeline.
IngestProcessorGrok returns a list of the built-in patterns.
IngestPutPipeline creates or updates a pipeline.
IngestSimulate allows to simulate a pipeline with example documents.
LicenseDelete - Deletes licensing information for the cluster See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html.
LicenseGet - Retrieves licensing information for the cluster See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html.
LicenseGetBasicStatus - Retrieves information about the status of the basic license.
LicenseGetTrialStatus - Retrieves information about the status of the trial license.
LicensePost - Updates the license for the cluster.
LicensePostStartBasic - Starts an indefinite basic license.
LicensePostStartTrial - starts a limited time trial license.
LogstashDeletePipeline - Deletes Logstash Pipelines used by Central Management See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html.
LogstashGetPipeline - Retrieves Logstash Pipelines used by Central Management See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html.
LogstashPutPipeline - Adds and updates Logstash Pipelines used for Central Management See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html.
Mget allows to get multiple documents in one request.
MigrationDeprecations - 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.
MigrationGetFeatureUpgradeStatus - Find out whether system features need to be upgraded or not See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html.
MigrationPostFeatureUpgrade - Begin upgrades for system features See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html.
MLCloseJob - Closes one or more anomaly detection jobs.
MLDeleteCalendar - Deletes a calendar.
MLDeleteCalendarEvent - Deletes scheduled events from a calendar.
MLDeleteCalendarJob - Deletes anomaly detection jobs from a calendar.
MLDeleteDatafeed - Deletes an existing datafeed.
MLDeleteDataFrameAnalytics - Deletes an existing data frame analytics job.
MLDeleteExpiredData - Deletes expired and unused machine learning data.
MLDeleteFilter - Deletes a filter.
MLDeleteForecast - Deletes forecasts from a machine learning job.
MLDeleteJob - Deletes an existing anomaly detection job.
MLDeleteModelSnapshot - Deletes an existing model snapshot.
MLDeleteTrainedModel - Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
MLDeleteTrainedModelAlias - Deletes a model alias that refers to the trained model See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html.
MLEstimateModelMemory - Estimates the model memory See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html.
MLEvaluateDataFrame - Evaluates the data frame analytics for an annotated index.
MLExplainDataFrameAnalytics - Explains a data frame analytics config.
MLFindFileStructure - Finds the structure of a text file.
MLFlushJob - Forces any buffered data to be processed by the job.
MLForecast - Predicts the future behavior of a time series by using its historical behavior.
MLGetBuckets - Retrieves anomaly detection job results for one or more buckets.
MLGetCalendarEvents - Retrieves information about the scheduled events in calendars.
MLGetCalendars - Retrieves configuration information for calendars.
MLGetCategories - Retrieves anomaly detection job results for one or more categories.
MLGetDatafeeds - Retrieves configuration information for datafeeds.
MLGetDatafeedStats - Retrieves usage information for datafeeds.
MLGetDataFrameAnalytics - Retrieves configuration information for data frame analytics jobs.
MLGetDataFrameAnalyticsStats - Retrieves usage information for data frame analytics jobs.
MLGetFilters - Retrieves filters.
MLGetInfluencers - Retrieves anomaly detection job results for one or more influencers.
MLGetJobs - Retrieves configuration information for anomaly detection jobs.
MLGetJobStats - Retrieves usage information for anomaly detection jobs.
MLGetModelSnapshots - Retrieves information about model snapshots.
MLGetModelSnapshotUpgradeStats - Gets stats for anomaly detection job model snapshot upgrades that are in progress.
MLGetOverallBuckets - Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
MLGetRecords - Retrieves anomaly records for an anomaly detection job.
MLGetTrainedModels - Retrieves configuration information for a trained inference model.
MLGetTrainedModelsStats - Retrieves usage information for trained inference models.
MLInfo - Returns defaults and limits used by machine learning.
MLOpenJob - Opens one or more anomaly detection jobs.
MLPostCalendarEvents - Posts scheduled events in a calendar.
MLPostData - Sends data to an anomaly detection job for analysis.
MLPreviewDatafeed - Previews a datafeed.
MLPreviewDataFrameAnalytics - Previews that will be analyzed given a data frame analytics config.
MLPutCalendar - Instantiates a calendar.
MLPutCalendarJob - Adds an anomaly detection job to a calendar.
MLPutDatafeed - Instantiates a datafeed.
MLPutDataFrameAnalytics - Instantiates a data frame analytics job.
MLPutFilter - Instantiates a filter.
MLPutJob - Instantiates an anomaly detection job.
MLPutTrainedModel - Creates an inference trained model.
MLPutTrainedModelAlias - Creates a new model alias (or reassigns an existing one) to refer to the trained model See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html.
MLResetJob - Resets an existing anomaly detection job.
MLRevertModelSnapshot - Reverts to a specific snapshot.
MLSetUpgradeMode - Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
MLStartDatafeed - Starts one or more datafeeds.
MLStartDataFrameAnalytics - Starts a data frame analytics job.
MLStopDatafeed - Stops one or more datafeeds.
MLStopDataFrameAnalytics - Stops one or more data frame analytics jobs.
MLUpdateDatafeed - Updates certain properties of a datafeed.
MLUpdateDataFrameAnalytics - Updates certain properties of a data frame analytics job.
MLUpdateFilter - Updates the description of a filter, adds items, or removes items.
MLUpdateJob - Updates certain properties of an anomaly detection job.
MLUpdateModelSnapshot - Updates certain properties of a snapshot.
MLUpgradeJobSnapshot - Upgrades a given job snapshot to the current major version.
MLValidate - Validates an anomaly detection job.
MLValidateDetector - Validates an anomaly detection detector.
MonitoringBulk - Used by the monitoring features to send monitoring data.
Msearch allows to execute several search operations in one request.
MsearchTemplate allows to execute several search template operations in one request.
Mtermvectors returns multiple termvectors in one request.
NodesClearMeteringArchive removes the archived repositories metering information present in the cluster.
NodesClearRepositoriesMeteringArchive removes the archived repositories metering information present in the cluster.
NodesGetMeteringInfo returns cluster repositories metering information.
NodesGetRepositoriesMeteringInfo returns cluster repositories metering information.
NodesHotThreads returns information about hot threads on each node in the cluster.
NodesInfo returns information about nodes in the cluster.
NodesReloadSecureSettings reloads secure settings.
NodesStats returns statistical information about nodes in the cluster.
NodesUsage returns low-level information about REST actions usage on nodes.
OpenPointInTime - Open a point in time that can be used in subsequent searches See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html.
Ping returns whether the cluster is running.
PutScript creates or updates a script.
RankEval allows to evaluate the quality of ranked search results over a set of typical search queries See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html.
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.
ReindexRethrottle changes the number of requests per second for a particular Reindex operation.
RenderSearchTemplate allows to use the Mustache language to pre-render a search definition.
RollupDeleteJob - Deletes an existing rollup job.
RollupGetJobs - Retrieves the configuration, stats, and status of rollup jobs.
RollupGetRollupCaps - Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
RollupGetRollupIndexCaps - Returns the rollup capabilities of all jobs inside of a rollup index (e.g.
RollupPutJob - Creates a rollup job.
RollupRollup - Rollup an index This API is experimental.
RollupRollupSearch - Enables searching rolled-up data using the standard query DSL.
RollupStartJob - Starts an existing, stopped rollup job.
RollupStopJob - Stops an existing, started rollup job.
ScriptsPainlessExecute allows an arbitrary script to be executed and a result to be returned This API is experimental.
Scroll allows to retrieve a large numbers of results from a single search request.
Search returns results matching a query.
SearchableSnapshotsCacheStats - Retrieve node-level cache statistics about searchable snapshots.
SearchableSnapshotsClearCache - Clear the cache of searchable snapshots.
SearchableSnapshotsMount - Mount a snapshot as a searchable index.
SearchableSnapshotsRepositoryStats - DEPRECATED: This API is replaced by the Repositories Metering API.
SearchableSnapshotsStats - Retrieve shard-level statistics about searchable snapshots.
SearchMvt searches a vector tile for geospatial values.
SearchShards returns information about the indices and shards that a search request would be executed against.
SearchTemplate allows to use the Mustache language to pre-render a search definition.
SecurityAuthenticate - Enables authentication as a user and retrieve information about the authenticated user.
SecurityChangePassword - Changes the passwords of users in the native realm and built-in users.
SecurityClearAPIKeyCache - Clear a subset or all entries from the API key cache.
SecurityClearCachedPrivileges - Evicts application privileges from the native application privileges cache.
SecurityClearCachedRealms - Evicts users from the user cache.
SecurityClearCachedRoles - Evicts roles from the native role cache.
SecurityClearCachedServiceTokens - Evicts tokens from the service account token caches.
SecurityCreateAPIKey - Creates an API key for access without requiring basic authentication.
SecurityCreateServiceToken - Creates a service account token for access without requiring basic authentication.
SecurityDeletePrivileges - Removes application privileges.
SecurityDeleteRole - Removes roles in the native realm.
SecurityDeleteRoleMapping - Removes role mappings.
SecurityDeleteServiceToken - Deletes a service account token.
SecurityDeleteUser - Deletes users from the native realm.
SecurityDisableUser - Disables users in the native realm.
SecurityEnableUser - Enables users in the native realm.
SecurityGetAPIKey - Retrieves information for one or more API keys.
SecurityGetBuiltinPrivileges - Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
SecurityGetPrivileges - Retrieves application privileges.
SecurityGetRole - Retrieves roles in the native realm.
SecurityGetRoleMapping - Retrieves role mappings.
SecurityGetServiceAccounts - Retrieves information about service accounts.
SecurityGetServiceCredentials - Retrieves information of all service credentials for a service account.
SecurityGetToken - Creates a bearer token for access without requiring basic authentication.
SecurityGetUser - Retrieves information about users in the native realm and built-in users.
SecurityGetUserPrivileges - Retrieves security privileges for the logged in user.
SecurityGrantAPIKey - Creates an API key on behalf of another user.
SecurityHasPrivileges - Determines whether the specified user has a specified list of privileges.
SecurityInvalidateAPIKey - Invalidates one or more API keys.
SecurityInvalidateToken - Invalidates one or more access tokens or refresh tokens.
SecurityPutPrivileges - Adds or updates application privileges.
SecurityPutRole - Adds and updates roles in the native realm.
SecurityPutRoleMapping - Creates and updates role mappings.
SecurityPutUser - Adds and updates users in the native realm.
SecurityQueryAPIKeys - Retrieves information for API keys using a subset of query DSL See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html.
SecuritySamlAuthenticate - Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html.
SecuritySamlCompleteLogout - Verifies the logout response sent from the SAML IdP See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html.
SecuritySamlInvalidate - Consumes a SAML LogoutRequest See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html.
SecuritySamlLogout - Invalidates an access token and a refresh token that were generated via the SAML Authenticate API See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html.
SecuritySamlPrepareAuthentication - Creates a SAML authentication request See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html.
SecuritySamlServiceProviderMetadata - Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html.
ShutdownDeleteNode removes a node from the shutdown list.
ShutdownGetNode retrieve status of a node or nodes that are currently marked as shutting down.
ShutdownPutNode adds a node to be shut down.
SlmDeleteLifecycle - Deletes an existing snapshot lifecycle policy.
SlmExecuteLifecycle - Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
SlmExecuteRetention - Deletes any snapshots that are expired according to the policy's retention rules.
SlmGetLifecycle - Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
SlmGetStats - Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
SlmGetStatus - Retrieves the status of snapshot lifecycle management (SLM).
SlmPutLifecycle - Creates or updates a snapshot lifecycle policy.
SlmStart - Turns on snapshot lifecycle management (SLM).
SlmStop - Turns off snapshot lifecycle management (SLM).
SnapshotCleanupRepository removes stale data from repository.
SnapshotClone clones indices from one snapshot into another snapshot in the same repository.
SnapshotCreate creates a snapshot in a repository.
SnapshotCreateRepository creates a repository.
SnapshotDelete deletes a snapshot.
SnapshotDeleteRepository deletes a repository.
SnapshotGet returns information about a snapshot.
SnapshotGetRepository returns information about a repository.
SnapshotRepositoryAnalyze analyzes a repository for correctness and performance See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html.
SnapshotRestore restores a snapshot.
SnapshotStatus returns information about the status of a snapshot.
SnapshotVerifyRepository verifies a repository.
SQLClearCursor - Clears the SQL cursor See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html.
SQLDeleteAsync - Deletes an async SQL search or a stored synchronous SQL search.
SQLGetAsync - Returns the current status and available results for an async SQL search or stored synchronous SQL search See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html.
SQLGetAsyncStatus - Returns the current status of an async SQL search or a stored synchronous SQL search See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html.
SQLQuery - Executes a SQL request See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html.
SQLTranslate - Translates SQL into Elasticsearch queries See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html.
SSLCertificates - Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
TasksCancel cancels a task, if it can be cancelled through an API.
TasksGet returns information about a task.
TasksList returns a list of tasks.
TermsEnum the terms enum API can be used to discover terms in the index that begin with the provided string.
Termvectors returns information and statistics about terms in the fields of a particular document.
TextStructureFindStructure - Finds the structure of a text file.
TransformDeleteTransform - Deletes an existing transform.
TransformGetTransform - Retrieves configuration information for transforms.
TransformGetTransformStats - Retrieves usage information for transforms.
TransformPreviewTransform - Previews a transform.
TransformPutTransform - Instantiates a transform.
TransformStartTransform - Starts one or more transforms.
TransformStopTransform - Stops one or more transforms.
TransformUpdateTransform - Updates certain properties of a transform.
TransformUpgradeTransforms - Upgrades all transforms.
Update updates a document with a script or partial document.
UpdateByQuery performs an update on every document in the index without changing the source, for example to pick up a mapping change.
UpdateByQueryRethrottle changes the number of requests per second for a particular Update By Query operation.
WatcherAckWatch - Acknowledges a watch, manually throttling the execution of the watch's actions.
WatcherActivateWatch - Activates a currently inactive watch.
WatcherDeactivateWatch - Deactivates a currently active watch.
WatcherDeleteWatch - Removes a watch from Watcher.
WatcherExecuteWatch - Forces the execution of a stored watch.
WatcherGetWatch - Retrieves a watch by its ID.
WatcherPutWatch - Creates a new watch, or updates an existing one.
WatcherQueryWatches - Retrieves stored watches.
WatcherStart - Starts Watcher if it is not already running.
WatcherStats - Retrieves the current Watcher metrics.
WatcherStop - Stops Watcher if it is running.
XPackInfo - Retrieves information about the installed X-Pack features.
XPackUsage - Retrieves usage information about the installed X-Pack features.