All Products
Document Center


Last Updated:Sep 21, 2023

Queries a list of Kibana plug-ins.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET /openapi/instances/{InstanceId}/kibana-plugins HTTP/1.1

Request parameters







InstanceId String Path Yes es-cn-oew1q8bev0002****

The instance ID.

page String Query No 1

The page number of the returned page. Default value: 1.

size Integer Query No 10

The number of entries to return on each page.

Response parameters





RequestId String 11234B4A-34CE-473B-8E61-AD95702E****

The request ID.

Headers Object

The request header.

X-Total-Count Integer 3

The total number of entries returned.

Result Array of PluginItem

The information about the plug-ins.

description String Customize DSL statements to query data.

The description of the extension.

specificationUrl String https://xxxx

The URL of the introduction to the plug-in. The value null is supported.

state String INSTALLED

The installation status of the plug-in. Valid values:

  • UNINSTALLED: not installed
  • INSTALLING: The instance is being installed.
  • UNINSTALLING: The instance is being uninstalled.
  • UPGRADING: The backup gateway is being upgraded.
  • FAILED: The installation failed.
  • UNKNOWN: The creation status cannot be obtained when the cluster is lost.
source String SYSTEM

The source of the plug-in. Valid values:

  • USER: custom plug-in
  • SYSTEM: a preset plug-in
name String bsearch_querybuilder

The name of the extension.


Sample requests

GET /openapi/instances/es-cn-oew1q8bev0002****/kibana-plugins?page=1&size=10 HTTP/1.1
Common request parameters

Sample success responses

JSON format

HTTP/1.1 200 OK

  "Result" : [ {
    "name" : "bsearch_label",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "Mark data in a visual way to complete the query tasks quickly and easily.",
    "specificationUrl" : "https://xxx.html"
  }, {
    "name" : "bsearch_querybuilder",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "Customize DSL statements to query data.",
    "specificationUrl" : "https://xxx.html"
  }, {
    "name" : "network_vis",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "This is a plugin developed for Kibana that displays a network node that link two fields that have been previously selected."
  } ],
  "RequestId" : "11234B4A-34CE-473B-8E61-AD95702E****",
  "Headers" : {
    "X-Total-Count" : 3

Error code

For a list of error codes, see Service error codes.