This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« cat pending tasks API cat recovery API »
Elastic Docs ›Elasticsearch Guide [8.16] ›REST APIs ›Compact and aligned text (CAT) APIs

cat plugins API

edit

cat plugins API

edit

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.

Returns a list of plugins running on each node of a cluster.

Request

edit

GET /_cat/plugins

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Query parameters

edit
format
(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
h
(Optional, string) Comma-separated list of column names to display.
help
(Optional, Boolean) If true, the response includes help information. Defaults to false.
local
(Optional, Boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
master_timeout
(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
s
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
v
(Optional, Boolean) If true, the response includes column headings. Defaults to false.

Examples

edit
resp = client.cat.plugins(
    v=True,
    s="component",
    h="name,component,version,description",
)
print(resp)
response = client.cat.plugins(
  v: true,
  s: 'component',
  h: 'name,component,version,description'
)
puts response
const response = await client.cat.plugins({
  v: "true",
  s: "component",
  h: "name,component,version,description",
});
console.log(response);
GET /_cat/plugins?v=true&s=component&h=name,component,version,description

The API returns the following response:

name    component               version   description
U7321H6 analysis-icu            8.16.0-SNAPSHOT The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.
U7321H6 analysis-kuromoji       8.16.0-SNAPSHOT The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.
U7321H6 analysis-nori           8.16.0-SNAPSHOT The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.
U7321H6 analysis-phonetic       8.16.0-SNAPSHOT The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
U7321H6 analysis-smartcn        8.16.0-SNAPSHOT Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
U7321H6 analysis-stempel        8.16.0-SNAPSHOT The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.
U7321H6 analysis-ukrainian      8.16.0-SNAPSHOT The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.
U7321H6 discovery-azure-classic 8.16.0-SNAPSHOT The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism
U7321H6 discovery-ec2           8.16.0-SNAPSHOT The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.
U7321H6 discovery-gce           8.16.0-SNAPSHOT The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
U7321H6 mapper-annotated-text   8.16.0-SNAPSHOT The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.
U7321H6 mapper-murmur3          8.16.0-SNAPSHOT The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.
U7321H6 mapper-size             8.16.0-SNAPSHOT The Mapper Size plugin allows document to record their uncompressed size at index time.
U7321H6 store-smb               8.16.0-SNAPSHOT The Store SMB plugin adds support for SMB stores.
« cat pending tasks API cat recovery API »