elasticsearch-js/docs/reference/api/Cat.md

Cat

Constructor

::: new Cat(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
aliases	aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;	Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
aliases	aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAliasesResponse](./CatAliasesResponse.md), unknown>>;
aliases	aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;
allocation	allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;	Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
allocation	allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAllocationResponse](./CatAllocationResponse.md), unknown>>;
allocation	allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;
componentTemplates	componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;	Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
componentTemplates	componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md), unknown>>;
componentTemplates	componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;
count	count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;	Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
count	count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatCountResponse](./CatCountResponse.md), unknown>>;
count	count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;
fielddata	fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;	Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
fielddata	fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatFielddataResponse](./CatFielddataResponse.md), unknown>>;
fielddata	fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;
health	health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;	Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
health	health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHealthResponse](./CatHealthResponse.md), unknown>>;
health	health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;
help	help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;	Get CAT help. Get help for the CAT APIs.
help	help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHelpResponse](./CatHelpResponse.md), unknown>>;
help	help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;
indices	indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;	Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
indices	indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatIndicesResponse](./CatIndicesResponse.md), unknown>>;
indices	indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;
master	master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;	Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
master	master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMasterResponse](./CatMasterResponse.md), unknown>>;
master	master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;
mlDatafeeds	mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;	Get datafeeds. Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
mlDatafeeds	mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md), unknown>>;
mlDatafeeds	mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;
mlDataFrameAnalytics	mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;	Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
mlDataFrameAnalytics	mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md), unknown>>;
mlDataFrameAnalytics	mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;
mlJobs	mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;	Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
mlJobs	mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlJobsResponse](./CatMlJobsResponse.md), unknown>>;
mlJobs	mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;
mlTrainedModels	mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;	Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
mlTrainedModels	mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md), unknown>>;
mlTrainedModels	mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;
nodeattrs	nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;	Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
nodeattrs	nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodeattrsResponse](./CatNodeattrsResponse.md), unknown>>;
nodeattrs	nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;
nodes	nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;	Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
nodes	nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodesResponse](./CatNodesResponse.md), unknown>>;
nodes	nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;
pendingTasks	pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;	Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
pendingTasks	pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPendingTasksResponse](./CatPendingTasksResponse.md), unknown>>;
pendingTasks	pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;
plugins	plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;	Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
plugins	plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPluginsResponse](./CatPluginsResponse.md), unknown>>;
plugins	plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;
recovery	recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;	Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
recovery	recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRecoveryResponse](./CatRecoveryResponse.md), unknown>>;
recovery	recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;
repositories	repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;	Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
repositories	repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRepositoriesResponse](./CatRepositoriesResponse.md), unknown>>;
repositories	repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;
segments	segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;	Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
segments	segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSegmentsResponse](./CatSegmentsResponse.md), unknown>>;
segments	segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;
shards	shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;	Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
shards	shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatShardsResponse](./CatShardsResponse.md), unknown>>;
shards	shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;
snapshots	snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;	Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
snapshots	snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSnapshotsResponse](./CatSnapshotsResponse.md), unknown>>;
snapshots	snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;
tasks	tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;	Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
tasks	tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTasksResponse](./CatTasksResponse.md), unknown>>;
tasks	tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;
templates	templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;	Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
templates	templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTemplatesResponse](./CatTemplatesResponse.md), unknown>>;
templates	templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;
threadPool	threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;	Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
threadPool	threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatThreadPoolResponse](./CatThreadPoolResponse.md), unknown>>;
threadPool	threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;
transforms	transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;	Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
transforms	transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTransformsResponse](./CatTransformsResponse.md), unknown>>;
transforms	transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;