CAT Plugins API
Introduced 1.0
The CAT plugins operation lists the names, components, and versions of the installed plugins.
Endpoints
GET /_cat/plugins
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
cluster_manager_timeout | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
local | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
Example request
The following example request lists all installed plugins:
GET /_cat/plugins?vresponse = client.cat.plugins(
params = { "v": "true" }
)Example response
name component version
opensearch-node1 analysis-icu 3.3.2
opensearch-node1 opensearch-alerting 3.3.2.0
opensearch-node1 opensearch-anomaly-detection 3.3.2.0
opensearch-node1 opensearch-asynchronous-search 3.3.2.0
opensearch-node1 opensearch-cross-cluster-replication 3.3.2.0
opensearch-node1 opensearch-custom-codecs 3.3.2.0
opensearch-node1 opensearch-flow-framework 3.3.2.0
opensearch-node1 opensearch-geospatial 3.3.2.0
opensearch-node1 opensearch-index-management 3.3.2.0
opensearch-node1 opensearch-job-scheduler 3.3.2.0
opensearch-node1 opensearch-knn 3.3.2.0
opensearch-node1 opensearch-ml 3.3.2.0
opensearch-node1 opensearch-neural-search 3.3.2.0
opensearch-node1 opensearch-notifications 3.3.2.0
opensearch-node1 opensearch-observability 3.3.2.0
opensearch-node1 opensearch-security 3.3.2.0
opensearch-node1 opensearch-sql 3.3.2.0
Response columns
The following table lists all response columns.
| Column | Alias | Description |
|---|---|---|
id | - | The unique node identifier. |
name | n | The node name. |
component | c | The plugin component name. |
version | v | The plugin version. |
description | d | The plugin description and details. |
To display specific columns, use the h query parameter. For example, to show only the node name, component, and version:
GET /_cat/plugins?v&h=name,component,version