Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Managed Service for OpenSearch API, REST: Extension.List

Written by
Updated at April 18, 2025

Returns the list of available extensions for the specified OpenSearch cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}/extensions

Path parameters

Field

Description

clusterId

string

Required field. Required. ID of the cluster to list extensions in.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a next_page_token that can be used
to get the next page of results in subsequent ListBackups requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. Set page_token to the next_page_token returned by a previous ListBackups
request to get the next page of results.

Response

HTTP Code: 200 - OK

{
  "extensions": [
    {
      "name": "string",
      "id": "string",
      "clusterId": "string",
      "version": "string",
      "active": "boolean",
      "type": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

extensions[]

Extension

Requested list of extensions.

nextPageToken

string

This token allows you to get the next page of results for ListBackups requests,
if the number of results is larger than page_size specified in the request.
To get the next page, specify the value of next_page_token as a value for
the page_token parameter in the next ListBackups request. Subsequent ListBackups
requests will have their own next_page_token to continue paging through the results.

Extension

Field

Description

name

string

Name of the extension.

id

string

Extension unique ID

clusterId

string

ID of the OpenSearch cluster the extension belongs to.

version

string (int64)

Extension version

active

boolean

Flag is extension active now

type

enum (ExtensionType)

Extension type

  • EXTENSION_TYPE_UNSPECIFIED
  • EXTENSION_TYPE_SYNONYMS
  • EXTENSION_TYPE_STOPWORDS
Previous
Get
Next
Create