openapi: 3.1.0 info: title: OpenSearch API Specification version: 0.3.0 x-api-version: 2.16.0 paths: /: get: operationId: info.0 x-operation-group: info x-version-added: '1.0' x-distributions-excluded: - amazon-serverless description: Returns basic information about the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/info___200' head: operationId: ping.0 x-operation-group: ping x-version-added: '1.0' description: Returns whether the cluster is running. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ping___200' /_alias: get: operationId: indices.get_alias.0 x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_alias___200' '404': $ref: '#/components/responses/indices.get_alias___404' put: operationId: indices.put_alias.0 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /_alias/{name}: get: operationId: indices.get_alias.1 x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - $ref: '#/components/parameters/indices.get_alias___path.name' - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_alias___200' '404': $ref: '#/components/responses/indices.get_alias___404' head: operationId: indices.exists_alias.0 x-operation-group: indices.exists_alias x-version-added: '1.0' description: Returns information about whether a particular alias exists. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.exists_alias___path.name' - $ref: '#/components/parameters/indices.exists_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.exists_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.exists_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.exists_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.exists_alias___200' '404': $ref: '#/components/responses/indices.exists_alias___404' post: operationId: indices.put_alias.1 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.2 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /_aliases: post: operationId: indices.update_aliases.0 x-operation-group: indices.update_aliases x-version-added: '1.0' description: Updates index aliases. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/alias/ parameters: - $ref: '#/components/parameters/indices.update_aliases___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.update_aliases___query.master_timeout' - $ref: '#/components/parameters/indices.update_aliases___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.update_aliases' responses: '200': $ref: '#/components/responses/indices.update_aliases___200' /_aliases/{name}: post: operationId: indices.put_alias.3 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.4 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /_analyze: get: operationId: indices.analyze.0 x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - $ref: '#/components/parameters/indices.analyze___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze___200' post: operationId: indices.analyze.1 x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - $ref: '#/components/parameters/indices.analyze___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze___200' /_bulk: post: operationId: bulk.0 x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk___query._source' - $ref: '#/components/parameters/bulk___query._source_excludes' - $ref: '#/components/parameters/bulk___query._source_includes' - $ref: '#/components/parameters/bulk___query.index' - $ref: '#/components/parameters/bulk___query.pipeline' - $ref: '#/components/parameters/bulk___query.refresh' - $ref: '#/components/parameters/bulk___query.require_alias' - $ref: '#/components/parameters/bulk___query.routing' - $ref: '#/components/parameters/bulk___query.timeout' - $ref: '#/components/parameters/bulk___query.type' - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk' responses: '200': $ref: '#/components/responses/bulk___200' put: operationId: bulk.1 x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk___query._source' - $ref: '#/components/parameters/bulk___query._source_excludes' - $ref: '#/components/parameters/bulk___query._source_includes' - $ref: '#/components/parameters/bulk___query.index' - $ref: '#/components/parameters/bulk___query.pipeline' - $ref: '#/components/parameters/bulk___query.refresh' - $ref: '#/components/parameters/bulk___query.require_alias' - $ref: '#/components/parameters/bulk___query.routing' - $ref: '#/components/parameters/bulk___query.timeout' - $ref: '#/components/parameters/bulk___query.type' - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk' responses: '200': $ref: '#/components/responses/bulk___200' /_bulk/stream: post: operationId: bulk_stream.0 x-operation-group: bulk_stream x-version-added: '2.17' description: Allows to perform multiple index/update/delete operations using request response streaming. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - $ref: '#/components/parameters/bulk_stream___query._source' - $ref: '#/components/parameters/bulk_stream___query._source_excludes' - $ref: '#/components/parameters/bulk_stream___query._source_includes' - $ref: '#/components/parameters/bulk_stream___query.batch_interval' - $ref: '#/components/parameters/bulk_stream___query.batch_size' - $ref: '#/components/parameters/bulk_stream___query.pipeline' - $ref: '#/components/parameters/bulk_stream___query.refresh' - $ref: '#/components/parameters/bulk_stream___query.require_alias' - $ref: '#/components/parameters/bulk_stream___query.routing' - $ref: '#/components/parameters/bulk_stream___query.timeout' - $ref: '#/components/parameters/bulk_stream___query.type' - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk_stream' responses: '200': $ref: '#/components/responses/bulk_stream___200' put: operationId: bulk_stream.1 x-operation-group: bulk_stream x-version-added: '2.17' description: Allows to perform multiple index/update/delete operations using request response streaming. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - $ref: '#/components/parameters/bulk_stream___query._source' - $ref: '#/components/parameters/bulk_stream___query._source_excludes' - $ref: '#/components/parameters/bulk_stream___query._source_includes' - $ref: '#/components/parameters/bulk_stream___query.batch_interval' - $ref: '#/components/parameters/bulk_stream___query.batch_size' - $ref: '#/components/parameters/bulk_stream___query.pipeline' - $ref: '#/components/parameters/bulk_stream___query.refresh' - $ref: '#/components/parameters/bulk_stream___query.require_alias' - $ref: '#/components/parameters/bulk_stream___query.routing' - $ref: '#/components/parameters/bulk_stream___query.timeout' - $ref: '#/components/parameters/bulk_stream___query.type' - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk_stream' responses: '200': $ref: '#/components/responses/bulk_stream___200' /_cache/clear: post: operationId: indices.clear_cache.0 x-operation-group: indices.clear_cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: - $ref: '#/components/parameters/indices.clear_cache___query.allow_no_indices' - $ref: '#/components/parameters/indices.clear_cache___query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache___query.fielddata' - $ref: '#/components/parameters/indices.clear_cache___query.fields' - $ref: '#/components/parameters/indices.clear_cache___query.file' - $ref: '#/components/parameters/indices.clear_cache___query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache___query.index' - $ref: '#/components/parameters/indices.clear_cache___query.query' - $ref: '#/components/parameters/indices.clear_cache___query.request' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.clear_cache___200' /_cat: get: operationId: cat.help.0 x-operation-group: cat.help x-version-added: '1.0' description: Returns help for the Cat APIs. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/index/ responses: '200': $ref: '#/components/responses/cat.help___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_cat/aliases: get: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' description: Shows information about aliases currently configured to indexes, including filter and routing information. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: - $ref: '#/components/parameters/cat.aliases___query.expand_wildcards' - $ref: '#/components/parameters/cat.aliases___query.format' - $ref: '#/components/parameters/cat.aliases___query.h' - $ref: '#/components/parameters/cat.aliases___query.help' - $ref: '#/components/parameters/cat.aliases___query.local' - $ref: '#/components/parameters/cat.aliases___query.s' - $ref: '#/components/parameters/cat.aliases___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.aliases___200' /_cat/aliases/{name}: get: operationId: cat.aliases.1 x-operation-group: cat.aliases x-version-added: '1.0' description: Shows information about aliases currently configured to indexes, including filter and routing information. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: - $ref: '#/components/parameters/cat.aliases___path.name' - $ref: '#/components/parameters/cat.aliases___query.expand_wildcards' - $ref: '#/components/parameters/cat.aliases___query.format' - $ref: '#/components/parameters/cat.aliases___query.h' - $ref: '#/components/parameters/cat.aliases___query.help' - $ref: '#/components/parameters/cat.aliases___query.local' - $ref: '#/components/parameters/cat.aliases___query.s' - $ref: '#/components/parameters/cat.aliases___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.aliases___200' /_cat/allocation: get: operationId: cat.allocation.0 x-operation-group: cat.allocation x-version-added: '1.0' description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: - $ref: '#/components/parameters/cat.allocation___query.bytes' - $ref: '#/components/parameters/cat.allocation___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.allocation___query.format' - $ref: '#/components/parameters/cat.allocation___query.h' - $ref: '#/components/parameters/cat.allocation___query.help' - $ref: '#/components/parameters/cat.allocation___query.local' - $ref: '#/components/parameters/cat.allocation___query.master_timeout' - $ref: '#/components/parameters/cat.allocation___query.s' - $ref: '#/components/parameters/cat.allocation___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.allocation___200' /_cat/allocation/{node_id}: get: operationId: cat.allocation.1 x-operation-group: cat.allocation x-version-added: '1.0' description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: - $ref: '#/components/parameters/cat.allocation___path.node_id' - $ref: '#/components/parameters/cat.allocation___query.bytes' - $ref: '#/components/parameters/cat.allocation___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.allocation___query.format' - $ref: '#/components/parameters/cat.allocation___query.h' - $ref: '#/components/parameters/cat.allocation___query.help' - $ref: '#/components/parameters/cat.allocation___query.local' - $ref: '#/components/parameters/cat.allocation___query.master_timeout' - $ref: '#/components/parameters/cat.allocation___query.s' - $ref: '#/components/parameters/cat.allocation___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.allocation___200' /_cat/cluster_manager: get: operationId: cat.cluster_manager.0 x-operation-group: cat.cluster_manager x-version-added: '2.0' description: Returns information about the cluster-manager node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - $ref: '#/components/parameters/cat.cluster_manager___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.cluster_manager___query.format' - $ref: '#/components/parameters/cat.cluster_manager___query.h' - $ref: '#/components/parameters/cat.cluster_manager___query.help' - $ref: '#/components/parameters/cat.cluster_manager___query.local' - $ref: '#/components/parameters/cat.cluster_manager___query.master_timeout' - $ref: '#/components/parameters/cat.cluster_manager___query.s' - $ref: '#/components/parameters/cat.cluster_manager___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.cluster_manager___200' /_cat/count: get: operationId: cat.count.0 x-operation-group: cat.count x-version-added: '1.0' description: Provides quick access to the document count of the entire cluster or of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: - $ref: '#/components/parameters/cat.count___query.format' - $ref: '#/components/parameters/cat.count___query.h' - $ref: '#/components/parameters/cat.count___query.help' - $ref: '#/components/parameters/cat.count___query.s' - $ref: '#/components/parameters/cat.count___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.count___200' /_cat/count/{index}: get: operationId: cat.count.1 x-operation-group: cat.count x-version-added: '1.0' description: Provides quick access to the document count of the entire cluster or of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: - $ref: '#/components/parameters/cat.count___path.index' - $ref: '#/components/parameters/cat.count___query.format' - $ref: '#/components/parameters/cat.count___query.h' - $ref: '#/components/parameters/cat.count___query.help' - $ref: '#/components/parameters/cat.count___query.s' - $ref: '#/components/parameters/cat.count___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.count___200' /_cat/fielddata: get: operationId: cat.fielddata.0 x-operation-group: cat.fielddata x-version-added: '1.0' description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: - $ref: '#/components/parameters/cat.fielddata___query.bytes' - $ref: '#/components/parameters/cat.fielddata___query.fields' - $ref: '#/components/parameters/cat.fielddata___query.format' - $ref: '#/components/parameters/cat.fielddata___query.h' - $ref: '#/components/parameters/cat.fielddata___query.help' - $ref: '#/components/parameters/cat.fielddata___query.s' - $ref: '#/components/parameters/cat.fielddata___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.fielddata___200' /_cat/fielddata/{fields}: get: operationId: cat.fielddata.1 x-operation-group: cat.fielddata x-version-added: '1.0' description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: - $ref: '#/components/parameters/cat.fielddata___path.fields' - $ref: '#/components/parameters/cat.fielddata___query.bytes' - $ref: '#/components/parameters/cat.fielddata___query.fields' - $ref: '#/components/parameters/cat.fielddata___query.format' - $ref: '#/components/parameters/cat.fielddata___query.h' - $ref: '#/components/parameters/cat.fielddata___query.help' - $ref: '#/components/parameters/cat.fielddata___query.s' - $ref: '#/components/parameters/cat.fielddata___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.fielddata___200' /_cat/health: get: operationId: cat.health.0 x-operation-group: cat.health x-version-added: '1.0' description: Returns a concise representation of the cluster health. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-health/ parameters: - $ref: '#/components/parameters/cat.health___query.format' - $ref: '#/components/parameters/cat.health___query.h' - $ref: '#/components/parameters/cat.health___query.help' - $ref: '#/components/parameters/cat.health___query.s' - $ref: '#/components/parameters/cat.health___query.time' - $ref: '#/components/parameters/cat.health___query.ts' - $ref: '#/components/parameters/cat.health___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.health___200' /_cat/indices: get: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' description: Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: - $ref: '#/components/parameters/cat.indices___query.bytes' - $ref: '#/components/parameters/cat.indices___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.indices___query.expand_wildcards' - $ref: '#/components/parameters/cat.indices___query.format' - $ref: '#/components/parameters/cat.indices___query.h' - $ref: '#/components/parameters/cat.indices___query.health' - $ref: '#/components/parameters/cat.indices___query.help' - $ref: '#/components/parameters/cat.indices___query.include_unloaded_segments' - $ref: '#/components/parameters/cat.indices___query.local' - $ref: '#/components/parameters/cat.indices___query.master_timeout' - $ref: '#/components/parameters/cat.indices___query.pri' - $ref: '#/components/parameters/cat.indices___query.s' - $ref: '#/components/parameters/cat.indices___query.time' - $ref: '#/components/parameters/cat.indices___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.indices___200' /_cat/indices/{index}: get: operationId: cat.indices.1 x-operation-group: cat.indices x-version-added: '1.0' description: Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: - $ref: '#/components/parameters/cat.indices___path.index' - $ref: '#/components/parameters/cat.indices___query.bytes' - $ref: '#/components/parameters/cat.indices___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.indices___query.expand_wildcards' - $ref: '#/components/parameters/cat.indices___query.format' - $ref: '#/components/parameters/cat.indices___query.h' - $ref: '#/components/parameters/cat.indices___query.health' - $ref: '#/components/parameters/cat.indices___query.help' - $ref: '#/components/parameters/cat.indices___query.include_unloaded_segments' - $ref: '#/components/parameters/cat.indices___query.local' - $ref: '#/components/parameters/cat.indices___query.master_timeout' - $ref: '#/components/parameters/cat.indices___query.pri' - $ref: '#/components/parameters/cat.indices___query.s' - $ref: '#/components/parameters/cat.indices___query.time' - $ref: '#/components/parameters/cat.indices___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.indices___200' /_cat/master: get: operationId: cat.master.0 x-operation-group: cat.master deprecated: true x-deprecation-message: To promote inclusive language, use '/_cat/cluster_manager' instead. x-version-added: '1.0' x-version-deprecated: '2.0' description: Returns information about the cluster-manager node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - $ref: '#/components/parameters/cat.master___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.master___query.format' - $ref: '#/components/parameters/cat.master___query.h' - $ref: '#/components/parameters/cat.master___query.help' - $ref: '#/components/parameters/cat.master___query.local' - $ref: '#/components/parameters/cat.master___query.master_timeout' - $ref: '#/components/parameters/cat.master___query.s' - $ref: '#/components/parameters/cat.master___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.master___200' /_cat/nodeattrs: get: operationId: cat.nodeattrs.0 x-operation-group: cat.nodeattrs x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns information about custom node attributes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ parameters: - $ref: '#/components/parameters/cat.nodeattrs___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.nodeattrs___query.format' - $ref: '#/components/parameters/cat.nodeattrs___query.h' - $ref: '#/components/parameters/cat.nodeattrs___query.help' - $ref: '#/components/parameters/cat.nodeattrs___query.local' - $ref: '#/components/parameters/cat.nodeattrs___query.master_timeout' - $ref: '#/components/parameters/cat.nodeattrs___query.s' - $ref: '#/components/parameters/cat.nodeattrs___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.nodeattrs___200' /_cat/nodes: get: operationId: cat.nodes.0 x-operation-group: cat.nodes x-version-added: '1.0' description: Returns basic statistics about the performance of cluster nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ parameters: - $ref: '#/components/parameters/cat.nodes___query.bytes' - $ref: '#/components/parameters/cat.nodes___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.nodes___query.format' - $ref: '#/components/parameters/cat.nodes___query.full_id' - $ref: '#/components/parameters/cat.nodes___query.h' - $ref: '#/components/parameters/cat.nodes___query.help' - $ref: '#/components/parameters/cat.nodes___query.local' - $ref: '#/components/parameters/cat.nodes___query.master_timeout' - $ref: '#/components/parameters/cat.nodes___query.s' - $ref: '#/components/parameters/cat.nodes___query.time' - $ref: '#/components/parameters/cat.nodes___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.nodes___200' /_cat/pending_tasks: get: operationId: cat.pending_tasks.0 x-operation-group: cat.pending_tasks x-version-added: '1.0' description: Returns a concise representation of the cluster's pending tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: - $ref: '#/components/parameters/cat.pending_tasks___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.pending_tasks___query.format' - $ref: '#/components/parameters/cat.pending_tasks___query.h' - $ref: '#/components/parameters/cat.pending_tasks___query.help' - $ref: '#/components/parameters/cat.pending_tasks___query.local' - $ref: '#/components/parameters/cat.pending_tasks___query.master_timeout' - $ref: '#/components/parameters/cat.pending_tasks___query.s' - $ref: '#/components/parameters/cat.pending_tasks___query.time' - $ref: '#/components/parameters/cat.pending_tasks___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.pending_tasks___200' /_cat/pit_segments: get: operationId: cat.pit_segments.0 x-operation-group: cat.pit_segments x-version-added: '2.4' description: Lists one or several CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: - $ref: '#/components/parameters/cat.pit_segments___query.bytes' - $ref: '#/components/parameters/cat.pit_segments___query.format' - $ref: '#/components/parameters/cat.pit_segments___query.h' - $ref: '#/components/parameters/cat.pit_segments___query.help' - $ref: '#/components/parameters/cat.pit_segments___query.s' - $ref: '#/components/parameters/cat.pit_segments___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cat.pit_segments' responses: '200': $ref: '#/components/responses/cat.pit_segments___200' /_cat/pit_segments/_all: get: operationId: cat.all_pit_segments.0 x-operation-group: cat.all_pit_segments x-version-added: '2.4' description: Lists all active CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: - $ref: '#/components/parameters/cat.all_pit_segments___query.bytes' - $ref: '#/components/parameters/cat.all_pit_segments___query.format' - $ref: '#/components/parameters/cat.all_pit_segments___query.h' - $ref: '#/components/parameters/cat.all_pit_segments___query.help' - $ref: '#/components/parameters/cat.all_pit_segments___query.s' - $ref: '#/components/parameters/cat.all_pit_segments___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.all_pit_segments___200' /_cat/plugins: get: operationId: cat.plugins.0 x-operation-group: cat.plugins x-version-added: '1.0' description: Returns information about the names, components, and versions of the installed plugins. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - $ref: '#/components/parameters/cat.plugins___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.plugins___query.format' - $ref: '#/components/parameters/cat.plugins___query.h' - $ref: '#/components/parameters/cat.plugins___query.help' - $ref: '#/components/parameters/cat.plugins___query.local' - $ref: '#/components/parameters/cat.plugins___query.master_timeout' - $ref: '#/components/parameters/cat.plugins___query.s' - $ref: '#/components/parameters/cat.plugins___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.plugins___200' /_cat/recovery: get: operationId: cat.recovery.0 x-operation-group: cat.recovery x-version-added: '1.0' description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - $ref: '#/components/parameters/cat.recovery___query.active_only' - $ref: '#/components/parameters/cat.recovery___query.bytes' - $ref: '#/components/parameters/cat.recovery___query.detailed' - $ref: '#/components/parameters/cat.recovery___query.format' - $ref: '#/components/parameters/cat.recovery___query.h' - $ref: '#/components/parameters/cat.recovery___query.help' - $ref: '#/components/parameters/cat.recovery___query.index' - $ref: '#/components/parameters/cat.recovery___query.s' - $ref: '#/components/parameters/cat.recovery___query.time' - $ref: '#/components/parameters/cat.recovery___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.recovery___200' /_cat/recovery/{index}: get: operationId: cat.recovery.1 x-operation-group: cat.recovery x-version-added: '1.0' description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - $ref: '#/components/parameters/cat.recovery___path.index' - $ref: '#/components/parameters/cat.recovery___query.active_only' - $ref: '#/components/parameters/cat.recovery___query.bytes' - $ref: '#/components/parameters/cat.recovery___query.detailed' - $ref: '#/components/parameters/cat.recovery___query.format' - $ref: '#/components/parameters/cat.recovery___query.h' - $ref: '#/components/parameters/cat.recovery___query.help' - $ref: '#/components/parameters/cat.recovery___query.index' - $ref: '#/components/parameters/cat.recovery___query.s' - $ref: '#/components/parameters/cat.recovery___query.time' - $ref: '#/components/parameters/cat.recovery___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.recovery___200' /_cat/repositories: get: operationId: cat.repositories.0 x-operation-group: cat.repositories x-version-added: '1.0' description: Returns information about all snapshot repositories for a cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: - $ref: '#/components/parameters/cat.repositories___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.repositories___query.format' - $ref: '#/components/parameters/cat.repositories___query.h' - $ref: '#/components/parameters/cat.repositories___query.help' - $ref: '#/components/parameters/cat.repositories___query.local' - $ref: '#/components/parameters/cat.repositories___query.master_timeout' - $ref: '#/components/parameters/cat.repositories___query.s' - $ref: '#/components/parameters/cat.repositories___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.repositories___200' /_cat/segment_replication: get: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication x-version-added: '2.6' description: |- Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: - $ref: '#/components/parameters/cat.segment_replication___query.active_only' - $ref: '#/components/parameters/cat.segment_replication___query.allow_no_indices' - $ref: '#/components/parameters/cat.segment_replication___query.bytes' - $ref: '#/components/parameters/cat.segment_replication___query.completed_only' - $ref: '#/components/parameters/cat.segment_replication___query.detailed' - $ref: '#/components/parameters/cat.segment_replication___query.expand_wildcards' - $ref: '#/components/parameters/cat.segment_replication___query.format' - $ref: '#/components/parameters/cat.segment_replication___query.h' - $ref: '#/components/parameters/cat.segment_replication___query.help' - $ref: '#/components/parameters/cat.segment_replication___query.ignore_throttled' - $ref: '#/components/parameters/cat.segment_replication___query.ignore_unavailable' - $ref: '#/components/parameters/cat.segment_replication___query.index' - $ref: '#/components/parameters/cat.segment_replication___query.s' - $ref: '#/components/parameters/cat.segment_replication___query.shards' - $ref: '#/components/parameters/cat.segment_replication___query.time' - $ref: '#/components/parameters/cat.segment_replication___query.timeout' - $ref: '#/components/parameters/cat.segment_replication___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.segment_replication___200' /_cat/segment_replication/{index}: get: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication x-version-added: '2.6' description: |- Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: - $ref: '#/components/parameters/cat.segment_replication___path.index' - $ref: '#/components/parameters/cat.segment_replication___query.active_only' - $ref: '#/components/parameters/cat.segment_replication___query.allow_no_indices' - $ref: '#/components/parameters/cat.segment_replication___query.bytes' - $ref: '#/components/parameters/cat.segment_replication___query.completed_only' - $ref: '#/components/parameters/cat.segment_replication___query.detailed' - $ref: '#/components/parameters/cat.segment_replication___query.expand_wildcards' - $ref: '#/components/parameters/cat.segment_replication___query.format' - $ref: '#/components/parameters/cat.segment_replication___query.h' - $ref: '#/components/parameters/cat.segment_replication___query.help' - $ref: '#/components/parameters/cat.segment_replication___query.ignore_throttled' - $ref: '#/components/parameters/cat.segment_replication___query.ignore_unavailable' - $ref: '#/components/parameters/cat.segment_replication___query.index' - $ref: '#/components/parameters/cat.segment_replication___query.s' - $ref: '#/components/parameters/cat.segment_replication___query.shards' - $ref: '#/components/parameters/cat.segment_replication___query.time' - $ref: '#/components/parameters/cat.segment_replication___query.timeout' - $ref: '#/components/parameters/cat.segment_replication___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.segment_replication___200' /_cat/segments: get: operationId: cat.segments.0 x-operation-group: cat.segments x-version-added: '1.0' description: Provides low-level information about the segments in the shards of an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: - $ref: '#/components/parameters/cat.segments___query.bytes' - $ref: '#/components/parameters/cat.segments___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.segments___query.format' - $ref: '#/components/parameters/cat.segments___query.h' - $ref: '#/components/parameters/cat.segments___query.help' - $ref: '#/components/parameters/cat.segments___query.master_timeout' - $ref: '#/components/parameters/cat.segments___query.s' - $ref: '#/components/parameters/cat.segments___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.segments___200' /_cat/segments/{index}: get: operationId: cat.segments.1 x-operation-group: cat.segments x-version-added: '1.0' description: Provides low-level information about the segments in the shards of an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: - $ref: '#/components/parameters/cat.segments___path.index' - $ref: '#/components/parameters/cat.segments___query.bytes' - $ref: '#/components/parameters/cat.segments___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.segments___query.format' - $ref: '#/components/parameters/cat.segments___query.h' - $ref: '#/components/parameters/cat.segments___query.help' - $ref: '#/components/parameters/cat.segments___query.master_timeout' - $ref: '#/components/parameters/cat.segments___query.s' - $ref: '#/components/parameters/cat.segments___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.segments___200' /_cat/shards: get: operationId: cat.shards.0 x-operation-group: cat.shards x-version-added: '1.0' description: Lists the states of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: - $ref: '#/components/parameters/cat.shards___query.bytes' - $ref: '#/components/parameters/cat.shards___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.shards___query.format' - $ref: '#/components/parameters/cat.shards___query.h' - $ref: '#/components/parameters/cat.shards___query.help' - $ref: '#/components/parameters/cat.shards___query.local' - $ref: '#/components/parameters/cat.shards___query.master_timeout' - $ref: '#/components/parameters/cat.shards___query.s' - $ref: '#/components/parameters/cat.shards___query.time' - $ref: '#/components/parameters/cat.shards___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.shards___200' /_cat/shards/{index}: get: operationId: cat.shards.1 x-operation-group: cat.shards x-version-added: '1.0' description: Lists the states of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: - $ref: '#/components/parameters/cat.shards___path.index' - $ref: '#/components/parameters/cat.shards___query.bytes' - $ref: '#/components/parameters/cat.shards___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.shards___query.format' - $ref: '#/components/parameters/cat.shards___query.h' - $ref: '#/components/parameters/cat.shards___query.help' - $ref: '#/components/parameters/cat.shards___query.local' - $ref: '#/components/parameters/cat.shards___query.master_timeout' - $ref: '#/components/parameters/cat.shards___query.s' - $ref: '#/components/parameters/cat.shards___query.time' - $ref: '#/components/parameters/cat.shards___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.shards___200' /_cat/snapshots: get: operationId: cat.snapshots.0 x-operation-group: cat.snapshots x-version-added: '1.0' description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: - $ref: '#/components/parameters/cat.snapshots___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.snapshots___query.format' - $ref: '#/components/parameters/cat.snapshots___query.h' - $ref: '#/components/parameters/cat.snapshots___query.help' - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' - $ref: '#/components/parameters/cat.snapshots___query.repository' - $ref: '#/components/parameters/cat.snapshots___query.s' - $ref: '#/components/parameters/cat.snapshots___query.time' - $ref: '#/components/parameters/cat.snapshots___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.snapshots___200' /_cat/snapshots/{repository}: get: operationId: cat.snapshots.1 x-operation-group: cat.snapshots x-version-added: '1.0' description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: - $ref: '#/components/parameters/cat.snapshots___path.repository' - $ref: '#/components/parameters/cat.snapshots___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.snapshots___query.format' - $ref: '#/components/parameters/cat.snapshots___query.h' - $ref: '#/components/parameters/cat.snapshots___query.help' - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' - $ref: '#/components/parameters/cat.snapshots___query.repository' - $ref: '#/components/parameters/cat.snapshots___query.s' - $ref: '#/components/parameters/cat.snapshots___query.time' - $ref: '#/components/parameters/cat.snapshots___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.snapshots___200' /_cat/tasks: get: operationId: cat.tasks.0 x-operation-group: cat.tasks x-version-added: '1.0' description: Lists the progress of all tasks currently running on the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: - $ref: '#/components/parameters/cat.tasks___query.actions' - $ref: '#/components/parameters/cat.tasks___query.detailed' - $ref: '#/components/parameters/cat.tasks___query.format' - $ref: '#/components/parameters/cat.tasks___query.h' - $ref: '#/components/parameters/cat.tasks___query.help' - $ref: '#/components/parameters/cat.tasks___query.nodes' - $ref: '#/components/parameters/cat.tasks___query.parent_task_id' - $ref: '#/components/parameters/cat.tasks___query.s' - $ref: '#/components/parameters/cat.tasks___query.time' - $ref: '#/components/parameters/cat.tasks___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.tasks___200' /_cat/templates: get: operationId: cat.templates.0 x-operation-group: cat.templates x-version-added: '1.0' description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: - $ref: '#/components/parameters/cat.templates___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.templates___query.format' - $ref: '#/components/parameters/cat.templates___query.h' - $ref: '#/components/parameters/cat.templates___query.help' - $ref: '#/components/parameters/cat.templates___query.local' - $ref: '#/components/parameters/cat.templates___query.master_timeout' - $ref: '#/components/parameters/cat.templates___query.s' - $ref: '#/components/parameters/cat.templates___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.templates___200' /_cat/templates/{name}: get: operationId: cat.templates.1 x-operation-group: cat.templates x-version-added: '1.0' description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: - $ref: '#/components/parameters/cat.templates___path.name' - $ref: '#/components/parameters/cat.templates___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.templates___query.format' - $ref: '#/components/parameters/cat.templates___query.h' - $ref: '#/components/parameters/cat.templates___query.help' - $ref: '#/components/parameters/cat.templates___query.local' - $ref: '#/components/parameters/cat.templates___query.master_timeout' - $ref: '#/components/parameters/cat.templates___query.s' - $ref: '#/components/parameters/cat.templates___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.templates___200' /_cat/thread_pool: get: operationId: cat.thread_pool.0 x-operation-group: cat.thread_pool x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: - $ref: '#/components/parameters/cat.thread_pool___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.thread_pool___query.format' - $ref: '#/components/parameters/cat.thread_pool___query.h' - $ref: '#/components/parameters/cat.thread_pool___query.help' - $ref: '#/components/parameters/cat.thread_pool___query.local' - $ref: '#/components/parameters/cat.thread_pool___query.master_timeout' - $ref: '#/components/parameters/cat.thread_pool___query.s' - $ref: '#/components/parameters/cat.thread_pool___query.size' - $ref: '#/components/parameters/cat.thread_pool___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.thread_pool___200' /_cat/thread_pool/{thread_pool_patterns}: get: operationId: cat.thread_pool.1 x-operation-group: cat.thread_pool x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: - $ref: '#/components/parameters/cat.thread_pool___path.thread_pool_patterns' - $ref: '#/components/parameters/cat.thread_pool___query.cluster_manager_timeout' - $ref: '#/components/parameters/cat.thread_pool___query.format' - $ref: '#/components/parameters/cat.thread_pool___query.h' - $ref: '#/components/parameters/cat.thread_pool___query.help' - $ref: '#/components/parameters/cat.thread_pool___query.local' - $ref: '#/components/parameters/cat.thread_pool___query.master_timeout' - $ref: '#/components/parameters/cat.thread_pool___query.s' - $ref: '#/components/parameters/cat.thread_pool___query.size' - $ref: '#/components/parameters/cat.thread_pool___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cat.thread_pool___200' /_cluster/allocation/explain: get: operationId: cluster.allocation_explain.0 x-operation-group: cluster.allocation_explain x-version-added: '1.0' description: Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - $ref: '#/components/parameters/cluster.allocation_explain___query.include_disk_info' - $ref: '#/components/parameters/cluster.allocation_explain___query.include_yes_decisions' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.allocation_explain' responses: '200': $ref: '#/components/responses/cluster.allocation_explain___200' post: operationId: cluster.allocation_explain.1 x-operation-group: cluster.allocation_explain x-version-added: '1.0' description: Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - $ref: '#/components/parameters/cluster.allocation_explain___query.include_disk_info' - $ref: '#/components/parameters/cluster.allocation_explain___query.include_yes_decisions' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.allocation_explain' responses: '200': $ref: '#/components/responses/cluster.allocation_explain___200' /_cluster/decommission/awareness: delete: operationId: cluster.delete_decommission_awareness.0 x-operation-group: cluster.delete_decommission_awareness x-version-added: '1.0' description: Recommissions a decommissioned zone. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone responses: '200': $ref: '#/components/responses/cluster.delete_decommission_awareness___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_cluster/decommission/awareness/{awareness_attribute_name}/_status: get: operationId: cluster.get_decommission_awareness.0 x-operation-group: cluster.get_decommission_awareness x-version-added: '1.0' description: Retrieves the decommission status for all zones. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status parameters: - $ref: '#/components/parameters/cluster.get_decommission_awareness___path.awareness_attribute_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.get_decommission_awareness___200' /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}: put: operationId: cluster.put_decommission_awareness.0 x-operation-group: cluster.put_decommission_awareness x-version-added: '1.0' description: Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone parameters: - $ref: '#/components/parameters/cluster.put_decommission_awareness___path.awareness_attribute_name' - $ref: '#/components/parameters/cluster.put_decommission_awareness___path.awareness_attribute_value' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.put_decommission_awareness___200' /_cluster/health: get: operationId: cluster.health.0 x-operation-group: cluster.health x-version-added: '1.0' description: Returns basic information about the health of the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: - $ref: '#/components/parameters/cluster.health___query.awareness_attribute' - $ref: '#/components/parameters/cluster.health___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.health___query.expand_wildcards' - $ref: '#/components/parameters/cluster.health___query.level' - $ref: '#/components/parameters/cluster.health___query.local' - $ref: '#/components/parameters/cluster.health___query.master_timeout' - $ref: '#/components/parameters/cluster.health___query.timeout' - $ref: '#/components/parameters/cluster.health___query.wait_for_active_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_events' - $ref: '#/components/parameters/cluster.health___query.wait_for_no_initializing_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_no_relocating_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_nodes' - $ref: '#/components/parameters/cluster.health___query.wait_for_status' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.health___200' /_cluster/health/{index}: get: operationId: cluster.health.1 x-operation-group: cluster.health x-version-added: '1.0' description: Returns basic information about the health of the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: - $ref: '#/components/parameters/cluster.health___path.index' - $ref: '#/components/parameters/cluster.health___query.awareness_attribute' - $ref: '#/components/parameters/cluster.health___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.health___query.expand_wildcards' - $ref: '#/components/parameters/cluster.health___query.level' - $ref: '#/components/parameters/cluster.health___query.local' - $ref: '#/components/parameters/cluster.health___query.master_timeout' - $ref: '#/components/parameters/cluster.health___query.timeout' - $ref: '#/components/parameters/cluster.health___query.wait_for_active_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_events' - $ref: '#/components/parameters/cluster.health___query.wait_for_no_initializing_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_no_relocating_shards' - $ref: '#/components/parameters/cluster.health___query.wait_for_nodes' - $ref: '#/components/parameters/cluster.health___query.wait_for_status' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.health___200' /_cluster/nodes/{node_id}/hot_threads: get: operationId: nodes.hot_threads.2 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___path.node_id' - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_cluster/nodes/hot_threads: get: operationId: nodes.hot_threads.0 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_cluster/pending_tasks: get: operationId: cluster.pending_tasks.0 x-operation-group: cluster.pending_tasks x-version-added: '1.0' description: |- Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.pending_tasks___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.pending_tasks___query.local' - $ref: '#/components/parameters/cluster.pending_tasks___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.pending_tasks___200' /_cluster/reroute: post: operationId: cluster.reroute.0 x-operation-group: cluster.reroute x-version-added: '1.0' description: Allows to manually change the allocation of individual shards in the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.reroute___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.reroute___query.dry_run' - $ref: '#/components/parameters/cluster.reroute___query.explain' - $ref: '#/components/parameters/cluster.reroute___query.master_timeout' - $ref: '#/components/parameters/cluster.reroute___query.metric' - $ref: '#/components/parameters/cluster.reroute___query.retry_failed' - $ref: '#/components/parameters/cluster.reroute___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.reroute' responses: '200': $ref: '#/components/responses/cluster.reroute___200' /_cluster/routing/awareness/{attribute}/weights: get: operationId: cluster.get_weighted_routing.0 x-operation-group: cluster.get_weighted_routing x-version-added: '1.0' description: Fetches weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones parameters: - $ref: '#/components/parameters/cluster.get_weighted_routing___path.attribute' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.get_weighted_routing___200' put: operationId: cluster.put_weighted_routing.0 x-operation-group: cluster.put_weighted_routing x-version-added: '1.0' description: Updates weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search parameters: - $ref: '#/components/parameters/cluster.put_weighted_routing___path.attribute' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.put_weighted_routing' responses: '200': $ref: '#/components/responses/cluster.put_weighted_routing___200' /_cluster/routing/awareness/weights: delete: operationId: cluster.delete_weighted_routing.0 x-operation-group: cluster.delete_weighted_routing x-version-added: '1.0' description: Delete weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights requestBody: $ref: '#/components/requestBodies/cluster.delete_weighted_routing' responses: '200': $ref: '#/components/responses/cluster.delete_weighted_routing___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_cluster/settings: get: operationId: cluster.get_settings.0 x-operation-group: cluster.get_settings x-version-added: '1.0' description: Returns cluster settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/ parameters: - $ref: '#/components/parameters/cluster.get_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.get_settings___query.flat_settings' - $ref: '#/components/parameters/cluster.get_settings___query.include_defaults' - $ref: '#/components/parameters/cluster.get_settings___query.master_timeout' - $ref: '#/components/parameters/cluster.get_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.get_settings___200' put: operationId: cluster.put_settings.0 x-operation-group: cluster.put_settings x-version-added: '1.0' description: Updates the cluster settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-settings/ parameters: - $ref: '#/components/parameters/cluster.put_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.put_settings___query.flat_settings' - $ref: '#/components/parameters/cluster.put_settings___query.master_timeout' - $ref: '#/components/parameters/cluster.put_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.put_settings' responses: '200': $ref: '#/components/responses/cluster.put_settings___200' /_cluster/state: get: operationId: cluster.state.0 x-operation-group: cluster.state x-version-added: '1.0' description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' - $ref: '#/components/parameters/cluster.state___query.flat_settings' - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' - $ref: '#/components/parameters/cluster.state___query.local' - $ref: '#/components/parameters/cluster.state___query.master_timeout' - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' - $ref: '#/components/parameters/cluster.state___query.wait_for_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.state___200' /_cluster/state/{metric}: get: operationId: cluster.state.1 x-operation-group: cluster.state x-version-added: '1.0' description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.state___path.metric' - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' - $ref: '#/components/parameters/cluster.state___query.flat_settings' - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' - $ref: '#/components/parameters/cluster.state___query.local' - $ref: '#/components/parameters/cluster.state___query.master_timeout' - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' - $ref: '#/components/parameters/cluster.state___query.wait_for_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.state___200' /_cluster/state/{metric}/{index}: get: operationId: cluster.state.2 x-operation-group: cluster.state x-version-added: '1.0' description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.state___path.index' - $ref: '#/components/parameters/cluster.state___path.metric' - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' - $ref: '#/components/parameters/cluster.state___query.flat_settings' - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' - $ref: '#/components/parameters/cluster.state___query.local' - $ref: '#/components/parameters/cluster.state___query.master_timeout' - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' - $ref: '#/components/parameters/cluster.state___query.wait_for_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.state___200' /_cluster/stats: get: operationId: cluster.stats.0 x-operation-group: cluster.stats x-version-added: '1.0' description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - $ref: '#/components/parameters/cluster.stats___query.flat_settings' - $ref: '#/components/parameters/cluster.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.stats___200' /_cluster/stats/{metric}/{index_metric}/nodes/{node_id}: get: operationId: cluster.stats.3 x-operation-group: cluster.stats x-version-added: '2.18' description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - $ref: '#/components/parameters/cluster.stats___path.index_metric' - $ref: '#/components/parameters/cluster.stats___path.metric' - $ref: '#/components/parameters/cluster.stats___path.node_id' - $ref: '#/components/parameters/cluster.stats___query.flat_settings' - $ref: '#/components/parameters/cluster.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.stats___200' /_cluster/stats/{metric}/nodes/{node_id}: get: operationId: cluster.stats.2 x-operation-group: cluster.stats x-version-added: '2.18' description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - $ref: '#/components/parameters/cluster.stats___path.metric' - $ref: '#/components/parameters/cluster.stats___path.node_id' - $ref: '#/components/parameters/cluster.stats___query.flat_settings' - $ref: '#/components/parameters/cluster.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.stats___200' /_cluster/stats/nodes/{node_id}: get: operationId: cluster.stats.1 x-operation-group: cluster.stats x-version-added: '1.0' description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - $ref: '#/components/parameters/cluster.stats___path.node_id' - $ref: '#/components/parameters/cluster.stats___query.flat_settings' - $ref: '#/components/parameters/cluster.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.stats___200' /_cluster/voting_config_exclusions: delete: operationId: cluster.delete_voting_config_exclusions.0 x-operation-group: cluster.delete_voting_config_exclusions x-version-added: '1.0' description: Clears any cluster voting configuration exclusions. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.delete_voting_config_exclusions___query.wait_for_removal' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.delete_voting_config_exclusions___200' post: operationId: cluster.post_voting_config_exclusions.0 x-operation-group: cluster.post_voting_config_exclusions x-version-added: '1.0' description: Updates the cluster voting configuration by excluding certain node IDs or names. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___query.node_ids' - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___query.node_names' - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.post_voting_config_exclusions___200' /_component_template: get: operationId: cluster.get_component_template.0 x-operation-group: cluster.get_component_template x-version-added: '1.0' description: Returns one or more component templates. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.get_component_template___query.flat_settings' - $ref: '#/components/parameters/cluster.get_component_template___query.local' - $ref: '#/components/parameters/cluster.get_component_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.get_component_template___200' /_component_template/{name}: delete: operationId: cluster.delete_component_template.0 x-operation-group: cluster.delete_component_template x-version-added: '1.0' description: Deletes a component template. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.delete_component_template___path.name' - $ref: '#/components/parameters/cluster.delete_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.delete_component_template___query.master_timeout' - $ref: '#/components/parameters/cluster.delete_component_template___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.delete_component_template___200' get: operationId: cluster.get_component_template.1 x-operation-group: cluster.get_component_template x-version-added: '1.0' description: Returns one or more component templates. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.get_component_template___path.name' - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.get_component_template___query.flat_settings' - $ref: '#/components/parameters/cluster.get_component_template___query.local' - $ref: '#/components/parameters/cluster.get_component_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.get_component_template___200' head: operationId: cluster.exists_component_template.0 x-operation-group: cluster.exists_component_template x-version-added: '1.0' description: Returns information about whether a particular component template exist. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.exists_component_template___path.name' - $ref: '#/components/parameters/cluster.exists_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.exists_component_template___query.local' - $ref: '#/components/parameters/cluster.exists_component_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.exists_component_template___200' post: operationId: cluster.put_component_template.0 x-operation-group: cluster.put_component_template x-version-added: '1.0' description: Creates or updates a component template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: - $ref: '#/components/parameters/cluster.put_component_template___path.name' - $ref: '#/components/parameters/cluster.put_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.put_component_template___query.create' - $ref: '#/components/parameters/cluster.put_component_template___query.master_timeout' - $ref: '#/components/parameters/cluster.put_component_template___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': $ref: '#/components/responses/cluster.put_component_template___200' put: operationId: cluster.put_component_template.1 x-operation-group: cluster.put_component_template x-version-added: '1.0' description: Creates or updates a component template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: - $ref: '#/components/parameters/cluster.put_component_template___path.name' - $ref: '#/components/parameters/cluster.put_component_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.put_component_template___query.create' - $ref: '#/components/parameters/cluster.put_component_template___query.master_timeout' - $ref: '#/components/parameters/cluster.put_component_template___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': $ref: '#/components/responses/cluster.put_component_template___200' /_count: get: operationId: count.0 x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count___query.allow_no_indices' - $ref: '#/components/parameters/count___query.analyze_wildcard' - $ref: '#/components/parameters/count___query.analyzer' - $ref: '#/components/parameters/count___query.default_operator' - $ref: '#/components/parameters/count___query.df' - $ref: '#/components/parameters/count___query.expand_wildcards' - $ref: '#/components/parameters/count___query.ignore_throttled' - $ref: '#/components/parameters/count___query.ignore_unavailable' - $ref: '#/components/parameters/count___query.lenient' - $ref: '#/components/parameters/count___query.min_score' - $ref: '#/components/parameters/count___query.preference' - $ref: '#/components/parameters/count___query.q' - $ref: '#/components/parameters/count___query.routing' - $ref: '#/components/parameters/count___query.terminate_after' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/count' responses: '200': $ref: '#/components/responses/count___200' post: operationId: count.1 x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count___query.allow_no_indices' - $ref: '#/components/parameters/count___query.analyze_wildcard' - $ref: '#/components/parameters/count___query.analyzer' - $ref: '#/components/parameters/count___query.default_operator' - $ref: '#/components/parameters/count___query.df' - $ref: '#/components/parameters/count___query.expand_wildcards' - $ref: '#/components/parameters/count___query.ignore_throttled' - $ref: '#/components/parameters/count___query.ignore_unavailable' - $ref: '#/components/parameters/count___query.lenient' - $ref: '#/components/parameters/count___query.min_score' - $ref: '#/components/parameters/count___query.preference' - $ref: '#/components/parameters/count___query.q' - $ref: '#/components/parameters/count___query.routing' - $ref: '#/components/parameters/count___query.terminate_after' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/count' responses: '200': $ref: '#/components/responses/count___200' /_dangling: get: operationId: dangling_indices.list_dangling_indices.0 x-operation-group: dangling_indices.list_dangling_indices x-version-added: '1.0' description: Returns all dangling indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/dangling_indices.list_dangling_indices___200' /_dangling/{index_uuid}: delete: operationId: dangling_indices.delete_dangling_index.0 x-operation-group: dangling_indices.delete_dangling_index x-version-added: '1.0' description: Deletes the specified dangling index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___path.index_uuid' - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.accept_data_loss' - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.cluster_manager_timeout' - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.master_timeout' - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '202': $ref: '#/components/responses/dangling_indices.delete_dangling_index___202' post: operationId: dangling_indices.import_dangling_index.0 x-operation-group: dangling_indices.import_dangling_index x-version-added: '1.0' description: Imports the specified dangling index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: - $ref: '#/components/parameters/dangling_indices.import_dangling_index___path.index_uuid' - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.accept_data_loss' - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.cluster_manager_timeout' - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.master_timeout' - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '202': $ref: '#/components/responses/dangling_indices.import_dangling_index___202' /_data_stream: get: operationId: indices.get_data_stream.0 x-operation-group: indices.get_data_stream x-version-added: '1.0' description: Returns data streams. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_data_stream___200' /_data_stream/_stats: get: operationId: indices.data_streams_stats.0 x-operation-group: indices.data_streams_stats x-version-added: '1.0' description: Provides statistics on operations happening in a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.data_streams_stats___200' /_data_stream/{name}: delete: operationId: indices.delete_data_stream.0 x-operation-group: indices.delete_data_stream x-version-added: '1.0' description: Deletes a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/indices.delete_data_stream___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete_data_stream___200' get: operationId: indices.get_data_stream.1 x-operation-group: indices.get_data_stream x-version-added: '1.0' description: Returns data streams. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/indices.get_data_stream___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_data_stream___200' put: operationId: indices.create_data_stream.0 x-operation-group: indices.create_data_stream x-version-added: '1.0' description: Creates or updates a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/indices.create_data_stream___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.create_data_stream' responses: '200': $ref: '#/components/responses/indices.create_data_stream___200' /_data_stream/{name}/_stats: get: operationId: indices.data_streams_stats.1 x-operation-group: indices.data_streams_stats x-version-added: '1.0' description: Provides statistics on operations happening in a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - $ref: '#/components/parameters/indices.data_streams_stats___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.data_streams_stats___200' /_delete_by_query/{task_id}/_rethrottle: post: operationId: delete_by_query_rethrottle.0 x-operation-group: delete_by_query_rethrottle x-version-added: '1.0' description: Changes the number of requests per second for a particular Delete By Query operation. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/delete_by_query_rethrottle___path.task_id' - $ref: '#/components/parameters/delete_by_query_rethrottle___query.requests_per_second' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/delete_by_query_rethrottle___200' /_field_caps: get: operationId: field_caps.0 x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - $ref: '#/components/parameters/field_caps___query.allow_no_indices' - $ref: '#/components/parameters/field_caps___query.expand_wildcards' - $ref: '#/components/parameters/field_caps___query.fields' - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' - $ref: '#/components/parameters/field_caps___query.include_unmapped' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/field_caps' responses: '200': $ref: '#/components/responses/field_caps___200' post: operationId: field_caps.1 x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - $ref: '#/components/parameters/field_caps___query.allow_no_indices' - $ref: '#/components/parameters/field_caps___query.expand_wildcards' - $ref: '#/components/parameters/field_caps___query.fields' - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' - $ref: '#/components/parameters/field_caps___query.include_unmapped' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/field_caps' responses: '200': $ref: '#/components/responses/field_caps___200' /_flush: get: operationId: indices.flush.0 x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' - $ref: '#/components/parameters/indices.flush___query.force' - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.flush___200' post: operationId: indices.flush.1 x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' - $ref: '#/components/parameters/indices.flush___query.force' - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.flush___200' /_forcemerge: post: operationId: indices.forcemerge.0 x-operation-group: indices.forcemerge x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.forcemerge___query.allow_no_indices' - $ref: '#/components/parameters/indices.forcemerge___query.expand_wildcards' - $ref: '#/components/parameters/indices.forcemerge___query.flush' - $ref: '#/components/parameters/indices.forcemerge___query.ignore_unavailable' - $ref: '#/components/parameters/indices.forcemerge___query.max_num_segments' - $ref: '#/components/parameters/indices.forcemerge___query.only_expunge_deletes' - $ref: '#/components/parameters/indices.forcemerge___query.primary_only' - $ref: '#/components/parameters/indices.forcemerge___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.forcemerge___200' /_index_template: get: operationId: indices.get_index_template.0 x-operation-group: indices.get_index_template x-version-added: '1.0' description: Returns an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.get_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_index_template___query.flat_settings' - $ref: '#/components/parameters/indices.get_index_template___query.local' - $ref: '#/components/parameters/indices.get_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_index_template___200' /_index_template/_simulate: post: operationId: indices.simulate_template.0 x-operation-group: indices.simulate_template x-version-added: '1.0' description: Simulate resolving the given template name or body. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.simulate_template___query.cause' - $ref: '#/components/parameters/indices.simulate_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.simulate_template___query.create' - $ref: '#/components/parameters/indices.simulate_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.simulate_template' responses: '200': $ref: '#/components/responses/indices.simulate_template___200' /_index_template/_simulate_index/{name}: post: operationId: indices.simulate_index_template.0 x-operation-group: indices.simulate_index_template x-version-added: '1.0' description: Simulate matching the given index name against the index templates in the system. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.simulate_index_template___path.name' - $ref: '#/components/parameters/indices.simulate_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.simulate_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.simulate_index_template' responses: '200': $ref: '#/components/responses/indices.simulate_index_template___200' /_index_template/_simulate/{name}: post: operationId: indices.simulate_template.1 x-operation-group: indices.simulate_template x-version-added: '1.0' description: Simulate resolving the given template name or body. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.simulate_template___path.name' - $ref: '#/components/parameters/indices.simulate_template___query.cause' - $ref: '#/components/parameters/indices.simulate_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.simulate_template___query.create' - $ref: '#/components/parameters/indices.simulate_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.simulate_template' responses: '200': $ref: '#/components/responses/indices.simulate_template___200' /_index_template/{name}: delete: operationId: indices.delete_index_template.0 x-operation-group: indices.delete_index_template x-version-added: '1.0' description: Deletes an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template parameters: - $ref: '#/components/parameters/indices.delete_index_template___path.name' - $ref: '#/components/parameters/indices.delete_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.delete_index_template___query.master_timeout' - $ref: '#/components/parameters/indices.delete_index_template___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete_index_template___200' get: operationId: indices.get_index_template.1 x-operation-group: indices.get_index_template x-version-added: '1.0' description: Returns an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.get_index_template___path.name' - $ref: '#/components/parameters/indices.get_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_index_template___query.flat_settings' - $ref: '#/components/parameters/indices.get_index_template___query.local' - $ref: '#/components/parameters/indices.get_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_index_template___200' head: operationId: indices.exists_index_template.0 x-operation-group: indices.exists_index_template x-version-added: '1.0' description: Returns information about whether a particular index template exists. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.exists_index_template___path.name' - $ref: '#/components/parameters/indices.exists_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.exists_index_template___query.flat_settings' - $ref: '#/components/parameters/indices.exists_index_template___query.local' - $ref: '#/components/parameters/indices.exists_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.exists_index_template___200' post: operationId: indices.put_index_template.0 x-operation-group: indices.put_index_template x-version-added: '1.0' description: Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.put_index_template___path.name' - $ref: '#/components/parameters/indices.put_index_template___query.cause' - $ref: '#/components/parameters/indices.put_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_index_template___query.create' - $ref: '#/components/parameters/indices.put_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_index_template' responses: '200': $ref: '#/components/responses/indices.put_index_template___200' put: operationId: indices.put_index_template.1 x-operation-group: indices.put_index_template x-version-added: '1.0' description: Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.put_index_template___path.name' - $ref: '#/components/parameters/indices.put_index_template___query.cause' - $ref: '#/components/parameters/indices.put_index_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_index_template___query.create' - $ref: '#/components/parameters/indices.put_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_index_template' responses: '200': $ref: '#/components/responses/indices.put_index_template___200' /_ingest/pipeline: get: operationId: ingest.get_pipeline.0 x-operation-group: ingest.get_pipeline x-version-added: '1.0' description: Returns an ingest pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: - $ref: '#/components/parameters/ingest.get_pipeline___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingest.get_pipeline___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingest.get_pipeline___200' /_ingest/pipeline/_simulate: get: operationId: ingest.simulate.0 x-operation-group: ingest.simulate x-version-added: '1.0' description: Simulates an ingest pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - $ref: '#/components/parameters/ingest.simulate___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: '200': $ref: '#/components/responses/ingest.simulate___200' post: operationId: ingest.simulate.1 x-operation-group: ingest.simulate x-version-added: '1.0' description: Simulates an ingest pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - $ref: '#/components/parameters/ingest.simulate___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: '200': $ref: '#/components/responses/ingest.simulate___200' /_ingest/pipeline/{id}: delete: operationId: ingest.delete_pipeline.0 x-operation-group: ingest.delete_pipeline x-version-added: '1.0' description: Deletes an ingest pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ parameters: - $ref: '#/components/parameters/ingest.delete_pipeline___path.id' - $ref: '#/components/parameters/ingest.delete_pipeline___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingest.delete_pipeline___query.master_timeout' - $ref: '#/components/parameters/ingest.delete_pipeline___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingest.delete_pipeline___200' get: operationId: ingest.get_pipeline.1 x-operation-group: ingest.get_pipeline x-version-added: '1.0' description: Returns an ingest pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: - $ref: '#/components/parameters/ingest.get_pipeline___path.id' - $ref: '#/components/parameters/ingest.get_pipeline___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingest.get_pipeline___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingest.get_pipeline___200' put: operationId: ingest.put_pipeline.0 x-operation-group: ingest.put_pipeline x-version-added: '1.0' description: Creates or updates an ingest pipeline. externalDocs: url: https://docs.opensearch.org/latest/ingest-pipelines/create-ingest/ parameters: - $ref: '#/components/parameters/ingest.put_pipeline___path.id' - $ref: '#/components/parameters/ingest.put_pipeline___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingest.put_pipeline___query.master_timeout' - $ref: '#/components/parameters/ingest.put_pipeline___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingest.put_pipeline' responses: '200': $ref: '#/components/responses/ingest.put_pipeline___200' /_ingest/pipeline/{id}/_simulate: get: operationId: ingest.simulate.2 x-operation-group: ingest.simulate x-version-added: '1.0' description: Simulates an ingest pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - $ref: '#/components/parameters/ingest.simulate___path.id' - $ref: '#/components/parameters/ingest.simulate___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: '200': $ref: '#/components/responses/ingest.simulate___200' post: operationId: ingest.simulate.3 x-operation-group: ingest.simulate x-version-added: '1.0' description: Simulates an ingest pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - $ref: '#/components/parameters/ingest.simulate___path.id' - $ref: '#/components/parameters/ingest.simulate___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: '200': $ref: '#/components/responses/ingest.simulate___200' /_ingest/processor/grok: get: operationId: ingest.processor_grok.0 x-operation-group: ingest.processor_grok x-version-added: '1.0' description: Returns a list of built-in grok patterns. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/ingest.processor_grok___query.s' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingest.processor_grok___200' /_insights/top_queries: get: operationId: insights.top_queries.0 x-operation-group: insights.top_queries x-version-added: '1.0' description: Retrieves the top queries based on the given metric type (latency, CPU, or memory). parameters: - $ref: '#/components/parameters/insights.top_queries___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/insights.top_queries___200' /_list: get: operationId: list.help.0 x-operation-group: list.help x-version-added: '2.18' description: Returns help for the List APIs. externalDocs: url: https://opensearch.org/docs/latest/api-reference/list/index/ responses: '200': $ref: '#/components/responses/list.help___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_list/indices: get: operationId: list.indices.0 x-operation-group: list.indices x-version-added: '2.18' description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. externalDocs: url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ parameters: - $ref: '#/components/parameters/list.indices___query.bytes' - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' - $ref: '#/components/parameters/list.indices___query.expand_wildcards' - $ref: '#/components/parameters/list.indices___query.format' - $ref: '#/components/parameters/list.indices___query.h' - $ref: '#/components/parameters/list.indices___query.health' - $ref: '#/components/parameters/list.indices___query.help' - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' - $ref: '#/components/parameters/list.indices___query.local' - $ref: '#/components/parameters/list.indices___query.master_timeout' - $ref: '#/components/parameters/list.indices___query.next_token' - $ref: '#/components/parameters/list.indices___query.pri' - $ref: '#/components/parameters/list.indices___query.s' - $ref: '#/components/parameters/list.indices___query.size' - $ref: '#/components/parameters/list.indices___query.sort' - $ref: '#/components/parameters/list.indices___query.time' - $ref: '#/components/parameters/list.indices___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/list.indices___200' /_list/indices/{index}: get: operationId: list.indices.1 x-operation-group: list.indices x-version-added: '2.18' description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. externalDocs: url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ parameters: - $ref: '#/components/parameters/list.indices___path.index' - $ref: '#/components/parameters/list.indices___query.bytes' - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' - $ref: '#/components/parameters/list.indices___query.expand_wildcards' - $ref: '#/components/parameters/list.indices___query.format' - $ref: '#/components/parameters/list.indices___query.h' - $ref: '#/components/parameters/list.indices___query.health' - $ref: '#/components/parameters/list.indices___query.help' - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' - $ref: '#/components/parameters/list.indices___query.local' - $ref: '#/components/parameters/list.indices___query.master_timeout' - $ref: '#/components/parameters/list.indices___query.next_token' - $ref: '#/components/parameters/list.indices___query.pri' - $ref: '#/components/parameters/list.indices___query.s' - $ref: '#/components/parameters/list.indices___query.size' - $ref: '#/components/parameters/list.indices___query.sort' - $ref: '#/components/parameters/list.indices___query.time' - $ref: '#/components/parameters/list.indices___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/list.indices___200' /_list/shards: get: operationId: list.shards.0 x-operation-group: list.shards x-version-added: '2.18' description: Returns paginated details of shard allocation on nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ parameters: - $ref: '#/components/parameters/list.shards___query.bytes' - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' - $ref: '#/components/parameters/list.shards___query.format' - $ref: '#/components/parameters/list.shards___query.h' - $ref: '#/components/parameters/list.shards___query.help' - $ref: '#/components/parameters/list.shards___query.local' - $ref: '#/components/parameters/list.shards___query.master_timeout' - $ref: '#/components/parameters/list.shards___query.next_token' - $ref: '#/components/parameters/list.shards___query.s' - $ref: '#/components/parameters/list.shards___query.size' - $ref: '#/components/parameters/list.shards___query.sort' - $ref: '#/components/parameters/list.shards___query.time' - $ref: '#/components/parameters/list.shards___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/list.shards___200' /_list/shards/{index}: get: operationId: list.shards.1 x-operation-group: list.shards x-version-added: '2.18' description: Returns paginated details of shard allocation on nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ parameters: - $ref: '#/components/parameters/list.shards___path.index' - $ref: '#/components/parameters/list.shards___query.bytes' - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' - $ref: '#/components/parameters/list.shards___query.format' - $ref: '#/components/parameters/list.shards___query.h' - $ref: '#/components/parameters/list.shards___query.help' - $ref: '#/components/parameters/list.shards___query.local' - $ref: '#/components/parameters/list.shards___query.master_timeout' - $ref: '#/components/parameters/list.shards___query.next_token' - $ref: '#/components/parameters/list.shards___query.s' - $ref: '#/components/parameters/list.shards___query.size' - $ref: '#/components/parameters/list.shards___query.sort' - $ref: '#/components/parameters/list.shards___query.time' - $ref: '#/components/parameters/list.shards___query.v' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/list.shards___200' /_ltr: delete: operationId: ltr.delete_default_store.0 x-operation-group: ltr.delete_default_store x-version-added: 2.17.1 description: Deletes the default feature store. responses: '200': $ref: '#/components/responses/ltr.delete_default_store___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' get: operationId: ltr.list_stores.0 x-operation-group: ltr.list_stores x-version-added: 2.17.1 description: Lists all available feature stores. responses: '200': $ref: '#/components/responses/ltr.list_stores___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: ltr.create_default_store.0 x-operation-group: ltr.create_default_store x-version-added: 2.17.1 description: Creates the default feature store. responses: '200': $ref: '#/components/responses/ltr.create_default_store___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_ltr/_cachestats: get: operationId: ltr.cache_stats.0 x-operation-group: ltr.cache_stats x-version-added: '2.19' description: Retrieves cache statistics for all feature stores. responses: '200': $ref: '#/components/responses/ltr.cache_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_ltr/_clearcache: post: operationId: ltr.clear_cache.0 x-operation-group: ltr.clear_cache x-version-added: '2.19' description: Clears the store caches. responses: '200': $ref: '#/components/responses/ltr.clear_cache___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_ltr/_feature: get: operationId: ltr.search_features.0 x-operation-group: ltr.search_features x-version-added: '2.19' description: Search for features in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_features___query.from' - $ref: '#/components/parameters/ltr.search_features___query.prefix' - $ref: '#/components/parameters/ltr.search_features___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_features___200' /_ltr/_feature/{id}: delete: operationId: ltr.delete_feature.0 x-operation-group: ltr.delete_feature x-version-added: '2.19' description: Delete a feature from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_feature___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_feature___200' '404': $ref: '#/components/responses/ltr.delete_feature___404' get: operationId: ltr.get_feature.0 x-operation-group: ltr.get_feature x-version-added: '2.19' description: Get a feature from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_feature___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_feature___200' '404': $ref: '#/components/responses/ltr.get_feature___404' post: operationId: ltr.update_feature.0 x-operation-group: ltr.update_feature x-version-added: '2.19' description: Update a feature in the default feature store. parameters: - $ref: '#/components/parameters/ltr.update_feature___path.id' - $ref: '#/components/parameters/ltr.update_feature___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.update_feature' responses: '200': $ref: '#/components/responses/ltr.update_feature___200' '404': $ref: '#/components/responses/ltr.update_feature___404' '409': $ref: '#/components/responses/ltr.update_feature___409' put: operationId: ltr.create_feature.0 x-operation-group: ltr.create_feature x-version-added: '2.19' description: Create or update a feature in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_feature___path.id' - $ref: '#/components/parameters/ltr.create_feature___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_feature' responses: '200': $ref: '#/components/responses/ltr.create_feature___200' '201': $ref: '#/components/responses/ltr.create_feature___201' '409': $ref: '#/components/responses/ltr.create_feature___409' /_ltr/_featureset: get: operationId: ltr.search_featuresets.0 x-operation-group: ltr.search_featuresets x-version-added: '2.19' description: Search for feature sets in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_featuresets___query.from' - $ref: '#/components/parameters/ltr.search_featuresets___query.prefix' - $ref: '#/components/parameters/ltr.search_featuresets___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_featuresets___200' /_ltr/_featureset/{id}: delete: operationId: ltr.delete_featureset.0 x-operation-group: ltr.delete_featureset x-version-added: '2.19' description: Delete a feature set from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_featureset___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_featureset___200' '404': $ref: '#/components/responses/ltr.delete_featureset___404' get: operationId: ltr.get_featureset.0 x-operation-group: ltr.get_featureset x-version-added: '2.19' description: Get a feature set from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_featureset___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_featureset___200' '404': $ref: '#/components/responses/ltr.get_featureset___404' post: operationId: ltr.update_featureset.0 x-operation-group: ltr.update_featureset x-version-added: '2.19' description: Update a feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.update_featureset___path.id' - $ref: '#/components/parameters/ltr.update_featureset___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.update_featureset' responses: '200': $ref: '#/components/responses/ltr.update_featureset___200' '404': $ref: '#/components/responses/ltr.update_featureset___404' '409': $ref: '#/components/responses/ltr.update_featureset___409' put: operationId: ltr.create_featureset.0 x-operation-group: ltr.create_featureset x-version-added: '2.19' description: Create or update a feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_featureset___path.id' - $ref: '#/components/parameters/ltr.create_featureset___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_featureset' responses: '200': $ref: '#/components/responses/ltr.create_featureset___200' '201': $ref: '#/components/responses/ltr.create_featureset___201' '409': $ref: '#/components/responses/ltr.create_featureset___409' /_ltr/_featureset/{name}/_addfeatures: post: operationId: ltr.add_features_to_set.0 x-operation-group: ltr.add_features_to_set x-version-added: '2.19' description: Add features to an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.add_features_to_set___path.name' - $ref: '#/components/parameters/ltr.add_features_to_set___query.merge' - $ref: '#/components/parameters/ltr.add_features_to_set___query.routing' - $ref: '#/components/parameters/ltr.add_features_to_set___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.add_features_to_set' responses: '200': $ref: '#/components/responses/ltr.add_features_to_set___200' '201': $ref: '#/components/responses/ltr.add_features_to_set___201' '400': $ref: '#/components/responses/ltr.add_features_to_set___400' '404': $ref: '#/components/responses/ltr.add_features_to_set___404' '409': $ref: '#/components/responses/ltr.add_features_to_set___409' /_ltr/_featureset/{name}/_addfeatures/{query}: post: operationId: ltr.add_features_to_set_by_query.0 x-operation-group: ltr.add_features_to_set_by_query x-version-added: '2.19' description: Add features to an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___path.name' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___path.query' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.merge' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.routing' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.add_features_to_set_by_query___200' '201': $ref: '#/components/responses/ltr.add_features_to_set_by_query___201' '400': $ref: '#/components/responses/ltr.add_features_to_set_by_query___400' '404': $ref: '#/components/responses/ltr.add_features_to_set_by_query___404' '409': $ref: '#/components/responses/ltr.add_features_to_set_by_query___409' /_ltr/_featureset/{name}/_createmodel: post: operationId: ltr.create_model_from_set.0 x-operation-group: ltr.create_model_from_set x-version-added: '2.19' description: Create a model from an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_model_from_set___path.name' - $ref: '#/components/parameters/ltr.create_model_from_set___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_model_from_set' responses: '200': $ref: '#/components/responses/ltr.create_model_from_set___200' '201': $ref: '#/components/responses/ltr.create_model_from_set___201' '405': $ref: '#/components/responses/ltr.create_model_from_set___405' /_ltr/_model: get: operationId: ltr.search_models.0 x-operation-group: ltr.search_models x-version-added: '2.19' description: Search for models in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_models___query.from' - $ref: '#/components/parameters/ltr.search_models___query.prefix' - $ref: '#/components/parameters/ltr.search_models___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_models___200' /_ltr/_model/{id}: delete: operationId: ltr.delete_model.0 x-operation-group: ltr.delete_model x-version-added: '2.19' description: Delete a model from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_model___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_model___200' '404': $ref: '#/components/responses/ltr.delete_model___404' get: operationId: ltr.get_model.0 x-operation-group: ltr.get_model x-version-added: '2.19' description: Get a model from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_model___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_model___200' '404': $ref: '#/components/responses/ltr.get_model___404' put: operationId: ltr.create_model.0 x-operation-group: ltr.create_model x-version-added: '2.19' description: Create or update a model in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_model___path.id' - $ref: '#/components/parameters/ltr.create_model___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_model' responses: '200': $ref: '#/components/responses/ltr.create_model___200' '201': $ref: '#/components/responses/ltr.create_model___201' '409': $ref: '#/components/responses/ltr.create_model___409' /_ltr/{store}: delete: operationId: ltr.delete_store.0 x-operation-group: ltr.delete_store x-version-added: 2.17.1 description: Deletes a feature store with the specified name. parameters: - $ref: '#/components/parameters/ltr.delete_store___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_store___200' get: operationId: ltr.get_store.0 x-operation-group: ltr.get_store x-version-added: 2.17.1 description: Checks if a store exists. parameters: - $ref: '#/components/parameters/ltr.get_store___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_store___200' '404': $ref: '#/components/responses/ltr.get_store___404' put: operationId: ltr.create_store.0 x-operation-group: ltr.create_store x-version-added: 2.17.1 description: Creates a new feature store with the specified name. parameters: - $ref: '#/components/parameters/ltr.create_store___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.create_store___200' /_ltr/{store}/_clearcache: post: operationId: ltr.clear_cache.1 x-operation-group: ltr.clear_cache x-version-added: '2.19' description: Clears the store caches. parameters: - $ref: '#/components/parameters/ltr.clear_cache___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.clear_cache___200' /_ltr/{store}/_feature: get: operationId: ltr.search_features.1 x-operation-group: ltr.search_features x-version-added: '2.19' description: Search for features in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_features___path.store' - $ref: '#/components/parameters/ltr.search_features___query.from' - $ref: '#/components/parameters/ltr.search_features___query.prefix' - $ref: '#/components/parameters/ltr.search_features___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_features___200' /_ltr/{store}/_feature/{id}: delete: operationId: ltr.delete_feature.1 x-operation-group: ltr.delete_feature x-version-added: '2.19' description: Delete a feature from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_feature___path.id' - $ref: '#/components/parameters/ltr.delete_feature___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_feature___200' '404': $ref: '#/components/responses/ltr.delete_feature___404' get: operationId: ltr.get_feature.1 x-operation-group: ltr.get_feature x-version-added: '2.19' description: Get a feature from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_feature___path.id' - $ref: '#/components/parameters/ltr.get_feature___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_feature___200' '404': $ref: '#/components/responses/ltr.get_feature___404' post: operationId: ltr.update_feature.1 x-operation-group: ltr.update_feature x-version-added: '2.19' description: Update a feature in the default feature store. parameters: - $ref: '#/components/parameters/ltr.update_feature___path.id' - $ref: '#/components/parameters/ltr.update_feature___path.store' - $ref: '#/components/parameters/ltr.update_feature___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.update_feature' responses: '200': $ref: '#/components/responses/ltr.update_feature___200' '404': $ref: '#/components/responses/ltr.update_feature___404' '409': $ref: '#/components/responses/ltr.update_feature___409' put: operationId: ltr.create_feature.1 x-operation-group: ltr.create_feature x-version-added: '2.19' description: Create or update a feature in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_feature___path.id' - $ref: '#/components/parameters/ltr.create_feature___path.store' - $ref: '#/components/parameters/ltr.create_feature___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_feature' responses: '200': $ref: '#/components/responses/ltr.create_feature___200' '201': $ref: '#/components/responses/ltr.create_feature___201' '409': $ref: '#/components/responses/ltr.create_feature___409' /_ltr/{store}/_featureset: get: operationId: ltr.search_featuresets.1 x-operation-group: ltr.search_featuresets x-version-added: '2.19' description: Search for feature sets in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_featuresets___path.store' - $ref: '#/components/parameters/ltr.search_featuresets___query.from' - $ref: '#/components/parameters/ltr.search_featuresets___query.prefix' - $ref: '#/components/parameters/ltr.search_featuresets___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_featuresets___200' /_ltr/{store}/_featureset/{id}: delete: operationId: ltr.delete_featureset.1 x-operation-group: ltr.delete_featureset x-version-added: '2.19' description: Delete a feature set from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_featureset___path.id' - $ref: '#/components/parameters/ltr.delete_featureset___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_featureset___200' '404': $ref: '#/components/responses/ltr.delete_featureset___404' get: operationId: ltr.get_featureset.1 x-operation-group: ltr.get_featureset x-version-added: '2.19' description: Get a feature set from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_featureset___path.id' - $ref: '#/components/parameters/ltr.get_featureset___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_featureset___200' '404': $ref: '#/components/responses/ltr.get_featureset___404' post: operationId: ltr.update_featureset.1 x-operation-group: ltr.update_featureset x-version-added: '2.19' description: Update a feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.update_featureset___path.id' - $ref: '#/components/parameters/ltr.update_featureset___path.store' - $ref: '#/components/parameters/ltr.update_featureset___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.update_featureset' responses: '200': $ref: '#/components/responses/ltr.update_featureset___200' '404': $ref: '#/components/responses/ltr.update_featureset___404' '409': $ref: '#/components/responses/ltr.update_featureset___409' put: operationId: ltr.create_featureset.1 x-operation-group: ltr.create_featureset x-version-added: '2.19' description: Create or update a feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_featureset___path.id' - $ref: '#/components/parameters/ltr.create_featureset___path.store' - $ref: '#/components/parameters/ltr.create_featureset___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_featureset' responses: '200': $ref: '#/components/responses/ltr.create_featureset___200' '201': $ref: '#/components/responses/ltr.create_featureset___201' '409': $ref: '#/components/responses/ltr.create_featureset___409' /_ltr/{store}/_featureset/{name}/_addfeatures: post: operationId: ltr.add_features_to_set.2 x-operation-group: ltr.add_features_to_set x-version-added: '2.19' description: Add features to an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.add_features_to_set___path.name' - $ref: '#/components/parameters/ltr.add_features_to_set___path.store' - $ref: '#/components/parameters/ltr.add_features_to_set___query.merge' - $ref: '#/components/parameters/ltr.add_features_to_set___query.routing' - $ref: '#/components/parameters/ltr.add_features_to_set___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.add_features_to_set' responses: '200': $ref: '#/components/responses/ltr.add_features_to_set___200' '201': $ref: '#/components/responses/ltr.add_features_to_set___201' '400': $ref: '#/components/responses/ltr.add_features_to_set___400' '404': $ref: '#/components/responses/ltr.add_features_to_set___404' '409': $ref: '#/components/responses/ltr.add_features_to_set___409' /_ltr/{store}/_featureset/{name}/_addfeatures/{query}: post: operationId: ltr.add_features_to_set_by_query.1 x-operation-group: ltr.add_features_to_set_by_query x-version-added: '2.19' description: Add features to an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___path.name' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___path.query' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___path.store' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.merge' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.routing' - $ref: '#/components/parameters/ltr.add_features_to_set_by_query___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.add_features_to_set_by_query___200' '201': $ref: '#/components/responses/ltr.add_features_to_set_by_query___201' '400': $ref: '#/components/responses/ltr.add_features_to_set_by_query___400' '404': $ref: '#/components/responses/ltr.add_features_to_set_by_query___404' '409': $ref: '#/components/responses/ltr.add_features_to_set_by_query___409' /_ltr/{store}/_featureset/{name}/_createmodel: post: operationId: ltr.create_model_from_set.1 x-operation-group: ltr.create_model_from_set x-version-added: '2.19' description: Create a model from an existing feature set in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_model_from_set___path.name' - $ref: '#/components/parameters/ltr.create_model_from_set___path.store' - $ref: '#/components/parameters/ltr.create_model_from_set___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_model_from_set' responses: '200': $ref: '#/components/responses/ltr.create_model_from_set___200' '201': $ref: '#/components/responses/ltr.create_model_from_set___201' '405': $ref: '#/components/responses/ltr.create_model_from_set___405' /_ltr/{store}/_model: get: operationId: ltr.search_models.1 x-operation-group: ltr.search_models x-version-added: '2.19' description: Search for models in a feature store. parameters: - $ref: '#/components/parameters/ltr.search_models___path.store' - $ref: '#/components/parameters/ltr.search_models___query.from' - $ref: '#/components/parameters/ltr.search_models___query.prefix' - $ref: '#/components/parameters/ltr.search_models___query.size' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.search_models___200' /_ltr/{store}/_model/{id}: delete: operationId: ltr.delete_model.1 x-operation-group: ltr.delete_model x-version-added: '2.19' description: Delete a model from the default feature store. parameters: - $ref: '#/components/parameters/ltr.delete_model___path.id' - $ref: '#/components/parameters/ltr.delete_model___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.delete_model___200' '404': $ref: '#/components/responses/ltr.delete_model___404' get: operationId: ltr.get_model.1 x-operation-group: ltr.get_model x-version-added: '2.19' description: Get a model from the default feature store. parameters: - $ref: '#/components/parameters/ltr.get_model___path.id' - $ref: '#/components/parameters/ltr.get_model___path.store' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.get_model___200' '404': $ref: '#/components/responses/ltr.get_model___404' put: operationId: ltr.create_model.1 x-operation-group: ltr.create_model x-version-added: '2.19' description: Create or update a model in the default feature store. parameters: - $ref: '#/components/parameters/ltr.create_model___path.id' - $ref: '#/components/parameters/ltr.create_model___path.store' - $ref: '#/components/parameters/ltr.create_model___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ltr.create_model' responses: '200': $ref: '#/components/responses/ltr.create_model___200' '201': $ref: '#/components/responses/ltr.create_model___201' '409': $ref: '#/components/responses/ltr.create_model___409' /_mapping: get: operationId: indices.get_mapping.0 x-operation-group: indices.get_mapping x-version-added: '1.0' description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: - $ref: '#/components/parameters/indices.get_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_mapping___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping___query.index' - $ref: '#/components/parameters/indices.get_mapping___query.local' - $ref: '#/components/parameters/indices.get_mapping___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_mapping___200' /_mapping/field/{fields}: get: operationId: indices.get_field_mapping.0 x-operation-group: indices.get_field_mapping x-version-added: '1.0' description: Returns mapping for one or more fields. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: - $ref: '#/components/parameters/indices.get_field_mapping___path.fields' - $ref: '#/components/parameters/indices.get_field_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_field_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_field_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_field_mapping___query.include_defaults' - $ref: '#/components/parameters/indices.get_field_mapping___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_field_mapping___200' /_mget: get: operationId: mget.0 x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - $ref: '#/components/parameters/mget___query._source' - $ref: '#/components/parameters/mget___query._source_excludes' - $ref: '#/components/parameters/mget___query._source_includes' - $ref: '#/components/parameters/mget___query.preference' - $ref: '#/components/parameters/mget___query.realtime' - $ref: '#/components/parameters/mget___query.refresh' - $ref: '#/components/parameters/mget___query.routing' - $ref: '#/components/parameters/mget___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mget' responses: '200': $ref: '#/components/responses/mget___200' post: operationId: mget.1 x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - $ref: '#/components/parameters/mget___query._source' - $ref: '#/components/parameters/mget___query._source_excludes' - $ref: '#/components/parameters/mget___query._source_includes' - $ref: '#/components/parameters/mget___query.preference' - $ref: '#/components/parameters/mget___query.realtime' - $ref: '#/components/parameters/mget___query.refresh' - $ref: '#/components/parameters/mget___query.routing' - $ref: '#/components/parameters/mget___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mget' responses: '200': $ref: '#/components/responses/mget___200' /_msearch: get: operationId: msearch.0 x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch___query.allow_partial_results' - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch___query.search_type' - $ref: '#/components/parameters/msearch___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch' responses: '200': $ref: '#/components/responses/msearch___200' post: operationId: msearch.1 x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch___query.allow_partial_results' - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch___query.search_type' - $ref: '#/components/parameters/msearch___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch' responses: '200': $ref: '#/components/responses/msearch___200' /_msearch/template: get: operationId: msearch_template.0 x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch_template___query.search_type' - $ref: '#/components/parameters/msearch_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch_template' responses: '200': $ref: '#/components/responses/msearch_template___200' post: operationId: msearch_template.1 x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch_template___query.search_type' - $ref: '#/components/parameters/msearch_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch_template' responses: '200': $ref: '#/components/responses/msearch_template___200' /_mtermvectors: get: operationId: mtermvectors.0 x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors___query.field_statistics' - $ref: '#/components/parameters/mtermvectors___query.fields' - $ref: '#/components/parameters/mtermvectors___query.ids' - $ref: '#/components/parameters/mtermvectors___query.offsets' - $ref: '#/components/parameters/mtermvectors___query.payloads' - $ref: '#/components/parameters/mtermvectors___query.positions' - $ref: '#/components/parameters/mtermvectors___query.preference' - $ref: '#/components/parameters/mtermvectors___query.realtime' - $ref: '#/components/parameters/mtermvectors___query.routing' - $ref: '#/components/parameters/mtermvectors___query.term_statistics' - $ref: '#/components/parameters/mtermvectors___query.version' - $ref: '#/components/parameters/mtermvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': $ref: '#/components/responses/mtermvectors___200' post: operationId: mtermvectors.1 x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors___query.field_statistics' - $ref: '#/components/parameters/mtermvectors___query.fields' - $ref: '#/components/parameters/mtermvectors___query.ids' - $ref: '#/components/parameters/mtermvectors___query.offsets' - $ref: '#/components/parameters/mtermvectors___query.payloads' - $ref: '#/components/parameters/mtermvectors___query.positions' - $ref: '#/components/parameters/mtermvectors___query.preference' - $ref: '#/components/parameters/mtermvectors___query.realtime' - $ref: '#/components/parameters/mtermvectors___query.routing' - $ref: '#/components/parameters/mtermvectors___query.term_statistics' - $ref: '#/components/parameters/mtermvectors___query.version' - $ref: '#/components/parameters/mtermvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': $ref: '#/components/responses/mtermvectors___200' /_nodes: get: operationId: nodes.info.0 x-operation-group: nodes.info x-version-added: '1.0' description: Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - $ref: '#/components/parameters/nodes.info___query.flat_settings' - $ref: '#/components/parameters/nodes.info___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id_or_metric}: get: operationId: nodes.info.1 x-operation-group: nodes.info x-version-added: '1.0' description: Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - $ref: '#/components/parameters/nodes.info___path.node_id_or_metric' - $ref: '#/components/parameters/nodes.info___query.flat_settings' - $ref: '#/components/parameters/nodes.info___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id}/{metric}: get: operationId: nodes.info.3 x-operation-group: nodes.info x-version-added: '1.0' description: Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - $ref: '#/components/parameters/nodes.info___path.metric' - $ref: '#/components/parameters/nodes.info___path.node_id' - $ref: '#/components/parameters/nodes.info___query.flat_settings' - $ref: '#/components/parameters/nodes.info___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id}/hot_threads: get: operationId: nodes.hot_threads.6 x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___path.node_id' - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_nodes/{node_id}/reload_secure_settings: post: operationId: nodes.reload_secure_settings.1 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' description: Reloads secure settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: - $ref: '#/components/parameters/nodes.reload_secure_settings___path.node_id' - $ref: '#/components/parameters/nodes.reload_secure_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': $ref: '#/components/responses/nodes.reload_secure_settings___200' /_nodes/{node_id}/stats: get: operationId: nodes.stats.3 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___path.node_id' - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/{node_id}/stats/{metric}: get: operationId: nodes.stats.4 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___path.metric' - $ref: '#/components/parameters/nodes.stats___path.node_id' - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/{node_id}/stats/{metric}/{index_metric}: get: operationId: nodes.stats.5 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___path.index_metric' - $ref: '#/components/parameters/nodes.stats___path.metric' - $ref: '#/components/parameters/nodes.stats___path.node_id' - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/{node_id}/usage: get: operationId: nodes.usage.2 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/nodes.usage___path.node_id' - $ref: '#/components/parameters/nodes.usage___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.usage___200' /_nodes/{node_id}/usage/{metric}: get: operationId: nodes.usage.3 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/nodes.usage___path.metric' - $ref: '#/components/parameters/nodes.usage___path.node_id' - $ref: '#/components/parameters/nodes.usage___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.usage___200' /_nodes/hot_threads: get: operationId: nodes.hot_threads.4 x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_nodes/reload_secure_settings: post: operationId: nodes.reload_secure_settings.0 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' description: Reloads secure settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: - $ref: '#/components/parameters/nodes.reload_secure_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': $ref: '#/components/responses/nodes.reload_secure_settings___200' /_nodes/stats: get: operationId: nodes.stats.0 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/stats/{metric}: get: operationId: nodes.stats.1 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___path.metric' - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/stats/{metric}/{index_metric}: get: operationId: nodes.stats.2 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - $ref: '#/components/parameters/nodes.stats___path.index_metric' - $ref: '#/components/parameters/nodes.stats___path.metric' - $ref: '#/components/parameters/nodes.stats___query.completion_fields' - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' - $ref: '#/components/parameters/nodes.stats___query.fields' - $ref: '#/components/parameters/nodes.stats___query.groups' - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/nodes.stats___query.level' - $ref: '#/components/parameters/nodes.stats___query.timeout' - $ref: '#/components/parameters/nodes.stats___query.types' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.stats___200' /_nodes/usage: get: operationId: nodes.usage.0 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/nodes.usage___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.usage___200' /_nodes/usage/{metric}: get: operationId: nodes.usage.1 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/nodes.usage___path.metric' - $ref: '#/components/parameters/nodes.usage___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.usage___200' /_opendistro/_security/sslinfo: get: operationId: security.get_sslinfo.0 x-operation-group: security.get_sslinfo x-version-added: '1.0' description: Retrieves information about the SSL configuration. parameters: - $ref: '#/components/parameters/security.get_sslinfo___query.show_dn' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_sslinfo___200' '500': $ref: '#/components/responses/security.get_sslinfo___500' /_plugins/_asynchronous_search: post: operationId: asynchronous_search.search.0 x-operation-group: asynchronous_search.search x-version-added: '1.0' description: Performs an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: - $ref: '#/components/parameters/asynchronous_search.search___query.index' - $ref: '#/components/parameters/asynchronous_search.search___query.keep_alive' - $ref: '#/components/parameters/asynchronous_search.search___query.keep_on_completion' - $ref: '#/components/parameters/asynchronous_search.search___query.wait_for_completion_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/asynchronous_search.search' responses: '200': $ref: '#/components/responses/asynchronous_search.search___200' /_plugins/_asynchronous_search/{id}: delete: operationId: asynchronous_search.delete.0 x-operation-group: asynchronous_search.delete x-version-added: '1.0' description: Deletes any responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: - $ref: '#/components/parameters/asynchronous_search.delete___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/asynchronous_search.delete___200' get: operationId: asynchronous_search.get.0 x-operation-group: asynchronous_search.get x-version-added: '1.0' description: Gets partial responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: - $ref: '#/components/parameters/asynchronous_search.get___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/asynchronous_search.get___200' /_plugins/_asynchronous_search/stats: get: operationId: asynchronous_search.stats.0 x-operation-group: asynchronous_search.stats x-version-added: '1.0' description: Monitors any asynchronous searches that are `running`, `completed`, or `persisted`. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: '200': $ref: '#/components/responses/asynchronous_search.stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_flow_framework/workflow: post: operationId: flow_framework.create.0 x-operation-group: flow_framework.create x-version-added: '2.12' description: Creates a new workflow template. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.create___query.provision' - $ref: '#/components/parameters/flow_framework.create___query.reprovision' - $ref: '#/components/parameters/flow_framework.create___query.update_fields' - $ref: '#/components/parameters/flow_framework.create___query.use_case' - $ref: '#/components/parameters/flow_framework.create___query.validation' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/flow_framework.create' responses: '201': $ref: '#/components/responses/flow_framework.create___201' '202': $ref: '#/components/responses/flow_framework.create___202' '400': $ref: '#/components/responses/flow_framework.create___400' '403': $ref: '#/components/responses/flow_framework.create___403' /_plugins/_flow_framework/workflow/_search: get: operationId: flow_framework.search.1 x-operation-group: flow_framework.search x-version-added: '2.12' description: Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ requestBody: $ref: '#/components/requestBodies/flow_framework.search' responses: '200': $ref: '#/components/responses/flow_framework.search___200' '400': $ref: '#/components/responses/flow_framework.search___400' '403': $ref: '#/components/responses/flow_framework.search___403' '408': $ref: '#/components/responses/flow_framework.search___408' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: flow_framework.search.0 x-operation-group: flow_framework.search x-version-added: '2.12' description: Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ requestBody: $ref: '#/components/requestBodies/flow_framework.search' responses: '200': $ref: '#/components/responses/flow_framework.search___200' '400': $ref: '#/components/responses/flow_framework.search___400' '403': $ref: '#/components/responses/flow_framework.search___403' '408': $ref: '#/components/responses/flow_framework.search___408' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_flow_framework/workflow/_steps: get: operationId: flow_framework.get_steps.0 x-operation-group: flow_framework.get_steps x-version-added: '2.12' description: Retrieves available workflow steps. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/ parameters: - $ref: '#/components/parameters/flow_framework.get_steps___query.workflow_step' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/flow_framework.get_steps___200' '400': $ref: '#/components/responses/flow_framework.get_steps___400' '403': $ref: '#/components/responses/flow_framework.get_steps___403' /_plugins/_flow_framework/workflow/{workflow_id}: delete: operationId: flow_framework.delete.0 x-operation-group: flow_framework.delete x-version-added: '2.12' description: Deletes a workflow template. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.delete___path.workflow_id' - $ref: '#/components/parameters/flow_framework.delete___query.clear_status' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/flow_framework.delete___200' '400': $ref: '#/components/responses/flow_framework.delete___400' '403': $ref: '#/components/responses/flow_framework.delete___403' get: operationId: flow_framework.get.0 x-operation-group: flow_framework.get x-version-added: '2.12' externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/ description: Retrieves a workflow template. parameters: - $ref: '#/components/parameters/flow_framework.get___path.workflow_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/flow_framework.get___200' '404': $ref: '#/components/responses/flow_framework.get___404' put: operationId: flow_framework.update.0 x-operation-group: flow_framework.update x-version-added: '2.12' description: Updates a workflow template that has not been provisioned. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.update___path.workflow_id' - $ref: '#/components/parameters/flow_framework.update___query.provision' - $ref: '#/components/parameters/flow_framework.update___query.reprovision' - $ref: '#/components/parameters/flow_framework.update___query.update_fields' - $ref: '#/components/parameters/flow_framework.update___query.use_case' - $ref: '#/components/parameters/flow_framework.update___query.validation' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/flow_framework.update' responses: '201': $ref: '#/components/responses/flow_framework.update___201' description: It returns the `workflow_id`. '400': $ref: '#/components/responses/flow_framework.update___400' '404': $ref: '#/components/responses/flow_framework.update___404' /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision: post: operationId: flow_framework.deprovision.0 x-operation-group: flow_framework.deprovision x-version-added: '2.12' description: Deprovision workflow's resources when you no longer need them. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.deprovision___path.workflow_id' - $ref: '#/components/parameters/flow_framework.deprovision___query.allow_delete' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/flow_framework.deprovision___200' '202': $ref: '#/components/responses/flow_framework.deprovision___202' '403': $ref: '#/components/responses/flow_framework.deprovision___403' '404': $ref: '#/components/responses/flow_framework.deprovision___404' /_plugins/_flow_framework/workflow/{workflow_id}/_provision: post: operationId: flow_framework.provision.0 x-operation-group: flow_framework.provision x-version-added: '2.12' description: Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.provision___path.workflow_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: description: |- Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body. For example, if you specified a credential field in the template as `openai_key: '$'`, you can pass `openai_key` as a query parameter or in the request body. $ref: '#/components/requestBodies/flow_framework.provision' responses: '200': $ref: '#/components/responses/flow_framework.provision___200' '202': $ref: '#/components/responses/flow_framework.provision___202' '400': $ref: '#/components/responses/flow_framework.provision___400' '403': $ref: '#/components/responses/flow_framework.provision___403' /_plugins/_flow_framework/workflow/{workflow_id}/_status: get: operationId: flow_framework.get_status.0 x-operation-group: flow_framework.get_status x-version-added: '2.12' description: Retrieves the current workflow provisioning status. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/ parameters: - $ref: '#/components/parameters/flow_framework.get_status___path.workflow_id' - $ref: '#/components/parameters/flow_framework.get_status___query.all' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/flow_framework.get_status___200' '403': $ref: '#/components/responses/flow_framework.get_status___403' '404': $ref: '#/components/responses/flow_framework.get_status___404' /_plugins/_flow_framework/workflow/state/_search: get: operationId: flow_framework.search_state.1 x-operation-group: flow_framework.search_state x-version-added: '2.12' description: Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/ requestBody: $ref: '#/components/requestBodies/flow_framework.search_state' responses: '200': $ref: '#/components/responses/flow_framework.search_state___200' '400': $ref: '#/components/responses/flow_framework.search_state___400' '403': $ref: '#/components/responses/flow_framework.search_state___403' '408': $ref: '#/components/responses/flow_framework.search_state___408' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: flow_framework.search_state.0 x-operation-group: flow_framework.search_state x-version-added: '2.12' description: Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/ requestBody: $ref: '#/components/requestBodies/flow_framework.search_state' responses: '200': $ref: '#/components/responses/flow_framework.search_state___200' '400': $ref: '#/components/responses/flow_framework.search_state___400' '403': $ref: '#/components/responses/flow_framework.search_state___403' '408': $ref: '#/components/responses/flow_framework.search_state___408' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ism/add: post: operationId: ism.add_policy.0 x-operation-group: ism.add_policy description: Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - $ref: '#/components/parameters/ism.add_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.add_policy' responses: '200': $ref: '#/components/responses/ism.add_policy___200' /_plugins/_ism/add/{index}: post: operationId: ism.add_policy.1 x-operation-group: ism.add_policy description: Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - $ref: '#/components/parameters/ism.add_policy___path.index' - $ref: '#/components/parameters/ism.add_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.add_policy' responses: '200': $ref: '#/components/responses/ism.add_policy___200' /_plugins/_ism/change_policy: post: operationId: ism.change_policy.0 x-operation-group: ism.change_policy description: Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - $ref: '#/components/parameters/ism.change_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.change_policy' responses: '200': $ref: '#/components/responses/ism.change_policy___200' /_plugins/_ism/change_policy/{index}: post: operationId: ism.change_policy.1 x-operation-group: ism.change_policy description: Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - $ref: '#/components/parameters/ism.change_policy___path.index' - $ref: '#/components/parameters/ism.change_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.change_policy' responses: '200': $ref: '#/components/responses/ism.change_policy___200' /_plugins/_ism/explain: get: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ism/explain/{index}: get: operationId: ism.explain_policy.3 x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - $ref: '#/components/parameters/ism.explain_policy___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' post: operationId: ism.explain_policy.4 x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - $ref: '#/components/parameters/ism.explain_policy___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' /_plugins/_ism/policies: get: operationId: ism.get_policies.0 x-operation-group: ism.get_policies description: Retrieves the policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy responses: '200': $ref: '#/components/responses/ism.get_policies___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: ism.put_policies.0 x-operation-group: ism.put_policies description: Creates or updates policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy requestBody: $ref: '#/components/requestBodies/ism.put_policies' parameters: - $ref: '#/components/parameters/ism.put_policies___query.if_primary_term' - $ref: '#/components/parameters/ism.put_policies___query.if_seq_no' - $ref: '#/components/parameters/ism.put_policies___query.policyID' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.put_policies___200' /_plugins/_ism/policies/{policy_id}: delete: operationId: ism.delete_policy.0 x-operation-group: ism.delete_policy description: Deletes a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy parameters: - $ref: '#/components/parameters/ism.delete_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.delete_policy___200' get: operationId: ism.get_policy.0 x-operation-group: ism.get_policy description: Retrieves a specific policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy parameters: - $ref: '#/components/parameters/ism.get_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.get_policy___200' head: operationId: ism.exists_policy.0 x-operation-group: ism.exists_policy description: Checks for the existence of a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy parameters: - $ref: '#/components/parameters/ism.exists_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.exists_policy___200' '404': $ref: '#/components/responses/ism.exists_policy___404' put: operationId: ism.put_policy.0 x-operation-group: ism.put_policy description: Creates or updates a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy parameters: - $ref: '#/components/parameters/ism.put_policy___path.policy_id' - $ref: '#/components/parameters/ism.put_policy___query.if_primary_term' - $ref: '#/components/parameters/ism.put_policy___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.put_policy' responses: '200': $ref: '#/components/responses/ism.put_policy___200' '201': $ref: '#/components/responses/ism.put_policy___201' /_plugins/_ism/remove: post: operationId: ism.remove_policy.0 x-operation-group: ism.remove_policy description: Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - $ref: '#/components/parameters/ism.remove_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.remove_policy___200' /_plugins/_ism/remove/{index}: post: operationId: ism.remove_policy.1 x-operation-group: ism.remove_policy description: Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - $ref: '#/components/parameters/ism.remove_policy___path.index' - $ref: '#/components/parameters/ism.remove_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.remove_policy___200' /_plugins/_ism/retry: post: operationId: ism.retry_index.0 x-operation-group: ism.retry_index description: Retries the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - $ref: '#/components/parameters/ism.retry_index___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.retry_index' responses: '200': $ref: '#/components/responses/ism.retry_index___200' /_plugins/_ism/retry/{index}: post: operationId: ism.retry_index.1 x-operation-group: ism.retry_index description: Retries the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - $ref: '#/components/parameters/ism.retry_index___path.index' - $ref: '#/components/parameters/ism.retry_index___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.retry_index' responses: '200': $ref: '#/components/responses/ism.retry_index___200' /_plugins/_knn/{node_id}/stats: get: operationId: knn.stats.2 x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___path.node_id' - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/{node_id}/stats/{stat}: get: operationId: knn.stats.3 x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___path.node_id' - $ref: '#/components/parameters/knn.stats___path.stat' - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/models/_search: get: operationId: knn.search_models.0 x-operation-group: knn.search_models x-version-added: '1.0' description: Use an OpenSearch query to search for models in the index. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#search-for-a-model parameters: - $ref: '#/components/parameters/knn.search_models___query._source' - $ref: '#/components/parameters/knn.search_models___query._source_excludes' - $ref: '#/components/parameters/knn.search_models___query._source_includes' - $ref: '#/components/parameters/knn.search_models___query.allow_no_indices' - $ref: '#/components/parameters/knn.search_models___query.allow_partial_search_results' - $ref: '#/components/parameters/knn.search_models___query.analyze_wildcard' - $ref: '#/components/parameters/knn.search_models___query.analyzer' - $ref: '#/components/parameters/knn.search_models___query.batched_reduce_size' - $ref: '#/components/parameters/knn.search_models___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/knn.search_models___query.default_operator' - $ref: '#/components/parameters/knn.search_models___query.df' - $ref: '#/components/parameters/knn.search_models___query.docvalue_fields' - $ref: '#/components/parameters/knn.search_models___query.expand_wildcards' - $ref: '#/components/parameters/knn.search_models___query.explain' - $ref: '#/components/parameters/knn.search_models___query.from' - $ref: '#/components/parameters/knn.search_models___query.ignore_throttled' - $ref: '#/components/parameters/knn.search_models___query.ignore_unavailable' - $ref: '#/components/parameters/knn.search_models___query.lenient' - $ref: '#/components/parameters/knn.search_models___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/knn.search_models___query.pre_filter_shard_size' - $ref: '#/components/parameters/knn.search_models___query.preference' - $ref: '#/components/parameters/knn.search_models___query.q' - $ref: '#/components/parameters/knn.search_models___query.request_cache' - $ref: '#/components/parameters/knn.search_models___query.rest_total_hits_as_int' - $ref: '#/components/parameters/knn.search_models___query.routing' - $ref: '#/components/parameters/knn.search_models___query.scroll' - $ref: '#/components/parameters/knn.search_models___query.search_type' - $ref: '#/components/parameters/knn.search_models___query.seq_no_primary_term' - $ref: '#/components/parameters/knn.search_models___query.size' - $ref: '#/components/parameters/knn.search_models___query.sort' - $ref: '#/components/parameters/knn.search_models___query.stats' - $ref: '#/components/parameters/knn.search_models___query.stored_fields' - $ref: '#/components/parameters/knn.search_models___query.suggest_field' - $ref: '#/components/parameters/knn.search_models___query.suggest_mode' - $ref: '#/components/parameters/knn.search_models___query.suggest_size' - $ref: '#/components/parameters/knn.search_models___query.suggest_text' - $ref: '#/components/parameters/knn.search_models___query.terminate_after' - $ref: '#/components/parameters/knn.search_models___query.timeout' - $ref: '#/components/parameters/knn.search_models___query.track_scores' - $ref: '#/components/parameters/knn.search_models___query.track_total_hits' - $ref: '#/components/parameters/knn.search_models___query.typed_keys' - $ref: '#/components/parameters/knn.search_models___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/knn.search_models' responses: '200': $ref: '#/components/responses/knn.search_models___200' post: operationId: knn.search_models.1 x-operation-group: knn.search_models x-version-added: '1.0' description: Use an OpenSearch query to search for models in the index. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#search-for-a-model parameters: - $ref: '#/components/parameters/knn.search_models___query._source' - $ref: '#/components/parameters/knn.search_models___query._source_excludes' - $ref: '#/components/parameters/knn.search_models___query._source_includes' - $ref: '#/components/parameters/knn.search_models___query.allow_no_indices' - $ref: '#/components/parameters/knn.search_models___query.allow_partial_search_results' - $ref: '#/components/parameters/knn.search_models___query.analyze_wildcard' - $ref: '#/components/parameters/knn.search_models___query.analyzer' - $ref: '#/components/parameters/knn.search_models___query.batched_reduce_size' - $ref: '#/components/parameters/knn.search_models___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/knn.search_models___query.default_operator' - $ref: '#/components/parameters/knn.search_models___query.df' - $ref: '#/components/parameters/knn.search_models___query.docvalue_fields' - $ref: '#/components/parameters/knn.search_models___query.expand_wildcards' - $ref: '#/components/parameters/knn.search_models___query.explain' - $ref: '#/components/parameters/knn.search_models___query.from' - $ref: '#/components/parameters/knn.search_models___query.ignore_throttled' - $ref: '#/components/parameters/knn.search_models___query.ignore_unavailable' - $ref: '#/components/parameters/knn.search_models___query.lenient' - $ref: '#/components/parameters/knn.search_models___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/knn.search_models___query.pre_filter_shard_size' - $ref: '#/components/parameters/knn.search_models___query.preference' - $ref: '#/components/parameters/knn.search_models___query.q' - $ref: '#/components/parameters/knn.search_models___query.request_cache' - $ref: '#/components/parameters/knn.search_models___query.rest_total_hits_as_int' - $ref: '#/components/parameters/knn.search_models___query.routing' - $ref: '#/components/parameters/knn.search_models___query.scroll' - $ref: '#/components/parameters/knn.search_models___query.search_type' - $ref: '#/components/parameters/knn.search_models___query.seq_no_primary_term' - $ref: '#/components/parameters/knn.search_models___query.size' - $ref: '#/components/parameters/knn.search_models___query.sort' - $ref: '#/components/parameters/knn.search_models___query.stats' - $ref: '#/components/parameters/knn.search_models___query.stored_fields' - $ref: '#/components/parameters/knn.search_models___query.suggest_field' - $ref: '#/components/parameters/knn.search_models___query.suggest_mode' - $ref: '#/components/parameters/knn.search_models___query.suggest_size' - $ref: '#/components/parameters/knn.search_models___query.suggest_text' - $ref: '#/components/parameters/knn.search_models___query.terminate_after' - $ref: '#/components/parameters/knn.search_models___query.timeout' - $ref: '#/components/parameters/knn.search_models___query.track_scores' - $ref: '#/components/parameters/knn.search_models___query.track_total_hits' - $ref: '#/components/parameters/knn.search_models___query.typed_keys' - $ref: '#/components/parameters/knn.search_models___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/knn.search_models' responses: '200': $ref: '#/components/responses/knn.search_models___200' /_plugins/_knn/models/_train: post: operationId: knn.train_model.0 x-operation-group: knn.train_model x-version-added: '1.0' description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model parameters: - $ref: '#/components/parameters/knn.train_model___query.preference' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/knn.train_model' responses: '200': $ref: '#/components/responses/knn.train_model___200' /_plugins/_knn/models/{model_id}: delete: operationId: knn.delete_model.0 x-operation-group: knn.delete_model x-version-added: '1.0' description: Used to delete a particular model in the cluster. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#delete-a-model parameters: - $ref: '#/components/parameters/knn.delete_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.delete_model___200' get: operationId: knn.get_model.0 x-operation-group: knn.get_model x-version-added: '1.0' description: Used to retrieve information about models present in the cluster. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#get-a-model parameters: - $ref: '#/components/parameters/knn.get_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.get_model___200' /_plugins/_knn/models/{model_id}/_train: post: operationId: knn.train_model.1 x-operation-group: knn.train_model x-version-added: '1.0' description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#train-a-model parameters: - $ref: '#/components/parameters/knn.train_model___path.model_id' - $ref: '#/components/parameters/knn.train_model___query.preference' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/knn.train_model' responses: '200': $ref: '#/components/responses/knn.train_model___200' /_plugins/_knn/stats: get: operationId: knn.stats.0 x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/stats/{stat}: get: operationId: knn.stats.1 x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___path.stat' - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/warmup/{index}: get: operationId: knn.warmup.0 x-operation-group: knn.warmup x-version-added: '1.0' description: Preloads native library files into memory, reducing initial search latency for specified indexes. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#warmup-operation parameters: - $ref: '#/components/parameters/knn.warmup___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.warmup___200' /_plugins/_ltr/{node_id}/stats: get: operationId: ltr.stats.2 x-operation-group: ltr.stats x-version-added: '2.19' description: Provides information about the current status of the LTR plugin. parameters: - $ref: '#/components/parameters/ltr.stats___path.node_id' - $ref: '#/components/parameters/ltr.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.stats___200' /_plugins/_ltr/{node_id}/stats/{stat}: get: operationId: ltr.stats.3 x-operation-group: ltr.stats x-version-added: '2.19' description: Provides information about the current status of the LTR plugin. parameters: - $ref: '#/components/parameters/ltr.stats___path.node_id' - $ref: '#/components/parameters/ltr.stats___path.stat' - $ref: '#/components/parameters/ltr.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.stats___200' /_plugins/_ltr/stats: get: operationId: ltr.stats.0 x-operation-group: ltr.stats x-version-added: '2.19' description: Provides information about the current status of the LTR plugin. parameters: - $ref: '#/components/parameters/ltr.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.stats___200' /_plugins/_ltr/stats/{stat}: get: operationId: ltr.stats.1 x-operation-group: ltr.stats x-version-added: '2.19' description: Provides information about the current status of the LTR plugin. parameters: - $ref: '#/components/parameters/ltr.stats___path.stat' - $ref: '#/components/parameters/ltr.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ltr.stats___200' /_plugins/_ml/_execute/{algorithm_name}: post: operationId: ml.execute_algorithm.0 x-operation-group: ml.execute_algorithm x-version-added: '2.0' description: Execute an algorithm. parameters: - $ref: '#/components/parameters/ml.execute_algorithm___path.algorithm_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.execute_algorithm' responses: '200': $ref: '#/components/responses/ml.execute_algorithm___200' /_plugins/_ml/_predict/{algorithm_name}/{model_id}: post: operationId: ml.predict.0 x-operation-group: ml.predict x-version-added: '1.3' description: Predicts new data with trained model. parameters: - $ref: '#/components/parameters/ml.predict___path.algorithm_name' - $ref: '#/components/parameters/ml.predict___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.predict' responses: '200': $ref: '#/components/responses/ml.predict___200' /_plugins/_ml/_train_predict/{algorithm_name}: post: operationId: ml.train_predict.0 x-operation-group: ml.train_predict x-version-added: '1.3' description: Trains a model and predicts against the same training dataset. parameters: - $ref: '#/components/parameters/ml.train_predict___path.algorithm_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.train_predict' responses: '200': $ref: '#/components/responses/ml.train_predict___200' /_plugins/_ml/_train/{algorithm_name}: post: operationId: ml.train.0 x-operation-group: ml.train x-version-added: '1.3' description: Trains a model synchronously. parameters: - $ref: '#/components/parameters/ml.train___path.algorithm_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.train' responses: '200': $ref: '#/components/responses/ml.train___200' /_plugins/_ml/{node_id}/stats: get: operationId: ml.get_stats.2 x-operation-group: ml.get_stats x-version-added: '1.3' description: Get stats. parameters: - $ref: '#/components/parameters/ml.get_stats___path.node_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_stats___200' /_plugins/_ml/{node_id}/stats/{stat}: get: operationId: ml.get_stats.3 x-operation-group: ml.get_stats x-version-added: '1.3' description: Get stats. parameters: - $ref: '#/components/parameters/ml.get_stats___path.node_id' - $ref: '#/components/parameters/ml.get_stats___path.stat' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_stats___200' /_plugins/_ml/agents/_register: post: operationId: ml.register_agents.0 x-operation-group: ml.register_agents x-version-added: '2.13' description: Register an agent. requestBody: $ref: '#/components/requestBodies/ml.register_agents' responses: '200': $ref: '#/components/responses/ml.register_agents___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/agents/_search: get: operationId: ml.search_agents.0 x-operation-group: ml.search_agents x-version-added: '2.13' description: Search agents. requestBody: $ref: '#/components/requestBodies/ml.search_agents' responses: '200': $ref: '#/components/responses/ml.search_agents___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_agents.1 x-operation-group: ml.search_agents description: Search agents. x-version-added: '2.13' requestBody: $ref: '#/components/requestBodies/ml.search_agents' responses: '200': $ref: '#/components/responses/ml.search_agents___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/agents/{agent_id}: delete: operationId: ml.delete_agent.0 x-operation-group: ml.delete_agent x-version-added: '2.13' description: Delete an agent. parameters: - $ref: '#/components/parameters/ml.delete_agent___path.agent_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_agent___200' get: operationId: ml.get_agent.0 x-operation-group: ml.get_agent x-version-added: '2.13' description: Get an agent. parameters: - $ref: '#/components/parameters/ml.get_agent___path.agent_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_agent___200' /_plugins/_ml/agents/{agent_id}/_execute: post: operationId: ml.execute_agent.0 x-operation-group: ml.execute_agent x-version-added: '2.13' description: Execute an agent. parameters: - $ref: '#/components/parameters/ml.execute_agent___path.agent_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.execute_agent' responses: '200': $ref: '#/components/responses/ml.execute_agent___200' /_plugins/_ml/agents/{agent_id}/_execute/stream: post: operationId: ml.execute_agent_stream.0 x-operation-group: ml.execute_agent_stream x-version-added: '3.3' description: Execute an agent in streaming mode. parameters: - $ref: '#/components/parameters/ml.execute_agent_stream___path.agent_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.execute_agent_stream' responses: '200': $ref: '#/components/responses/ml.execute_agent_stream___200' /_plugins/_ml/connectors/_create: post: operationId: ml.create_connector.0 x-operation-group: ml.create_connector description: Creates a standalone connector. requestBody: $ref: '#/components/requestBodies/ml.create_connector' responses: '200': $ref: '#/components/responses/ml.create_connector___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/connectors/_search: get: operationId: ml.search_connectors.0 x-operation-group: ml.search_connectors x-version-added: '2.11' description: Searches for standalone connectors. requestBody: $ref: '#/components/requestBodies/ml.search_connectors' responses: '200': $ref: '#/components/responses/ml.search_connectors___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_connectors.1 x-operation-group: ml.search_connectors x-version-added: '2.11' description: Searches for standalone connectors. requestBody: $ref: '#/components/requestBodies/ml.search_connectors' responses: '200': $ref: '#/components/responses/ml.search_connectors___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/connectors/{connector_id}: delete: operationId: ml.delete_connector.0 x-operation-group: ml.delete_connector description: Deletes a standalone connector. parameters: - $ref: '#/components/parameters/ml.delete_connector___path.connector_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_connector___200' get: operationId: ml.get_connector.0 x-operation-group: ml.get_connector x-version-added: '2.11' description: Retrieves a standalone connector. parameters: - $ref: '#/components/parameters/ml.get_connector___path.connector_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_connector___200' put: operationId: ml.update_connector.0 x-operation-group: ml.update_connector x-version-added: '2.12' description: Updates a standalone connector. parameters: - $ref: '#/components/parameters/ml.update_connector___path.connector_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_connector' responses: '200': $ref: '#/components/responses/ml.update_connector___200' /_plugins/_ml/controllers/{model_id}: delete: operationId: ml.delete_controller.0 x-operation-group: ml.delete_controller x-version-added: '2.12' description: Deletes a controller. parameters: - $ref: '#/components/parameters/ml.delete_controller___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_controller___200' get: operationId: ml.get_controller.0 x-operation-group: ml.get_controller x-version-added: '2.12' description: Retrieves a controller. parameters: - $ref: '#/components/parameters/ml.get_controller___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_controller___200' post: operationId: ml.create_controller.0 x-operation-group: ml.create_controller x-version-added: '2.12' description: Creates a controller. requestBody: $ref: '#/components/requestBodies/ml.create_controller' parameters: - $ref: '#/components/parameters/ml.create_controller___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.create_controller___200' put: operationId: ml.update_controller.0 x-operation-group: ml.update_controller x-version-added: '2.12' description: Updates a controller. requestBody: $ref: '#/components/requestBodies/ml.update_controller' parameters: - $ref: '#/components/parameters/ml.update_controller___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.update_controller___200' /_plugins/_ml/memory: get: operationId: ml.get_all_memories.0 x-operation-group: ml.get_all_memories x-version-added: '2.12' description: Get all memories. parameters: - $ref: '#/components/parameters/ml.get_all_memories___query.max_results' - $ref: '#/components/parameters/ml.get_all_memories___query.next_token' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_all_memories___200' post: operationId: ml.create_memory.0 x-operation-group: ml.create_memory x-version-added: '2.12' description: Create a memory. requestBody: $ref: '#/components/requestBodies/ml.create_memory' responses: '200': $ref: '#/components/responses/ml.create_memory___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/memory_containers/_create: post: operationId: ml.create_memory_container.0 x-operation-group: ml.create_memory_container x-version-added: '3.3' description: Create a memory container. requestBody: $ref: '#/components/requestBodies/ml.create_memory_container' responses: '200': $ref: '#/components/responses/ml.create_memory_container___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/memory_containers/_search: get: operationId: ml.search_memory_container.1 x-operation-group: ml.search_memory_container x-version-added: '3.3' description: Search memory containers. requestBody: $ref: '#/components/requestBodies/ml.search_memory_container' responses: '200': $ref: '#/components/responses/ml.search_memory_container___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_memory_container.0 x-operation-group: ml.search_memory_container x-version-added: '3.3' description: Search memory containers. requestBody: $ref: '#/components/requestBodies/ml.search_memory_container' responses: '200': $ref: '#/components/responses/ml.search_memory_container___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/memory_containers/{memory_container_id}: delete: operationId: ml.delete_memory_container.0 x-operation-group: ml.delete_memory_container x-version-added: '3.3' description: Delete a memory container. parameters: - $ref: '#/components/parameters/ml.delete_memory_container___path.memory_container_id' - $ref: '#/components/parameters/ml.delete_memory_container___query.delete_all_memories' - $ref: '#/components/parameters/ml.delete_memory_container___query.delete_memories' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_memory_container___200' get: operationId: ml.get_memory_container.0 x-operation-group: ml.get_memory_container x-version-added: '3.3' description: Get a memory container. parameters: - $ref: '#/components/parameters/ml.get_memory_container___path.memory_container_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_memory_container___200' put: operationId: ml.update_memory_container.0 x-operation-group: ml.update_memory_container x-version-added: '3.3' description: Update a memory container. parameters: - $ref: '#/components/parameters/ml.update_memory_container___path.memory_container_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_memory_container' responses: '200': $ref: '#/components/responses/ml.update_memory_container___200' /_plugins/_ml/memory_containers/{memory_container_id}/memories: post: operationId: ml.add_agentic_memory.0 x-operation-group: ml.add_agentic_memory x-version-added: '3.3' description: Add agentic memory to a memory container. parameters: - $ref: '#/components/parameters/ml.add_agentic_memory___path.memory_container_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.add_agentic_memory' responses: '200': $ref: '#/components/responses/ml.add_agentic_memory___200' /_plugins/_ml/memory_containers/{memory_container_id}/memories/{type}/_delete_by_query: post: operationId: ml.delete_agentic_memory_query.0 x-operation-group: ml.delete_agentic_memory_query x-version-added: '3.3' description: Delete multiple memories using a query to match specific criteria. parameters: - $ref: '#/components/parameters/ml.delete_agentic_memory_query___path.memory_container_id' - $ref: '#/components/parameters/ml.delete_agentic_memory_query___path.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.delete_agentic_memory_query' responses: '200': $ref: '#/components/responses/ml.delete_agentic_memory_query___200' /_plugins/_ml/memory_containers/{memory_container_id}/memories/{type}/_search: get: operationId: ml.search_agentic_memory.0 x-operation-group: ml.search_agentic_memory x-version-added: '3.3' description: Search for memories of a specific type within a memory container. parameters: - $ref: '#/components/parameters/ml.search_agentic_memory___path.memory_container_id' - $ref: '#/components/parameters/ml.search_agentic_memory___path.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.search_agentic_memory' responses: '200': $ref: '#/components/responses/ml.search_agentic_memory___200' /_plugins/_ml/memory_containers/{memory_container_id}/memories/{type}/{id}: delete: operationId: ml.delete_agentic_memory.0 x-operation-group: ml.delete_agentic_memory x-version-added: '3.3' description: Delete a specific memory by its type and ID. parameters: - $ref: '#/components/parameters/ml.delete_agentic_memory___path.id' - $ref: '#/components/parameters/ml.delete_agentic_memory___path.memory_container_id' - $ref: '#/components/parameters/ml.delete_agentic_memory___path.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_agentic_memory___200' get: operationId: ml.get_agentic_memory.0 x-operation-group: ml.get_agentic_memory x-version-added: '3.3' description: Get a specific memory by its type and ID. parameters: - $ref: '#/components/parameters/ml.get_agentic_memory___path.id' - $ref: '#/components/parameters/ml.get_agentic_memory___path.memory_container_id' - $ref: '#/components/parameters/ml.get_agentic_memory___path.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_agentic_memory___200' put: operationId: ml.update_agentic_memory.0 x-operation-group: ml.update_agentic_memory x-version-added: '3.3' description: Update a specific memory by its type and ID. parameters: - $ref: '#/components/parameters/ml.update_agentic_memory___path.id' - $ref: '#/components/parameters/ml.update_agentic_memory___path.memory_container_id' - $ref: '#/components/parameters/ml.update_agentic_memory___path.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_agentic_memory' responses: '200': $ref: '#/components/responses/ml.update_agentic_memory___200' /_plugins/_ml/memory_containers/{memory_container_id}/memories/sessions: post: operationId: ml.create_memory_container_session.0 x-operation-group: ml.create_memory_container_session x-version-added: '3.3' description: Create session in a memory container. parameters: - $ref: '#/components/parameters/ml.create_memory_container_session___path.memory_container_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.create_memory_container_session' responses: '200': $ref: '#/components/responses/ml.create_memory_container_session___200' /_plugins/_ml/memory/_search: get: operationId: ml.search_memory.0 x-operation-group: ml.search_memory x-version-added: '2.12' description: Search memory. requestBody: $ref: '#/components/requestBodies/ml.search_memory' responses: '200': $ref: '#/components/responses/ml.search_memory___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_memory.1 x-operation-group: ml.search_memory x-version-added: '2.12' description: Search memory. requestBody: $ref: '#/components/requestBodies/ml.search_memory' responses: '200': $ref: '#/components/responses/ml.search_memory___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/memory/{memory_id}: delete: operationId: ml.delete_memory.0 x-operation-group: ml.delete_memory x-version-added: '2.12' description: Delete a memory. parameters: - $ref: '#/components/parameters/ml.delete_memory___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_memory___200' get: operationId: ml.get_memory.0 x-operation-group: ml.get_memory x-version-added: '2.12' description: Get a memory. parameters: - $ref: '#/components/parameters/ml.get_memory___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_memory___200' put: operationId: ml.update_memory.0 x-operation-group: ml.update_memory x-version-added: '2.12' description: Update a memory. parameters: - $ref: '#/components/parameters/ml.update_memory___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_memory' responses: '200': $ref: '#/components/responses/ml.update_memory___200' /_plugins/_ml/memory/{memory_id}/_search: get: operationId: ml.search_message.0 x-operation-group: ml.search_message x-version-added: '2.12' description: Search messages. parameters: - $ref: '#/components/parameters/ml.search_message___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.search_message' responses: '200': $ref: '#/components/responses/ml.search_message___200' post: operationId: ml.search_message.1 x-operation-group: ml.search_message x-version-added: '2.12' description: Search messages. parameters: - $ref: '#/components/parameters/ml.search_message___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.search_message' responses: '200': $ref: '#/components/responses/ml.search_message___200' /_plugins/_ml/memory/{memory_id}/messages: get: operationId: ml.get_all_messages.0 x-operation-group: ml.get_all_messages x-version-added: '2.12' description: Get all messages in a memory. parameters: - $ref: '#/components/parameters/ml.get_all_messages___path.memory_id' - $ref: '#/components/parameters/ml.get_all_messages___query.max_results' - $ref: '#/components/parameters/ml.get_all_messages___query.next_token' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_all_messages___200' post: operationId: ml.create_message.0 x-operation-group: ml.create_message x-version-added: '2.12' description: Create a message. parameters: - $ref: '#/components/parameters/ml.create_message___path.memory_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.create_message' responses: '200': $ref: '#/components/responses/ml.create_message___200' /_plugins/_ml/memory/message/{message_id}: get: operationId: ml.get_message.0 x-operation-group: ml.get_message x-version-added: '2.12' description: Get a message. parameters: - $ref: '#/components/parameters/ml.get_message___path.message_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_message___200' put: operationId: ml.update_message.0 x-operation-group: ml.update_message x-version-added: '2.12' description: Update a message. parameters: - $ref: '#/components/parameters/ml.update_message___path.message_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_message' responses: '200': $ref: '#/components/responses/ml.update_message___200' /_plugins/_ml/memory/message/{message_id}/traces: get: operationId: ml.get_message_traces.0 x-operation-group: ml.get_message_traces x-version-added: '2.12' description: Get a message traces. parameters: - $ref: '#/components/parameters/ml.get_message_traces___path.message_id' - $ref: '#/components/parameters/ml.get_message_traces___query.max_results' - $ref: '#/components/parameters/ml.get_message_traces___query.next_token' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_message_traces___200' /_plugins/_ml/model_groups/_register: post: operationId: ml.register_model_group.0 x-operation-group: ml.register_model_group description: Registers a model group. requestBody: $ref: '#/components/requestBodies/ml.register_model_group' responses: '200': $ref: '#/components/responses/ml.register_model_group___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/model_groups/_search: get: operationId: ml.search_model_group.0 x-operation-group: ml.search_model_group x-version-added: '2.9' description: Searches for model groups. requestBody: $ref: '#/components/requestBodies/ml.search_model_group' responses: '200': $ref: '#/components/responses/ml.search_model_group___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_model_group.1 x-operation-group: ml.search_model_group x-version-added: '2.9' description: Searches for model groups. requestBody: $ref: '#/components/requestBodies/ml.search_model_group' responses: '200': $ref: '#/components/responses/ml.search_model_group___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/model_groups/{model_group_id}: delete: operationId: ml.delete_model_group.0 x-operation-group: ml.delete_model_group description: Deletes a model group. parameters: - $ref: '#/components/parameters/ml.delete_model_group___path.model_group_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_model_group___200' get: operationId: ml.get_model_group.0 x-operation-group: ml.get_model_group description: Retrieves a model group. parameters: - $ref: '#/components/parameters/ml.get_model_group___path.model_group_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_model_group___200' put: operationId: ml.update_model_group.0 x-operation-group: ml.update_model_group x-version-added: '2.9' description: Updates a model group. parameters: - $ref: '#/components/parameters/ml.update_model_group___path.model_group_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_model_group' responses: '200': $ref: '#/components/responses/ml.update_model_group___200' /_plugins/_ml/models/_register: post: operationId: ml.register_model.0 x-operation-group: ml.register_model x-version-added: '2.7' description: Registers a model. requestBody: $ref: '#/components/requestBodies/ml.register_model' responses: '200': $ref: '#/components/responses/ml.register_model___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_register_meta: post: operationId: ml.register_model_meta.0 x-operation-group: ml.register_model_meta x-version-added: '2.7' description: Registers model metadata. requestBody: $ref: '#/components/requestBodies/ml.register_model_meta' responses: '200': $ref: '#/components/responses/ml.register_model_meta___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_search: get: operationId: ml.search_models.0 x-operation-group: ml.search_models x-version-added: '1.3' description: Searches for models. requestBody: $ref: '#/components/requestBodies/ml.search_models' responses: '200': $ref: '#/components/responses/ml.search_models___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_models.1 x-operation-group: ml.search_models x-version-added: '1.3' description: Searches for models. requestBody: $ref: '#/components/requestBodies/ml.search_models' responses: '200': $ref: '#/components/responses/ml.search_models___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_undeploy: post: operationId: ml.undeploy_model.1 x-operation-group: ml.undeploy_model x-version-added: '2.7' description: Undeploys a model. requestBody: $ref: '#/components/requestBodies/ml.undeploy_model' responses: '200': $ref: '#/components/responses/ml.undeploy_model___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_unload: post: operationId: ml.unload_model.1 x-operation-group: ml.unload_model deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `undeploy_model` instead. description: Unloads a model. requestBody: $ref: '#/components/requestBodies/ml.unload_model' responses: '200': $ref: '#/components/responses/ml.unload_model___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_upload: post: operationId: ml.upload_model.0 x-operation-group: ml.upload_model deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `register_model` instead. description: Registers a model. requestBody: $ref: '#/components/requestBodies/ml.upload_model' responses: '200': $ref: '#/components/responses/ml.upload_model___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/{model_id}: delete: operationId: ml.delete_model.0 x-operation-group: ml.delete_model x-version-added: '1.3' description: Deletes a model. parameters: - $ref: '#/components/parameters/ml.delete_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_model___200' get: operationId: ml.get_model.0 x-operation-group: ml.get_model x-version-added: '1.3' description: Retrieves a model. parameters: - $ref: '#/components/parameters/ml.get_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_model___200' put: operationId: ml.update_model.0 x-operation-group: ml.update_model x-version-added: '2.12' description: Updates a model. parameters: - $ref: '#/components/parameters/ml.update_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.update_model' responses: '200': $ref: '#/components/responses/ml.update_model___200' /_plugins/_ml/models/{model_id}/_deploy: post: operationId: ml.deploy_model.0 x-operation-group: ml.deploy_model x-version-added: '2.7' description: Deploys a model. parameters: - $ref: '#/components/parameters/ml.deploy_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.deploy_model___200' /_plugins/_ml/models/{model_id}/_load: post: operationId: ml.load_model.0 x-operation-group: ml.load_model deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `deploy_model` instead. description: Deploys a model. parameters: - $ref: '#/components/parameters/ml.load_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.load_model___200' /_plugins/_ml/models/{model_id}/_predict: post: operationId: ml.predict_model.0 x-operation-group: ml.predict_model x-version-added: '2.12' description: Predicts a model. parameters: - $ref: '#/components/parameters/ml.predict_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.predict_model' responses: '200': $ref: '#/components/responses/ml.predict_model___200' /_plugins/_ml/models/{model_id}/_predict/stream: post: operationId: ml.predict_model_stream.0 x-operation-group: ml.predict_model_stream x-version-added: '3.3' description: Predicts a model in streaming mode. parameters: - $ref: '#/components/parameters/ml.predict_model_stream___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.predict_model_stream' responses: '200': $ref: '#/components/responses/ml.predict_model_stream___200' /_plugins/_ml/models/{model_id}/_undeploy: post: operationId: ml.undeploy_model.0 x-operation-group: ml.undeploy_model x-version-added: '2.7' description: Undeploys a model. parameters: - $ref: '#/components/parameters/ml.undeploy_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.undeploy_model' responses: '200': $ref: '#/components/responses/ml.undeploy_model___200' /_plugins/_ml/models/{model_id}/_unload: post: operationId: ml.unload_model.0 x-operation-group: ml.unload_model deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `undeploy_model` instead. description: Unloads a model. parameters: - $ref: '#/components/parameters/ml.unload_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.unload_model' responses: '200': $ref: '#/components/responses/ml.unload_model___200' /_plugins/_ml/models/{model_id}/chunk/{chunk_number}: post: operationId: ml.chunk_model.0 x-operation-group: ml.chunk_model deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `upload_chunk` instead. description: Uploads model chunk. parameters: - $ref: '#/components/parameters/ml.chunk_model___path.chunk_number' - $ref: '#/components/parameters/ml.chunk_model___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.chunk_model' responses: '200': $ref: '#/components/responses/ml.chunk_model___200' /_plugins/_ml/models/{model_id}/upload_chunk/{chunk_number}: post: operationId: ml.upload_chunk.0 x-operation-group: ml.upload_chunk x-version-added: '2.7' description: Uploads model chunk. parameters: - $ref: '#/components/parameters/ml.upload_chunk___path.chunk_number' - $ref: '#/components/parameters/ml.upload_chunk___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.upload_chunk' responses: '200': $ref: '#/components/responses/ml.upload_chunk___200' /_plugins/_ml/models/meta: post: operationId: ml.create_model_meta.0 x-operation-group: ml.create_model_meta deprecated: true x-version-deprecated: '2.7' x-deprecation-message: Use `_register_meta` instead. description: Registers model metadata. requestBody: $ref: '#/components/requestBodies/ml.create_model_meta' responses: '200': $ref: '#/components/responses/ml.create_model_meta___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/profile: get: operationId: ml.get_profile.0 x-operation-group: ml.get_profile x-version-added: '2.4' description: Get a profile. requestBody: $ref: '#/components/requestBodies/ml.get_profile' responses: '200': $ref: '#/components/responses/ml.get_profile___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/profile/models: get: operationId: ml.get_profile_models.0 x-operation-group: ml.get_profile_models x-version-added: '2.4' description: Get a profile models. requestBody: $ref: '#/components/requestBodies/ml.get_profile_models' responses: '200': $ref: '#/components/responses/ml.get_profile_models___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/profile/models/{model_id}: get: operationId: ml.get_profile_models.1 x-operation-group: ml.get_profile_models x-version-added: '2.11' description: Get a profile models. requestBody: $ref: '#/components/requestBodies/ml.get_profile_models' parameters: - $ref: '#/components/parameters/ml.get_profile_models___path.model_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_profile_models___200' /_plugins/_ml/profile/tasks: get: operationId: ml.get_profile_tasks.0 x-operation-group: ml.get_profile_tasks x-version-added: '2.4' description: Get a profile tasks. requestBody: $ref: '#/components/requestBodies/ml.get_profile_tasks' responses: '200': $ref: '#/components/responses/ml.get_profile_tasks___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/profile/tasks/{task_id}: get: operationId: ml.get_profile_tasks.1 x-operation-group: ml.get_profile_tasks x-version-added: '2.11' description: Get a profile tasks. requestBody: $ref: '#/components/requestBodies/ml.get_profile_tasks' parameters: - $ref: '#/components/parameters/ml.get_profile_tasks___path.task_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_profile_tasks___200' /_plugins/_ml/stats: get: operationId: ml.get_stats.0 x-operation-group: ml.get_stats x-version-added: '1.3' description: Get stats. responses: '200': $ref: '#/components/responses/ml.get_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/stats/{stat}: get: operationId: ml.get_stats.1 x-operation-group: ml.get_stats x-version-added: '1.3' description: Get stats. parameters: - $ref: '#/components/parameters/ml.get_stats___path.stat' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_stats___200' /_plugins/_ml/tasks/_search: get: operationId: ml.search_tasks.0 x-operation-group: ml.search_tasks x-version-added: '1.3' description: Searches for tasks. requestBody: $ref: '#/components/requestBodies/ml.search_tasks' responses: '200': $ref: '#/components/responses/ml.search_tasks___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: ml.search_tasks.1 x-operation-group: ml.search_tasks x-version-added: '1.3' description: Searches for tasks. requestBody: $ref: '#/components/requestBodies/ml.search_tasks' responses: '200': $ref: '#/components/responses/ml.search_tasks___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/tasks/{task_id}: delete: operationId: ml.delete_task.0 x-operation-group: ml.delete_task x-version-added: '1.3' description: Deletes a task. parameters: - $ref: '#/components/parameters/ml.delete_task___path.task_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.delete_task___200' get: operationId: ml.get_task.0 x-operation-group: ml.get_task x-version-added: '1.3' description: Retrieves a task. parameters: - $ref: '#/components/parameters/ml.get_task___path.task_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_task___200' /_plugins/_ml/tools: get: operationId: ml.get_all_tools.0 x-operation-group: ml.get_all_tools x-version-added: '2.12' description: Get tools. responses: '200': $ref: '#/components/responses/ml.get_all_tools___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/tools/_execute/{tool_name}: post: operationId: ml.execute_tool.0 x-operation-group: ml.execute_tool x-version-added: '3.3' description: Execute a tool. parameters: - $ref: '#/components/parameters/ml.execute_tool___path.tool_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ml.execute_tool' responses: '200': $ref: '#/components/responses/ml.execute_tool___200' /_plugins/_ml/tools/{tool_name}: get: operationId: ml.get_tool.0 x-operation-group: ml.get_tool x-version-added: '2.12' description: Get tools. parameters: - $ref: '#/components/parameters/ml.get_tool___path.tool_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ml.get_tool___200' /_plugins/_neural/{node_id}/stats: get: operationId: neural.stats.2 x-operation-group: neural.stats x-version-added: '3.0' description: Provides information about the current status of the neural-search plugin. parameters: - $ref: '#/components/parameters/neural.stats___path.node_id' - $ref: '#/components/parameters/neural.stats___query.flat_stat_paths' - $ref: '#/components/parameters/neural.stats___query.include_all_nodes' - $ref: '#/components/parameters/neural.stats___query.include_individual_nodes' - $ref: '#/components/parameters/neural.stats___query.include_info' - $ref: '#/components/parameters/neural.stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/neural.stats___200' /_plugins/_neural/{node_id}/stats/{stat}: get: operationId: neural.stats.3 x-operation-group: neural.stats x-version-added: '3.0' description: Provides information about the current status of the neural-search plugin. parameters: - $ref: '#/components/parameters/neural.stats___path.node_id' - $ref: '#/components/parameters/neural.stats___path.stat' - $ref: '#/components/parameters/neural.stats___query.flat_stat_paths' - $ref: '#/components/parameters/neural.stats___query.include_all_nodes' - $ref: '#/components/parameters/neural.stats___query.include_individual_nodes' - $ref: '#/components/parameters/neural.stats___query.include_info' - $ref: '#/components/parameters/neural.stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/neural.stats___200' /_plugins/_neural/stats: get: operationId: neural.stats.0 x-operation-group: neural.stats x-version-added: '3.0' description: Provides information about the current status of the neural-search plugin. parameters: - $ref: '#/components/parameters/neural.stats___query.flat_stat_paths' - $ref: '#/components/parameters/neural.stats___query.include_all_nodes' - $ref: '#/components/parameters/neural.stats___query.include_individual_nodes' - $ref: '#/components/parameters/neural.stats___query.include_info' - $ref: '#/components/parameters/neural.stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/neural.stats___200' /_plugins/_neural/stats/{stat}: get: operationId: neural.stats.1 x-operation-group: neural.stats x-version-added: '3.0' description: Provides information about the current status of the neural-search plugin. parameters: - $ref: '#/components/parameters/neural.stats___path.stat' - $ref: '#/components/parameters/neural.stats___query.flat_stat_paths' - $ref: '#/components/parameters/neural.stats___query.include_all_nodes' - $ref: '#/components/parameters/neural.stats___query.include_individual_nodes' - $ref: '#/components/parameters/neural.stats___query.include_info' - $ref: '#/components/parameters/neural.stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/neural.stats___200' /_plugins/_notifications/channels: get: operationId: notifications.list_channels.0 x-operation-group: notifications.list_channels x-version-added: '2.0' description: List created notification channels. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels responses: '200': $ref: '#/components/responses/notifications.list_channels___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_notifications/configs: delete: operationId: notifications.delete_configs.0 x-operation-group: notifications.delete_configs x-version-added: '2.2' description: Delete multiple channel configurations. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: - $ref: '#/components/parameters/notifications.delete_configs___query.config_id' - $ref: '#/components/parameters/notifications.delete_configs___query.config_id_list' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/notifications.delete_configs___200' get: operationId: notifications.get_configs.0 x-operation-group: notifications.get_configs x-version-added: '2.0' description: Get multiple channel configurations with filtering. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-configurations parameters: - $ref: '#/components/parameters/notifications.get_configs___query.chime.url' - $ref: '#/components/parameters/notifications.get_configs___query.chime.url.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.config_id' - $ref: '#/components/parameters/notifications.get_configs___query.config_id_list' - $ref: '#/components/parameters/notifications.get_configs___query.config_type' - $ref: '#/components/parameters/notifications.get_configs___query.created_time_ms' - $ref: '#/components/parameters/notifications.get_configs___query.description' - $ref: '#/components/parameters/notifications.get_configs___query.description.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.email.email_account_id' - $ref: '#/components/parameters/notifications.get_configs___query.email.email_group_id_list' - $ref: '#/components/parameters/notifications.get_configs___query.email.recipient_list.recipient' - $ref: '#/components/parameters/notifications.get_configs___query.email.recipient_list.recipient.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.email_group.recipient_list.recipient' - $ref: '#/components/parameters/notifications.get_configs___query.email_group.recipient_list.recipient.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.is_enabled' - $ref: '#/components/parameters/notifications.get_configs___query.last_updated_time_ms' - $ref: '#/components/parameters/notifications.get_configs___query.microsoft_teams.url' - $ref: '#/components/parameters/notifications.get_configs___query.microsoft_teams.url.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.name' - $ref: '#/components/parameters/notifications.get_configs___query.name.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.query' - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.from_address' - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.from_address.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.region' - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.role_arn' - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.role_arn.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.slack.url' - $ref: '#/components/parameters/notifications.get_configs___query.slack.url.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.from_address' - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.from_address.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.host' - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.host.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.method' - $ref: '#/components/parameters/notifications.get_configs___query.sns.role_arn' - $ref: '#/components/parameters/notifications.get_configs___query.sns.role_arn.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.sns.topic_arn' - $ref: '#/components/parameters/notifications.get_configs___query.sns.topic_arn.keyword' - $ref: '#/components/parameters/notifications.get_configs___query.text_query' - $ref: '#/components/parameters/notifications.get_configs___query.webhook.url' - $ref: '#/components/parameters/notifications.get_configs___query.webhook.url.keyword' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/notifications.get_configs' responses: '200': $ref: '#/components/responses/notifications.get_configs___200' post: operationId: notifications.create_config.0 x-operation-group: notifications.create_config x-version-added: '2.0' description: Create channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration requestBody: $ref: '#/components/requestBodies/notifications.create_config' responses: '200': $ref: '#/components/responses/notifications.create_config___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_notifications/configs/{config_id}: delete: operationId: notifications.delete_config.0 x-operation-group: notifications.delete_config x-version-added: '2.0' description: Delete a channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: - $ref: '#/components/parameters/notifications.delete_config___path.config_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/notifications.delete_config___200' get: operationId: notifications.get_config.0 x-operation-group: notifications.get_config x-version-added: '2.0' description: Get a specific channel configuration. parameters: - $ref: '#/components/parameters/notifications.get_config___path.config_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/notifications.get_config___200' put: operationId: notifications.update_config.0 x-operation-group: notifications.update_config x-version-added: '2.0' description: Update channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration parameters: - $ref: '#/components/parameters/notifications.update_config___path.config_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/notifications.update_config' responses: '200': $ref: '#/components/responses/notifications.update_config___200' /_plugins/_notifications/feature/test/{config_id}: get: operationId: notifications.send_test.0 x-operation-group: notifications.send_test deprecated: true x-deprecation-message: Use the POST method instead. x-version-added: '2.0' x-version-deprecated: '2.3' description: Send a test notification. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: - $ref: '#/components/parameters/notifications.send_test___path.config_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/notifications.send_test___200' post: operationId: notifications.send_test.1 x-operation-group: notifications.send_test x-version-added: '2.0' description: Send a test notification. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: - $ref: '#/components/parameters/notifications.send_test___path.config_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/notifications.send_test___200' /_plugins/_notifications/features: get: operationId: notifications.list_features.0 x-operation-group: notifications.list_features x-version-added: '2.0' description: List supported channel configurations. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations responses: '200': $ref: '#/components/responses/notifications.list_features___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_observability/_local/stats: get: operationId: observability.get_localstats.0 x-operation-group: observability.get_localstats x-version-added: '2.5' description: Retrieves local stats of all observability objects. responses: '200': $ref: '#/components/responses/observability.get_localstats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_observability/object: delete: operationId: observability.delete_objects.0 x-operation-group: observability.delete_objects x-version-added: '1.1' description: Deletes specific observability objects specified by ID or a list of IDs. parameters: - $ref: '#/components/parameters/observability.delete_objects___query.objectId' - $ref: '#/components/parameters/observability.delete_objects___query.objectIdList' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/observability.delete_objects___200' '404': $ref: '#/components/responses/observability.delete_objects___404' get: operationId: observability.list_objects.0 x-operation-group: observability.list_objects x-version-added: '1.1' description: Retrieves list of all observability objects. responses: '200': $ref: '#/components/responses/observability.list_objects___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: observability.create_object.0 x-operation-group: observability.create_object x-version-added: '1.1' description: Creates a new observability object. requestBody: $ref: '#/components/requestBodies/observability.create_object' responses: '200': $ref: '#/components/responses/observability.create_object___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_observability/object/{object_id}: delete: operationId: observability.delete_object.0 x-operation-group: observability.delete_object x-version-added: '1.1' description: Deletes specific observability object specified by ID. parameters: - $ref: '#/components/parameters/observability.delete_object___path.object_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/observability.delete_object___200' '404': $ref: '#/components/responses/observability.delete_object___404' get: operationId: observability.get_object.0 x-operation-group: observability.get_object x-version-added: '1.1' description: Retrieves specific observability object specified by ID. parameters: - $ref: '#/components/parameters/observability.get_object___path.object_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/observability.get_object___200' '404': $ref: '#/components/responses/observability.get_object___404' put: operationId: observability.update_object.0 x-operation-group: observability.update_object x-version-added: '1.1' description: Updates an existing observability object. parameters: - $ref: '#/components/parameters/observability.update_object___path.object_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/observability.update_object' responses: '200': $ref: '#/components/responses/observability.update_object___200' '404': $ref: '#/components/responses/observability.update_object___404' /_plugins/_ppl: post: operationId: ppl.query.0 x-operation-group: ppl.query x-version-added: '1.0' description: Executes a PPL query against OpenSearch indexes. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/ppl.query___query.format' - $ref: '#/components/parameters/ppl.query___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.query' responses: '200': $ref: '#/components/responses/ppl.query___200' /_plugins/_ppl/_explain: post: operationId: ppl.explain.0 x-operation-group: ppl.explain x-version-added: '1.0' description: Returns the execution plan for a PPL query. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/ppl.explain___query.format' - $ref: '#/components/parameters/ppl.explain___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.explain' responses: '200': $ref: '#/components/responses/ppl.explain___200' /_plugins/_ppl/stats: get: operationId: ppl.get_stats.0 x-operation-group: ppl.get_stats x-version-added: '1.0' description: Retrieves performance metrics for the PPL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/ppl.get_stats___query.format' - $ref: '#/components/parameters/ppl.get_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ppl.get_stats___200' post: operationId: ppl.post_stats.1 x-operation-group: ppl.post_stats x-version-added: '1.0' description: Retrieves filtered performance metrics for the PPL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/ppl.post_stats___query.format' - $ref: '#/components/parameters/ppl.post_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.post_stats' responses: '200': $ref: '#/components/responses/ppl.post_stats___200' /_plugins/_query/_datasources: get: operationId: query.datasources_list.0 x-operation-group: query.datasources_list x-version-added: '2.7' description: Retrieves a list of all available data sources. responses: '200': $ref: '#/components/responses/query.datasources_list___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: query.datasources_create.0 x-operation-group: query.datasources_create x-version-added: '2.7' description: Creates a new query data source. requestBody: $ref: '#/components/requestBodies/query.datasources_create' responses: '201': $ref: '#/components/responses/query.datasources_create___201' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: query.datasources_update.0 x-operation-group: query.datasources_update x-version-added: '2.7' description: Updates an existing query data source. requestBody: $ref: '#/components/requestBodies/query.datasources_update' responses: '200': $ref: '#/components/responses/query.datasources_update___200' '404': $ref: '#/components/responses/query.datasources_update___404' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_query/_datasources/{datasource_name}: delete: operationId: query.datasource_delete.0 x-operation-group: query.datasource_delete x-version-added: '2.7' description: Deletes a specific data source by name. parameters: - $ref: '#/components/parameters/query.datasource_delete___path.datasource_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '204': $ref: '#/components/responses/query.datasource_delete___204' '404': $ref: '#/components/responses/query.datasource_delete___404' get: operationId: query.datasource_retrieve.0 x-operation-group: query.datasource_retrieve x-version-added: '2.7' description: Retrieves a specific data source by name. parameters: - $ref: '#/components/parameters/query.datasource_retrieve___path.datasource_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/query.datasource_retrieve___200' '404': $ref: '#/components/responses/query.datasource_retrieve___404' /_plugins/_query/settings: put: operationId: sql.settings.0 x-operation-group: sql.settings x-version-added: '1.0' description: Updates SQL plugin settings in the OpenSearch cluster configuration. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ parameters: - $ref: '#/components/parameters/sql.settings___query.format' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.settings' responses: '200': $ref: '#/components/responses/sql.settings___200' /_plugins/_refresh_search_analyzers/{index}: post: operationId: ism.refresh_search_analyzers.0 x-operation-group: ism.refresh_search_analyzers description: Refreshes search analyzers in real time. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ parameters: - $ref: '#/components/parameters/ism.refresh_search_analyzers___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.refresh_search_analyzers___200' /_plugins/_replication/_autofollow: delete: operationId: replication.delete_replication_rule.0 x-operation-group: replication.delete_replication_rule x-version-added: '1.1' description: Deletes the specified replication rule. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#delete-replication-rule requestBody: $ref: '#/components/requestBodies/replication.delete_replication_rule' responses: '200': $ref: '#/components/responses/replication.delete_replication_rule___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: replication.create_replication_rule.0 x-operation-group: replication.create_replication_rule x-version-added: '1.1' description: Automatically starts the replication on indexes matching a specified pattern. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#create-replication-rule requestBody: $ref: '#/components/requestBodies/replication.create_replication_rule' responses: '200': $ref: '#/components/responses/replication.create_replication_rule___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_replication/{index}/_pause: post: operationId: replication.pause.0 x-operation-group: replication.pause x-version-added: '1.1' description: Pauses the replication of the leader index. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#pause-replication parameters: - $ref: '#/components/parameters/replication.pause___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/replication.pause' responses: '200': $ref: '#/components/responses/replication.pause___200' /_plugins/_replication/{index}/_resume: post: operationId: replication.resume.0 x-operation-group: replication.resume x-version-added: '1.1' description: Resumes replication of the leader index. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#resume-replication parameters: - $ref: '#/components/parameters/replication.resume___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/replication.resume' responses: '200': $ref: '#/components/responses/replication.resume___200' /_plugins/_replication/{index}/_start: put: operationId: replication.start.0 x-operation-group: replication.start x-version-added: '1.1' description: Initiates the replication of an index from the leader cluster to the follower cluster. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#start-replication parameters: - $ref: '#/components/parameters/replication.start___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/replication.start' responses: '200': $ref: '#/components/responses/replication.start___200' /_plugins/_replication/{index}/_status: get: operationId: replication.status.0 x-operation-group: replication.status x-version-added: '1.1' description: Retrieves the the status of an index replication. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-replication-status parameters: - $ref: '#/components/parameters/replication.status___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/replication.status___200' /_plugins/_replication/{index}/_stop: post: operationId: replication.stop.0 x-operation-group: replication.stop x-version-added: '1.1' description: Terminates the replication and converts the follower index to a standard index. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#stop-replication parameters: - $ref: '#/components/parameters/replication.stop___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/replication.stop' responses: '200': $ref: '#/components/responses/replication.stop___200' /_plugins/_replication/{index}/_update: put: operationId: replication.update_settings.0 x-operation-group: replication.update_settings x-version-added: '1.1' description: Updates any settings on the follower index. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#update-settings parameters: - $ref: '#/components/parameters/replication.update_settings___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/replication.update_settings' responses: '200': $ref: '#/components/responses/replication.update_settings___200' /_plugins/_replication/autofollow_stats: get: operationId: replication.autofollow_stats.0 x-operation-group: replication.autofollow_stats x-version-added: '1.1' description: Retrieves information about any auto-follow activity and any replication rules configured on the specified cluster. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-auto-follow-stats responses: '200': $ref: '#/components/responses/replication.autofollow_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_replication/follower_stats: get: operationId: replication.follower_stats.0 x-operation-group: replication.follower_stats x-version-added: '1.1' description: Retrieves information about any follower (syncing) indexes on a specified cluster. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-follower-cluster-stats responses: '200': $ref: '#/components/responses/replication.follower_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_replication/leader_stats: get: operationId: replication.leader_stats.0 x-operation-group: replication.leader_stats x-version-added: '1.1' description: Retrieves information about any replicated leader indexes on a specified cluster. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-leader-cluster-stats responses: '200': $ref: '#/components/responses/replication.leader_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_rollup/jobs/{id}: delete: operationId: rollups.delete.0 x-operation-group: rollups.delete x-version-added: '1.0' description: Deletes an index rollup job configuration. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job responses: '200': $ref: '#/components/responses/rollups.delete___200' parameters: - $ref: '#/components/parameters/rollups.delete___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' get: operationId: rollups.get.0 x-operation-group: rollups.get x-version-added: '1.0' description: Retrieves an index rollup job configuration by ID. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.get___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.get___200' put: operationId: rollups.put.0 x-operation-group: rollups.put x-version-added: '1.0' description: Creates or updates an index rollup job configuration. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: '201': $ref: '#/components/responses/rollups.put___201' parameters: - $ref: '#/components/parameters/rollups.put___path.id' - $ref: '#/components/parameters/rollups.put___query.if_primary_term' - $ref: '#/components/parameters/rollups.put___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rollups.put' /_plugins/_rollup/jobs/{id}/_explain: get: operationId: rollups.explain.0 x-operation-group: rollups.explain x-version-added: '1.0' description: Retrieves the execution status information for an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.explain___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.explain___200' /_plugins/_rollup/jobs/{id}/_start: post: operationId: rollups.start.0 x-operation-group: rollups.start x-version-added: '1.0' description: Starts the execution of an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.start___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.start___200' /_plugins/_rollup/jobs/{id}/_stop: post: operationId: rollups.stop.0 x-operation-group: rollups.stop x-version-added: '1.0' description: Stops the execution of an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.stop___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.stop___200' /_plugins/_search_relevance/{node_id}/stats: get: operationId: search_relevance.get_node_stats.0 x-operation-group: search_relevance.get_node_stats x-version-added: '3.1' description: Gets stats by node. parameters: - $ref: '#/components/parameters/search_relevance.get_node_stats___path.node_id' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.flat_stat_paths' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_all_nodes' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_individual_nodes' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_info' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_node_stats___200' /_plugins/_search_relevance/{node_id}/stats/{stat}: get: operationId: search_relevance.get_node_stats.1 x-operation-group: search_relevance.get_node_stats x-version-added: '3.1' description: Gets stats by node. parameters: - $ref: '#/components/parameters/search_relevance.get_node_stats___path.node_id' - $ref: '#/components/parameters/search_relevance.get_node_stats___path.stat' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.flat_stat_paths' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_all_nodes' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_individual_nodes' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_info' - $ref: '#/components/parameters/search_relevance.get_node_stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_node_stats___200' /_plugins/_search_relevance/experiments: get: operationId: search_relevance.get_experiments.0 x-operation-group: search_relevance.get_experiments x-version-added: '3.1' description: Gets experiments. responses: '200': $ref: '#/components/responses/search_relevance.get_experiments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: search_relevance.put_experiments.0 x-operation-group: search_relevance.put_experiments x-version-added: '3.1' description: Creates an experiment. requestBody: $ref: '#/components/requestBodies/search_relevance.put_experiments' responses: '200': $ref: '#/components/responses/search_relevance.put_experiments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_search_relevance/experiments/{experiment_id}: delete: operationId: search_relevance.delete_experiments.0 x-operation-group: search_relevance.delete_experiments x-version-added: '3.1' description: Deletes a specified experiment. parameters: - $ref: '#/components/parameters/search_relevance.delete_experiments___path.experiment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.delete_experiments___200' get: operationId: search_relevance.get_experiments.1 x-operation-group: search_relevance.get_experiments x-version-added: '3.1' description: Gets experiments. parameters: - $ref: '#/components/parameters/search_relevance.get_experiments___path.experiment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_experiments___200' /_plugins/_search_relevance/experiments/schedule: get: operationId: search_relevance.get_scheduled_experiments.0 x-operation-group: search_relevance.get_scheduled_experiments x-version-added: '3.4' description: Gets the scheduled experiments. responses: '200': $ref: '#/components/responses/search_relevance.get_scheduled_experiments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: search_relevance.post_scheduled_experiments.0 x-operation-group: search_relevance.post_scheduled_experiments x-version-added: '3.4' description: Creates a scheduled experiment. requestBody: $ref: '#/components/requestBodies/search_relevance.post_scheduled_experiments' responses: '200': $ref: '#/components/responses/search_relevance.post_scheduled_experiments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_search_relevance/experiments/schedule/{experiment_id}: delete: operationId: search_relevance.delete_scheduled_experiments.0 x-operation-group: search_relevance.delete_scheduled_experiments x-version-added: '3.4' description: Deletes a specified scheduled experiment. parameters: - $ref: '#/components/parameters/search_relevance.delete_scheduled_experiments___path.experiment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.delete_scheduled_experiments___200' get: operationId: search_relevance.get_scheduled_experiments.1 x-operation-group: search_relevance.get_scheduled_experiments x-version-added: '3.4' description: Gets the scheduled experiments. parameters: - $ref: '#/components/parameters/search_relevance.get_scheduled_experiments___path.experiment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_scheduled_experiments___200' /_plugins/_search_relevance/judgments: get: operationId: search_relevance.get_judgments.0 x-operation-group: search_relevance.get_judgments x-version-added: '3.1' description: Gets judgments. responses: '200': $ref: '#/components/responses/search_relevance.get_judgments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: search_relevance.put_judgments.0 x-operation-group: search_relevance.put_judgments x-version-added: '3.1' description: Creates a judgment. requestBody: description: The request body of the judgment to be created. $ref: '#/components/requestBodies/search_relevance.put_judgments' responses: '200': $ref: '#/components/responses/search_relevance.put_judgments___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_search_relevance/judgments/{judgment_id}: delete: operationId: search_relevance.delete_judgments.0 x-operation-group: search_relevance.delete_judgments x-version-added: '3.1' description: Deletes a specified judgment. parameters: - $ref: '#/components/parameters/search_relevance.delete_judgments___path.judgment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.delete_judgments___200' get: operationId: search_relevance.get_judgments.1 x-operation-group: search_relevance.get_judgments x-version-added: '3.1' description: Gets judgments. parameters: - $ref: '#/components/parameters/search_relevance.get_judgments___path.judgment_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_judgments___200' /_plugins/_search_relevance/query_sets: get: operationId: search_relevance.get_query_sets.0 x-operation-group: search_relevance.get_query_sets x-version-added: '3.1' description: Lists the current query sets available. responses: '200': $ref: '#/components/responses/search_relevance.get_query_sets___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: search_relevance.post_query_sets.0 x-operation-group: search_relevance.post_query_sets x-version-added: '3.1' description: Creates a new query set by sampling queries from the user behavior data. requestBody: $ref: '#/components/requestBodies/search_relevance.post_query_sets' responses: '200': $ref: '#/components/responses/search_relevance.post_query_sets___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: search_relevance.put_query_sets.0 x-operation-group: search_relevance.put_query_sets x-version-added: '3.1' description: Creates a new query set by uploading manually. requestBody: $ref: '#/components/requestBodies/search_relevance.put_query_sets' responses: '200': $ref: '#/components/responses/search_relevance.put_query_sets___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_search_relevance/query_sets/{query_set_id}: delete: operationId: search_relevance.delete_query_sets.0 x-operation-group: search_relevance.delete_query_sets x-version-added: '3.1' description: Deletes a query set. parameters: - $ref: '#/components/parameters/search_relevance.delete_query_sets___path.query_set_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.delete_query_sets___200' get: operationId: search_relevance.get_query_sets.1 x-operation-group: search_relevance.get_query_sets x-version-added: '3.1' description: Lists the current query sets available. parameters: - $ref: '#/components/parameters/search_relevance.get_query_sets___path.query_set_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_query_sets___200' /_plugins/_search_relevance/search_configurations: get: operationId: search_relevance.get_search_configurations.0 x-operation-group: search_relevance.get_search_configurations x-version-added: '3.1' description: Gets the search configurations. responses: '200': $ref: '#/components/responses/search_relevance.get_search_configurations___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: search_relevance.put_search_configurations.0 x-operation-group: search_relevance.put_search_configurations x-version-added: '3.1' description: Creates a search configuration. requestBody: $ref: '#/components/requestBodies/search_relevance.put_search_configurations' responses: '200': $ref: '#/components/responses/search_relevance.put_search_configurations___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_search_relevance/search_configurations/{search_configuration_id}: delete: operationId: search_relevance.delete_search_configurations.0 x-operation-group: search_relevance.delete_search_configurations x-version-added: '3.1' description: Deletes a specified search configuration. parameters: - $ref: '#/components/parameters/search_relevance.delete_search_configurations___path.search_configuration_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.delete_search_configurations___200' get: operationId: search_relevance.get_search_configurations.1 x-operation-group: search_relevance.get_search_configurations x-version-added: '3.1' description: Gets the search configurations. parameters: - $ref: '#/components/parameters/search_relevance.get_search_configurations___path.search_configuration_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_search_configurations___200' /_plugins/_search_relevance/stats: get: operationId: search_relevance.get_stats.0 x-operation-group: search_relevance.get_stats x-version-added: '3.1' description: Gets stats. parameters: - $ref: '#/components/parameters/search_relevance.get_stats___query.flat_stat_paths' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_all_nodes' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_individual_nodes' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_info' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_stats___200' /_plugins/_search_relevance/stats/{stat}: get: operationId: search_relevance.get_stats.1 x-operation-group: search_relevance.get_stats x-version-added: '3.1' description: Gets stats. parameters: - $ref: '#/components/parameters/search_relevance.get_stats___path.stat' - $ref: '#/components/parameters/search_relevance.get_stats___query.flat_stat_paths' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_all_nodes' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_individual_nodes' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_info' - $ref: '#/components/parameters/search_relevance.get_stats___query.include_metadata' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_relevance.get_stats___200' /_plugins/_security_analytics/alerts: get: operationId: security_analytics.get_alerts.0 x-operation-group: security_analytics.get_alerts x-version-added: '2.4' description: Retrieve alerts related to a specific detector type or detector ID. externalDocs: url: https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-alerts parameters: - $ref: '#/components/parameters/security_analytics.get_alerts___query.alertState' - $ref: '#/components/parameters/security_analytics.get_alerts___query.detectorType' - $ref: '#/components/parameters/security_analytics.get_alerts___query.detector_id' - $ref: '#/components/parameters/security_analytics.get_alerts___query.endTime' - $ref: '#/components/parameters/security_analytics.get_alerts___query.missing' - $ref: '#/components/parameters/security_analytics.get_alerts___query.searchString' - $ref: '#/components/parameters/security_analytics.get_alerts___query.severityLevel' - $ref: '#/components/parameters/security_analytics.get_alerts___query.size' - $ref: '#/components/parameters/security_analytics.get_alerts___query.sortOrder' - $ref: '#/components/parameters/security_analytics.get_alerts___query.sortString' - $ref: '#/components/parameters/security_analytics.get_alerts___query.startIndex' - $ref: '#/components/parameters/security_analytics.get_alerts___query.startTime' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security_analytics.get_alerts___200' /_plugins/_security_analytics/findings/_search: get: operationId: security_analytics.get_findings.0 x-operation-group: security_analytics.get_findings x-version-added: '2.4' description: Retrieve findings related to a specific detector type or detector ID. externalDocs: url: https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-findings parameters: - $ref: '#/components/parameters/security_analytics.get_findings___query.detectionType' - $ref: '#/components/parameters/security_analytics.get_findings___query.detectorType' - $ref: '#/components/parameters/security_analytics.get_findings___query.detector_id' - $ref: '#/components/parameters/security_analytics.get_findings___query.endTime' - $ref: '#/components/parameters/security_analytics.get_findings___query.findingIds' - $ref: '#/components/parameters/security_analytics.get_findings___query.missing' - $ref: '#/components/parameters/security_analytics.get_findings___query.searchString' - $ref: '#/components/parameters/security_analytics.get_findings___query.severity' - $ref: '#/components/parameters/security_analytics.get_findings___query.size' - $ref: '#/components/parameters/security_analytics.get_findings___query.sortOrder' - $ref: '#/components/parameters/security_analytics.get_findings___query.sortString' - $ref: '#/components/parameters/security_analytics.get_findings___query.startIndex' - $ref: '#/components/parameters/security_analytics.get_findings___query.startTime' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security_analytics.get_findings___200' /_plugins/_security_analytics/findings/correlate: get: operationId: security_analytics.search_finding_correlations.0 x-operation-group: security_analytics.search_finding_correlations x-version-added: '2.7' description: List correlations for a finding. externalDocs: url: https://docs.opensearch.org/docs/latest/security-analytics/api-tools/correlation-eng/#list-correlations-for-a-finding-belonging-to-a-log-type parameters: - $ref: '#/components/parameters/security_analytics.search_finding_correlations___query.detector_type' - $ref: '#/components/parameters/security_analytics.search_finding_correlations___query.finding' - $ref: '#/components/parameters/security_analytics.search_finding_correlations___query.nearby_findings' - $ref: '#/components/parameters/security_analytics.search_finding_correlations___query.time_window' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security_analytics.search_finding_correlations___200' /_plugins/_security/api/_upgrade_check: get: operationId: security.config_upgrade_check.0 x-operation-group: security.config_upgrade_check x-version-added: '2.14' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks whether or not an upgrade can be performed and which security resources can be updated. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check responses: '200': $ref: '#/components/responses/security.config_upgrade_check___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/_upgrade_perform: post: operationId: security.config_upgrade_perform.0 x-operation-group: security.config_upgrade_perform x-version-added: '2.14' x-distributions-excluded: - amazon-managed - amazon-serverless description: Assists the cluster operator with upgrading missing default values and stale default definitions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade requestBody: $ref: '#/components/requestBodies/security.config_upgrade_perform' responses: '200': $ref: '#/components/responses/security.config_upgrade_perform___200' '400': $ref: '#/components/responses/security.config_upgrade_perform___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/account: get: operationId: security.get_account_details.0 x-operation-group: security.get_account_details x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns account information for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details responses: '200': $ref: '#/components/responses/security.get_account_details___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: security.change_password.0 x-operation-group: security.change_password x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Changes the password for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#change-password requestBody: $ref: '#/components/requestBodies/security.change_password' responses: '200': $ref: '#/components/responses/security.change_password___200' '403': $ref: '#/components/responses/security.change_password___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/actiongroups: get: operationId: security.get_action_groups.0 x-operation-group: security.get_action_groups x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all action groups. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups responses: '200': $ref: '#/components/responses/security.get_action_groups___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_action_groups.1 x-operation-group: security.patch_action_groups x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates, updates, or deletes multiple action groups in a single request. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups requestBody: $ref: '#/components/requestBodies/security.patch_action_groups' responses: '200': $ref: '#/components/responses/security.patch_action_groups___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/actiongroups/{action_group}: delete: operationId: security.delete_action_group.0 x-operation-group: security.delete_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - $ref: '#/components/parameters/security.delete_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_action_group___200' get: operationId: security.get_action_group.0 x-operation-group: security.get_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves one action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group parameters: - $ref: '#/components/parameters/security.get_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_action_group___200' patch: operationId: security.patch_action_group.0 x-operation-group: security.patch_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of an action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group parameters: - $ref: '#/components/parameters/security.patch_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_action_group' responses: '200': $ref: '#/components/responses/security.patch_action_group___200' put: operationId: security.create_action_group.0 x-operation-group: security.create_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group parameters: - $ref: '#/components/parameters/security.create_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_action_group' responses: '200': $ref: '#/components/responses/security.create_action_group___200' '201': $ref: '#/components/responses/security.create_action_group___201' /_plugins/_security/api/allowlist: get: operationId: security.get_allowlist.0 x-operation-group: security.get_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current list of allowed APIs accessible to a normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': $ref: '#/components/responses/security.get_allowlist___200' '403': $ref: '#/components/responses/security.get_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_allowlist.0 x-operation-group: security.patch_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the current list of APIs accessible for users on the allow list. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.patch_allowlist' responses: '200': $ref: '#/components/responses/security.patch_allowlist___200' '403': $ref: '#/components/responses/security.patch_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: security.create_allowlist.0 x-operation-group: security.create_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.create_allowlist' responses: '200': $ref: '#/components/responses/security.create_allowlist___200' '403': $ref: '#/components/responses/security.create_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/audit: get: operationId: security.get_audit_configuration.0 x-operation-group: security.get_audit_configuration x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs responses: '200': $ref: '#/components/responses/security.get_audit_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_audit_configuration.0 x-operation-group: security.patch_audit_configuration x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the specified fields in the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs requestBody: $ref: '#/components/requestBodies/security.patch_audit_configuration' responses: '200': $ref: '#/components/responses/security.patch_audit_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/audit/config: put: operationId: security.update_audit_configuration.0 x-operation-group: security.update_audit_configuration x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs requestBody: $ref: '#/components/requestBodies/security.update_audit_configuration' responses: '200': $ref: '#/components/responses/security.update_audit_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/authtoken: post: operationId: security.authtoken.0 x-operation-group: security.authtoken x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns the authorization token for the current user. responses: '200': $ref: '#/components/responses/security.authtoken___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/cache: delete: operationId: security.flush_cache.0 x-operation-group: security.flush_cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Flushes the Security plugin's user, authentication, and authorization cache. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: '200': $ref: '#/components/responses/security.flush_cache___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' get: operationId: security.cache.1 x-operation-group: security.cache x-ignorable: true x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: security.cache.2 x-operation-group: security.cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless x-ignorable: true description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: security.cache.3 x-operation-group: security.cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless x-ignorable: true description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/certificates: get: operationId: security.get_all_certificates.0 x-operation-group: security.get_all_certificates x-version-added: '2.15' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the cluster security certificates. parameters: - $ref: '#/components/parameters/security.get_all_certificates___query.cert_type' - $ref: '#/components/parameters/security.get_all_certificates___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_all_certificates___200' '403': $ref: '#/components/responses/security.get_all_certificates___403' '500': $ref: '#/components/responses/security.get_all_certificates___500' /_plugins/_security/api/certificates/{node_id}: get: operationId: security.get_node_certificates.0 x-operation-group: security.get_node_certificates x-version-added: '2.15' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the specified node's security certificates. parameters: - $ref: '#/components/parameters/security.get_node_certificates___path.node_id' - $ref: '#/components/parameters/security.get_node_certificates___query.cert_type' - $ref: '#/components/parameters/security.get_node_certificates___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_node_certificates___200' '403': $ref: '#/components/responses/security.get_node_certificates___403' '500': $ref: '#/components/responses/security.get_node_certificates___500' /_plugins/_security/api/generateonbehalfoftoken: post: operationId: security.generate_obo_token.0 x-operation-group: security.generate_obo_token x-version-added: '2.12' x-distributions-excluded: - amazon-managed - amazon-serverless description: Generates a `On-Behalf-Of` token for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint requestBody: $ref: '#/components/requestBodies/security.generate_obo_token' responses: '200': $ref: '#/components/responses/security.generate_obo_token___200' '400': $ref: '#/components/responses/security.generate_obo_token___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/internalusers: get: operationId: security.get_users.0 x-operation-group: security.get_users x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve all internal users. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-users responses: '200': $ref: '#/components/responses/security.get_users___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_users.0 x-operation-group: security.patch_users x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates, updates, or deletes multiple internal users in a single request. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-users requestBody: $ref: '#/components/requestBodies/security.patch_users' responses: '200': $ref: '#/components/responses/security.patch_users___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/internalusers/{username}: delete: operationId: security.delete_user.0 x-operation-group: security.delete_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: - $ref: '#/components/parameters/security.delete_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_user___200' get: operationId: security.get_user.0 x-operation-group: security.get_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve information about the specified internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user parameters: - $ref: '#/components/parameters/security.get_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_user___200' patch: operationId: security.patch_user.0 x-operation-group: security.patch_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates individual attributes for an internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user parameters: - $ref: '#/components/parameters/security.patch_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_user' responses: '200': $ref: '#/components/responses/security.patch_user___200' put: operationId: security.create_user.0 x-operation-group: security.create_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user parameters: - $ref: '#/components/parameters/security.create_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_user' responses: '200': $ref: '#/components/responses/security.create_user___200' '201': $ref: '#/components/responses/security.create_user___201' /_plugins/_security/api/internalusers/{username}/authtoken: post: operationId: security.generate_user_token.0 x-operation-group: security.generate_user_token x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Generates an authorization token for the specified user. parameters: - $ref: '#/components/parameters/security.generate_user_token___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.generate_user_token___200' '400': $ref: '#/components/responses/security.generate_user_token___400' /_plugins/_security/api/migrate: post: operationId: security.migrate.0 x-operation-group: security.migrate x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Migrates the security configuration from v6 to v7. responses: '200': $ref: '#/components/responses/security.migrate___200' '400': $ref: '#/components/responses/security.migrate___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/nodesdn: get: operationId: security.get_distinguished_names.0 x-operation-group: security.get_distinguished_names x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all node distinguished names. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - $ref: '#/components/parameters/security.get_distinguished_names___query.show_all' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_distinguished_names___200' '400': $ref: '#/components/responses/security.get_distinguished_names___400' '403': $ref: '#/components/responses/security.get_distinguished_names___403' patch: operationId: security.patch_distinguished_names.0 x-operation-group: security.patch_distinguished_names x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Bulk updates specified node distinguished names. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names requestBody: $ref: '#/components/requestBodies/security.patch_distinguished_names' responses: '200': $ref: '#/components/responses/security.patch_distinguished_names___200' '400': $ref: '#/components/responses/security.patch_distinguished_names___400' '403': $ref: '#/components/responses/security.patch_distinguished_names___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/nodesdn/{cluster_name}: delete: operationId: security.delete_distinguished_name.0 x-operation-group: security.delete_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: - $ref: '#/components/parameters/security.delete_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_distinguished_name___200' '400': $ref: '#/components/responses/security.delete_distinguished_name___400' '403': $ref: '#/components/responses/security.delete_distinguished_name___403' get: operationId: security.get_distinguished_name.0 x-operation-group: security.get_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all node distinguished names. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - $ref: '#/components/parameters/security.get_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/security.get_distinguished_name___query.show_all' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_distinguished_name___200' '400': $ref: '#/components/responses/security.get_distinguished_name___400' '403': $ref: '#/components/responses/security.get_distinguished_name___403' patch: operationId: security.patch_distinguished_name.0 x-operation-group: security.patch_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions. parameters: - $ref: '#/components/parameters/security.patch_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_distinguished_name' responses: '200': $ref: '#/components/responses/security.patch_distinguished_name___200' '400': $ref: '#/components/responses/security.patch_distinguished_name___400' '403': $ref: '#/components/responses/security.patch_distinguished_name___403' put: operationId: security.update_distinguished_name.0 x-operation-group: security.update_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: - $ref: '#/components/parameters/security.update_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.update_distinguished_name' responses: '200': $ref: '#/components/responses/security.update_distinguished_name___200' '201': $ref: '#/components/responses/security.update_distinguished_name___201' '400': $ref: '#/components/responses/security.update_distinguished_name___400' '403': $ref: '#/components/responses/security.update_distinguished_name___403' /_plugins/_security/api/permissionsinfo: get: operationId: security.get_permissions_info.0 x-operation-group: security.get_permissions_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the evaluated REST API permissions for the currently logged in user. responses: '200': $ref: '#/components/responses/security.get_permissions_info___200' '500': $ref: '#/components/responses/security.get_permissions_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/roles: get: operationId: security.get_roles.0 x-operation-group: security.get_roles x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all roles. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles responses: '200': $ref: '#/components/responses/security.get_roles___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_roles.0 x-operation-group: security.patch_roles x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates, updates, or deletes multiple roles in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles requestBody: $ref: '#/components/requestBodies/security.patch_roles' responses: '200': $ref: '#/components/responses/security.patch_roles___200' '400': $ref: '#/components/responses/security.patch_roles___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/roles/{role}: delete: operationId: security.delete_role.0 x-operation-group: security.delete_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: - $ref: '#/components/parameters/security.delete_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_role___200' get: operationId: security.get_role.0 x-operation-group: security.get_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves one role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role parameters: - $ref: '#/components/parameters/security.get_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_role___200' patch: operationId: security.patch_role.0 x-operation-group: security.patch_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of a role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role parameters: - $ref: '#/components/parameters/security.patch_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_role' responses: '200': $ref: '#/components/responses/security.patch_role___200' '400': $ref: '#/components/responses/security.patch_role___400' put: operationId: security.create_role.0 x-operation-group: security.create_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role parameters: - $ref: '#/components/parameters/security.create_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_role' responses: '200': $ref: '#/components/responses/security.create_role___200' '201': $ref: '#/components/responses/security.create_role___201' /_plugins/_security/api/rolesmapping: get: operationId: security.get_role_mappings.0 x-operation-group: security.get_role_mappings x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all role mappings. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings responses: '200': $ref: '#/components/responses/security.get_role_mappings___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_role_mappings.0 x-operation-group: security.patch_role_mappings x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or updates multiple role mappings in a single request. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings requestBody: $ref: '#/components/requestBodies/security.patch_role_mappings' responses: '200': $ref: '#/components/responses/security.patch_role_mappings___200' '400': $ref: '#/components/responses/security.patch_role_mappings___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/rolesmapping/{role}: delete: operationId: security.delete_role_mapping.0 x-operation-group: security.delete_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: - $ref: '#/components/parameters/security.delete_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_role_mapping___200' get: operationId: security.get_role_mapping.0 x-operation-group: security.get_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping parameters: - $ref: '#/components/parameters/security.get_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_role_mapping___200' patch: operationId: security.patch_role_mapping.0 x-operation-group: security.patch_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of a role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping parameters: - $ref: '#/components/parameters/security.patch_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_role_mapping' responses: '200': $ref: '#/components/responses/security.patch_role_mapping___200' '400': $ref: '#/components/responses/security.patch_role_mapping___400' put: operationId: security.create_role_mapping.0 x-operation-group: security.create_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping parameters: - $ref: '#/components/parameters/security.create_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_role_mapping' responses: '200': $ref: '#/components/responses/security.create_role_mapping___200' '201': $ref: '#/components/responses/security.create_role_mapping___201' /_plugins/_security/api/securityconfig: get: operationId: security.get_configuration.0 x-operation-group: security.get_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns the current Security plugin configuration in a JSON format. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: '200': $ref: '#/components/responses/security.get_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_configuration.0 x-operation-group: security.patch_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the existing security configuration using the REST API. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: $ref: '#/components/requestBodies/security.patch_configuration' responses: '200': $ref: '#/components/responses/security.patch_configuration___200' '403': $ref: '#/components/responses/security.patch_configuration___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/securityconfig/config: put: operationId: security.update_configuration.0 x-operation-group: security.update_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the settings for an existing security configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: $ref: '#/components/requestBodies/security.update_configuration' responses: '200': $ref: '#/components/responses/security.update_configuration___200' '403': $ref: '#/components/responses/security.update_configuration___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/ssl/certs: get: operationId: security.get_certificates.0 x-operation-group: security.get_certificates x-version-added: '2.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: '200': $ref: '#/components/responses/security.get_certificates___200' '400': $ref: '#/components/responses/security.get_certificates___400' '403': $ref: '#/components/responses/security.get_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/ssl/http/reloadcerts: put: operationId: security.reload_http_certificates.0 x-operation-group: security.reload_http_certificates x-version-added: '2.8' x-distributions-excluded: - amazon-managed - amazon-serverless description: Reloads the HTTP communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates responses: '200': $ref: '#/components/responses/security.reload_http_certificates___200' '400': $ref: '#/components/responses/security.reload_http_certificates___400' '403': $ref: '#/components/responses/security.reload_http_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/ssl/transport/reloadcerts: put: operationId: security.reload_transport_certificates.0 x-operation-group: security.reload_transport_certificates x-version-added: '2.8' x-distributions-excluded: - amazon-managed - amazon-serverless description: Reloads the transport communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: '200': $ref: '#/components/responses/security.reload_transport_certificates___200' '400': $ref: '#/components/responses/security.reload_transport_certificates___400' '403': $ref: '#/components/responses/security.reload_transport_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/tenancy/config: get: operationId: security.get_tenancy_config.0 x-operation-group: security.get_tenancy_config x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api responses: '200': $ref: '#/components/responses/security.get_tenancy_config___200' '400': $ref: '#/components/responses/security.get_tenancy_config___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: security.create_update_tenancy_config.0 x-operation-group: security.create_update_tenancy_config x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api requestBody: $ref: '#/components/requestBodies/security.create_update_tenancy_config' responses: '200': $ref: '#/components/responses/security.create_update_tenancy_config___200' '400': $ref: '#/components/responses/security.create_update_tenancy_config___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/tenants: get: operationId: security.get_tenants.0 x-operation-group: security.get_tenants x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all tenants. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: '200': $ref: '#/components/responses/security.get_tenants___200' '400': $ref: '#/components/responses/security.get_tenants___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' patch: operationId: security.patch_tenants.0 x-operation-group: security.patch_tenants x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds, deletes, or modifies multiple tenants in a single request. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants requestBody: $ref: '#/components/requestBodies/security.patch_tenants' responses: '200': $ref: '#/components/responses/security.patch_tenants___200' '400': $ref: '#/components/responses/security.patch_tenants___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/tenants/{tenant}: delete: operationId: security.delete_tenant.0 x-operation-group: security.delete_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - $ref: '#/components/parameters/security.delete_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_tenant___200' '400': $ref: '#/components/responses/security.delete_tenant___400' get: operationId: security.get_tenant.0 x-operation-group: security.get_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant parameters: - $ref: '#/components/parameters/security.get_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_tenant___200' patch: operationId: security.patch_tenant.0 x-operation-group: security.patch_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds, deletes, or modifies a single tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant parameters: - $ref: '#/components/parameters/security.patch_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_tenant' responses: '200': $ref: '#/components/responses/security.patch_tenant___200' '400': $ref: '#/components/responses/security.patch_tenant___400' put: operationId: security.create_tenant.0 x-operation-group: security.create_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant parameters: - $ref: '#/components/parameters/security.create_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_tenant' responses: '200': $ref: '#/components/responses/security.create_tenant___200' '201': $ref: '#/components/responses/security.create_tenant___201' '400': $ref: '#/components/responses/security.create_tenant___400' /_plugins/_security/api/user: get: operationId: security.get_users_legacy.0 x-operation-group: security.get_users_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve all internal users. Legacy API. responses: '200': $ref: '#/components/responses/security.get_users_legacy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/api/user/{username}: delete: operationId: security.delete_user_legacy.0 x-operation-group: security.delete_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Delete the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.delete_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_user_legacy___200' get: operationId: security.get_user_legacy.0 x-operation-group: security.get_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve one user. Legacy API. parameters: - $ref: '#/components/parameters/security.get_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_user_legacy___200' put: operationId: security.create_user_legacy.0 x-operation-group: security.create_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.create_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_user_legacy' responses: '200': $ref: '#/components/responses/security.create_user_legacy___200' '201': $ref: '#/components/responses/security.create_user_legacy___201' /_plugins/_security/api/user/{username}/authtoken: post: operationId: security.generate_user_token_legacy.0 x-operation-group: security.generate_user_token_legacy x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '501': $ref: '#/components/responses/security.generate_user_token_legacy___501' /_plugins/_security/api/validate: get: operationId: security.validate.0 x-operation-group: security.validate x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks whether the v6 security configuration is valid and ready to be migrated to v7. parameters: - $ref: '#/components/parameters/security.validate___query.accept_invalid' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.validate___200' '400': $ref: '#/components/responses/security.validate___400' /_plugins/_security/authinfo: get: operationId: security.authinfo.0 x-operation-group: security.authinfo x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns or updates authentication information for the currently authenticated user. parameters: - $ref: '#/components/parameters/security.authinfo___query.auth_type' - $ref: '#/components/parameters/security.authinfo___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.authinfo___200' '500': $ref: '#/components/responses/security.authinfo___500' post: operationId: security.authinfo.1 x-operation-group: security.authinfo x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns or updates authentication information for the currently authenticated user. parameters: - $ref: '#/components/parameters/security.authinfo___query.auth_type' - $ref: '#/components/parameters/security.authinfo___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.authinfo___200' '500': $ref: '#/components/responses/security.authinfo___500' /_plugins/_security/dashboardsinfo: get: operationId: security.get_dashboards_info.0 x-operation-group: security.get_dashboards_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current values for dynamic security settings for OpenSearch Dashboards. responses: '200': $ref: '#/components/responses/security.get_dashboards_info___200' '500': $ref: '#/components/responses/security.get_dashboards_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: security.post_dashboards_info.1 x-operation-group: security.post_dashboards_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current values for dynamic security settings for OpenSearch Dashboards. responses: '200': $ref: '#/components/responses/security.post_dashboards_info___200' '500': $ref: '#/components/responses/security.post_dashboards_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/health: get: operationId: security.health.0 x-operation-group: security.health x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks to see if the Security plugin is running. parameters: - $ref: '#/components/parameters/security.health___query.mode' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': $ref: '#/components/responses/security.health___200' post: operationId: security.health.1 x-operation-group: security.health x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks to see if the Security plugin is running. parameters: - $ref: '#/components/parameters/security.health___query.mode' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': $ref: '#/components/responses/security.health___200' /_plugins/_security/tenantinfo: get: operationId: security.tenant_info.0 x-operation-group: security.tenant_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions. responses: '200': $ref: '#/components/responses/security.tenant_info___200' '403': $ref: '#/components/responses/security.tenant_info___403' '500': $ref: '#/components/responses/security.tenant_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: security.tenant_info.1 x-operation-group: security.tenant_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions. responses: '200': $ref: '#/components/responses/security.tenant_info___200' '403': $ref: '#/components/responses/security.tenant_info___403' '500': $ref: '#/components/responses/security.tenant_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/whoami: get: operationId: security.who_am_i.0 x-operation-group: security.who_am_i x-version-added: '2.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Gets the identity information for the user currently logged in. responses: '200': $ref: '#/components/responses/security.who_am_i___200' '500': $ref: '#/components/responses/security.who_am_i___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' post: operationId: security.who_am_i.1 x-operation-group: security.who_am_i x-version-added: '2.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Gets the identity information for the user currently logged in. responses: '200': $ref: '#/components/responses/security.who_am_i___200' '500': $ref: '#/components/responses/security.who_am_i___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_security/whoamiprotected: get: operationId: security.who_am_i_protected.0 x-operation-group: security.who_am_i_protected x-version-added: '2.11' x-distributions-excluded: - amazon-managed - amazon-serverless description: Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled. responses: '200': $ref: '#/components/responses/security.who_am_i_protected___200' '500': $ref: '#/components/responses/security.who_am_i_protected___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_sm/policies: get: operationId: sm.get_policies.0 x-operation-group: sm.get_policies x-version-added: '2.1' description: Retrieves all snapshot management policies with optional pagination and filtering. parameters: - $ref: '#/components/parameters/sm.get_policies___query.from' - $ref: '#/components/parameters/sm.get_policies___query.queryString' - $ref: '#/components/parameters/sm.get_policies___query.size' - $ref: '#/components/parameters/sm.get_policies___query.sortField' - $ref: '#/components/parameters/sm.get_policies___query.sortOrder' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.get_policies___200' /_plugins/_sm/policies/{policy_name}: delete: operationId: sm.delete_policy.0 x-operation-group: sm.delete_policy x-version-added: '2.1' description: Deletes a snapshot management policy. parameters: - $ref: '#/components/parameters/sm.delete_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.delete_policy___200' '404': $ref: '#/components/responses/sm.delete_policy___404' get: operationId: sm.get_policy.0 x-operation-group: sm.get_policy x-version-added: '2.1' description: Retrieves a specific snapshot management policy by name. parameters: - $ref: '#/components/parameters/sm.get_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.get_policy___200' '404': $ref: '#/components/responses/sm.get_policy___404' post: operationId: sm.create_policy.0 x-operation-group: sm.create_policy x-version-added: '2.1' description: Creates a snapshot management policy. parameters: - $ref: '#/components/parameters/sm.create_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sm.create_policy' responses: '201': $ref: '#/components/responses/sm.create_policy___201' '400': $ref: '#/components/responses/sm.create_policy___400' put: operationId: sm.update_policy.0 x-operation-group: sm.update_policy x-version-added: '2.1' description: Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`. parameters: - $ref: '#/components/parameters/sm.update_policy___path.policy_name' - $ref: '#/components/parameters/sm.update_policy___query.if_primary_term' - $ref: '#/components/parameters/sm.update_policy___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sm.update_policy' responses: '200': $ref: '#/components/responses/sm.update_policy___200' '404': $ref: '#/components/responses/sm.update_policy___404' /_plugins/_sm/policies/{policy_name}/_explain: get: operationId: sm.explain_policy.0 x-operation-group: sm.explain_policy x-version-added: '2.1' description: Explains the state of the snapshot management policy. parameters: - $ref: '#/components/parameters/sm.explain_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.explain_policy___200' /_plugins/_sm/policies/{policy_name}/_start: post: operationId: sm.start_policy.0 x-operation-group: sm.start_policy x-version-added: '2.1' description: Starts a snapshot management policy. parameters: - $ref: '#/components/parameters/sm.start_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.start_policy___200' /_plugins/_sm/policies/{policy_name}/_stop: post: operationId: sm.stop_policy.0 x-operation-group: sm.stop_policy x-version-added: '2.1' description: Stops a snapshot management policy. parameters: - $ref: '#/components/parameters/sm.stop_policy___path.policy_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sm.stop_policy___200' /_plugins/_sql: post: operationId: sql.query.0 x-operation-group: sql.query x-version-added: '1.0' description: Executes SQL or PPL queries against OpenSearch indexes. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.query___query.format' - $ref: '#/components/parameters/sql.query___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.query' responses: '200': $ref: '#/components/responses/sql.query___200' /_plugins/_sql/_explain: post: operationId: sql.explain.0 x-operation-group: sql.explain x-version-added: '1.0' description: Returns the execution plan for a SQL or PPL query. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.explain___query.format' - $ref: '#/components/parameters/sql.explain___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.explain' responses: '200': $ref: '#/components/responses/sql.explain___200' /_plugins/_sql/close: post: operationId: sql.close.0 x-operation-group: sql.close x-version-added: '1.0' description: Closes an open cursor to free server-side resources. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.close___query.format' - $ref: '#/components/parameters/sql.close___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.close' responses: '200': $ref: '#/components/responses/sql.close___200' /_plugins/_sql/stats: get: operationId: sql.get_stats.0 x-operation-group: sql.get_stats x-version-added: '1.0' description: Retrieves performance metrics for the SQL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/sql.get_stats___query.format' - $ref: '#/components/parameters/sql.get_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sql.get_stats___200' post: operationId: sql.post_stats.1 x-operation-group: sql.post_stats x-version-added: '1.0' description: Retrieves filtered performance metrics for the SQL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/sql.post_stats___query.format' - $ref: '#/components/parameters/sql.post_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.post_stats' responses: '200': $ref: '#/components/responses/sql.post_stats___200' /_plugins/_transform: get: operationId: transforms.search.0 x-operation-group: transforms.search x-version-added: '1.0' description: Returns the details of all transform jobs. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: - $ref: '#/components/parameters/transforms.search___query.from' - $ref: '#/components/parameters/transforms.search___query.search' - $ref: '#/components/parameters/transforms.search___query.size' - $ref: '#/components/parameters/transforms.search___query.sortDirection' - $ref: '#/components/parameters/transforms.search___query.sortField' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.search___200' /_plugins/_transform/_preview: post: operationId: transforms.preview.0 x-operation-group: transforms.preview x-version-added: '1.0' description: Returns a preview of what a transformed index would look like. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#preview-a-transform-jobs-results requestBody: $ref: '#/components/requestBodies/transforms.preview' responses: '200': $ref: '#/components/responses/transforms.preview___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_transform/{id}: delete: operationId: transforms.delete.0 x-operation-group: transforms.delete x-version-added: '1.0' description: Delete an index transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#delete-a-transform-job parameters: - $ref: '#/components/parameters/transforms.delete___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.delete___200' get: operationId: transforms.get.0 x-operation-group: transforms.get x-version-added: '1.0' description: Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: - $ref: '#/components/parameters/transforms.get___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.get___200' put: operationId: transforms.put.0 x-operation-group: transforms.put x-version-added: '1.0' description: Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job parameters: - $ref: '#/components/parameters/transforms.put___path.id' - $ref: '#/components/parameters/transforms.put___query.if_primary_term' - $ref: '#/components/parameters/transforms.put___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/transforms.put' responses: '200': $ref: '#/components/responses/transforms.put___200' '201': $ref: '#/components/responses/transforms.put___201' /_plugins/_transform/{id}/_explain: get: operationId: transforms.explain.0 x-operation-group: transforms.explain x-version-added: '1.0' description: Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-the-status-of-a-transform-job parameters: - $ref: '#/components/parameters/transforms.explain___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.explain___200' /_plugins/_transform/{id}/_start: post: operationId: transforms.start.0 x-operation-group: transforms.start x-version-added: '1.0' description: Start transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#start-a-transform-job parameters: - $ref: '#/components/parameters/transforms.start___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.start___200' /_plugins/_transform/{id}/_stop: post: operationId: transforms.stop.0 x-operation-group: transforms.stop x-version-added: '1.0' description: Stop transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job parameters: - $ref: '#/components/parameters/transforms.stop___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/transforms.stop___200' /_plugins/geospatial/_upload/stats: get: operationId: geospatial.get_upload_stats.0 x-operation-group: geospatial.get_upload_stats x-version-added: '2.11' description: Retrieves statistics for all geospatial uploads. responses: '200': $ref: '#/components/responses/geospatial.get_upload_stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/geospatial/geojson/_upload: post: operationId: geospatial.geojson_upload_post.0 x-operation-group: geospatial.geojson_upload_post x-version-added: '2.11' description: |- Use an OpenSearch query to upload `GeoJSON`, operation will fail if index exists. - When type is `geo_point`, only Point geometry is allowed - When type is `geo_shape`, all geometry types are allowed (Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Envelope). requestBody: $ref: '#/components/requestBodies/geospatial.geojson_upload_post' responses: '200': $ref: '#/components/responses/geospatial.geojson_upload_post___200' '400': $ref: '#/components/responses/geospatial.geojson_upload_post___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: geospatial.geojson_upload_put.0 x-operation-group: geospatial.geojson_upload_put x-version-added: '2.11' description: |- Use an OpenSearch query to upload `GeoJSON` regardless if index exists. - When type is `geo_point`, only Point geometry is allowed - When type is `geo_shape`, all geometry types are allowed (Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Envelope). requestBody: $ref: '#/components/requestBodies/geospatial.geojson_upload_put' responses: '200': $ref: '#/components/responses/geospatial.geojson_upload_put___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/geospatial/ip2geo/datasource: get: operationId: geospatial.get_ip2geo_datasource.0 x-operation-group: geospatial.get_ip2geo_datasource x-version-added: '2.11' description: Get one or more IP2Geo data sources, defaulting to returning all if no names specified. externalDocs: url: https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request responses: '200': $ref: '#/components/responses/geospatial.get_ip2geo_datasource___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/geospatial/ip2geo/datasource/{name}: delete: operationId: geospatial.delete_ip2geo_datasource.0 x-operation-group: geospatial.delete_ip2geo_datasource x-version-added: '2.11' description: Delete a specific IP2Geo data source. externalDocs: url: https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#deleting-the-ip2geo-data-source parameters: - $ref: '#/components/parameters/geospatial.delete_ip2geo_datasource___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/geospatial.delete_ip2geo_datasource___200' '404': $ref: '#/components/responses/geospatial.delete_ip2geo_datasource___404' get: operationId: geospatial.get_ip2geo_datasource.1 x-operation-group: geospatial.get_ip2geo_datasource x-version-added: '2.11' description: Get one or more IP2Geo data sources, defaulting to returning all if no names specified. externalDocs: url: https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request parameters: - $ref: '#/components/parameters/geospatial.get_ip2geo_datasource___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/geospatial.get_ip2geo_datasource___200' put: operationId: geospatial.put_ip2geo_datasource.0 x-operation-group: geospatial.put_ip2geo_datasource x-version-added: '2.11' description: |- Create a specific IP2Geo data source. Default values: - `endpoint`: `"https://geoip.maps.opensearch.org/v1/geolite2-city/manifest.json"` - `update_interval_in_days`: 3. externalDocs: url: https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#data-source-options parameters: - $ref: '#/components/parameters/geospatial.put_ip2geo_datasource___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/geospatial.put_ip2geo_datasource' responses: '200': $ref: '#/components/responses/geospatial.put_ip2geo_datasource___200' '400': $ref: '#/components/responses/geospatial.put_ip2geo_datasource___400' /_plugins/geospatial/ip2geo/datasource/{name}/_settings: put: operationId: geospatial.put_ip2geo_datasource_settings.0 x-operation-group: geospatial.put_ip2geo_datasource_settings x-version-added: '2.11' description: Update a specific IP2Geo data source. externalDocs: url: https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#updating-an-ip2geo-data-source parameters: - $ref: '#/components/parameters/geospatial.put_ip2geo_datasource_settings___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/geospatial.put_ip2geo_datasource_settings' responses: '200': $ref: '#/components/responses/geospatial.put_ip2geo_datasource_settings___200' '404': $ref: '#/components/responses/geospatial.put_ip2geo_datasource_settings___404' /_plugins/ubi/initialize: post: operationId: ubi.initialize.0 x-operation-group: ubi.initialize x-version-added: '1.0' description: Initializes the UBI indexes. responses: '200': $ref: '#/components/responses/ubi.initialize___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_rank_eval: get: operationId: rank_eval.0 x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' - $ref: '#/components/parameters/rank_eval___query.search_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': $ref: '#/components/responses/rank_eval___200' post: operationId: rank_eval.1 x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' - $ref: '#/components/parameters/rank_eval___query.search_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': $ref: '#/components/responses/rank_eval___200' /_recovery: get: operationId: indices.recovery.0 x-operation-group: indices.recovery x-version-added: '1.0' description: Returns information about ongoing index shard recoveries. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.recovery___query.active_only' - $ref: '#/components/parameters/indices.recovery___query.detailed' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.recovery___200' /_refresh: get: operationId: indices.refresh.0 x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.refresh___200' post: operationId: indices.refresh.1 x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.refresh___200' /_reindex: post: operationId: reindex.0 x-operation-group: reindex x-version-added: '1.0' description: |- Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/reindex-data/ parameters: - $ref: '#/components/parameters/reindex___query.max_docs' - $ref: '#/components/parameters/reindex___query.refresh' - $ref: '#/components/parameters/reindex___query.requests_per_second' - $ref: '#/components/parameters/reindex___query.require_alias' - $ref: '#/components/parameters/reindex___query.scroll' - $ref: '#/components/parameters/reindex___query.slices' - $ref: '#/components/parameters/reindex___query.timeout' - $ref: '#/components/parameters/reindex___query.wait_for_active_shards' - $ref: '#/components/parameters/reindex___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/reindex' responses: '200': $ref: '#/components/responses/reindex___200' /_reindex/{task_id}/_rethrottle: post: operationId: reindex_rethrottle.0 x-operation-group: reindex_rethrottle x-version-added: '1.0' description: Changes the number of requests per second for a particular reindex operation. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/reindex_rethrottle___path.task_id' - $ref: '#/components/parameters/reindex_rethrottle___query.requests_per_second' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/reindex_rethrottle___200' /_remote/info: get: operationId: cluster.remote_info.0 x-operation-group: cluster.remote_info x-version-added: '1.0' description: Returns the information about configured remote clusters. externalDocs: url: https://opensearch.org/docs/latest/api-reference/remote-info/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/cluster.remote_info___200' /_remotestore/_restore: post: operationId: remote_store.restore.0 x-operation-group: remote_store.restore x-version-added: '1.0' description: Restores from remote store. externalDocs: url: https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup parameters: - $ref: '#/components/parameters/remote_store.restore___query.cluster_manager_timeout' - $ref: '#/components/parameters/remote_store.restore___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/remote_store.restore' responses: '200': $ref: '#/components/responses/remote_store.restore___200' /_render/template: get: operationId: render_search_template.0 x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': $ref: '#/components/responses/render_search_template___200' post: operationId: render_search_template.1 x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': $ref: '#/components/responses/render_search_template___200' /_render/template/{id}: get: operationId: render_search_template.2 x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/render_search_template___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': $ref: '#/components/responses/render_search_template___200' post: operationId: render_search_template.3 x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/render_search_template___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': $ref: '#/components/responses/render_search_template___200' /_resolve/index/{name}: get: operationId: indices.resolve_index.0 x-operation-group: indices.resolve_index x-version-added: '1.0' description: Returns information about any matching indexes, aliases, and data streams. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.resolve_index___path.name' - $ref: '#/components/parameters/indices.resolve_index___query.expand_wildcards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.resolve_index___200' /_script_context: get: operationId: get_script_context.0 x-operation-group: get_script_context x-version-added: '1.0' description: Returns all script contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/get_script_context___200' /_script_language: get: operationId: get_script_languages.0 x-operation-group: get_script_languages x-version-added: '1.0' description: Returns available script types, languages and contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/get_script_languages___200' /_scripts/{id}: delete: operationId: delete_script.0 x-operation-group: delete_script x-version-added: '1.0' description: Deletes a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/ parameters: - $ref: '#/components/parameters/delete_script___path.id' - $ref: '#/components/parameters/delete_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/delete_script___query.master_timeout' - $ref: '#/components/parameters/delete_script___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/delete_script___200' get: operationId: get_script.0 x-operation-group: get_script x-version-added: '1.0' description: Returns a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/ parameters: - $ref: '#/components/parameters/get_script___path.id' - $ref: '#/components/parameters/get_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/get_script___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/get_script___200' post: operationId: put_script.0 x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - $ref: '#/components/parameters/put_script___path.id' - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/put_script___query.context' - $ref: '#/components/parameters/put_script___query.master_timeout' - $ref: '#/components/parameters/put_script___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': $ref: '#/components/responses/put_script___200' put: operationId: put_script.1 x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - $ref: '#/components/parameters/put_script___path.id' - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/put_script___query.context' - $ref: '#/components/parameters/put_script___query.master_timeout' - $ref: '#/components/parameters/put_script___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': $ref: '#/components/responses/put_script___200' /_scripts/{id}/{context}: post: operationId: put_script.2 x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - $ref: '#/components/parameters/put_script___path.context' - $ref: '#/components/parameters/put_script___path.id' - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/put_script___query.context' - $ref: '#/components/parameters/put_script___query.master_timeout' - $ref: '#/components/parameters/put_script___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': $ref: '#/components/responses/put_script___200' put: operationId: put_script.3 x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - $ref: '#/components/parameters/put_script___path.context' - $ref: '#/components/parameters/put_script___path.id' - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' - $ref: '#/components/parameters/put_script___query.context' - $ref: '#/components/parameters/put_script___query.master_timeout' - $ref: '#/components/parameters/put_script___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': $ref: '#/components/responses/put_script___200' /_scripts/painless/_execute: get: operationId: scripts_painless_execute.0 x-operation-group: scripts_painless_execute x-version-added: '1.0' description: Allows an arbitrary script to be executed and a result to be returned. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scripts_painless_execute' responses: '200': $ref: '#/components/responses/scripts_painless_execute___200' post: operationId: scripts_painless_execute.1 x-operation-group: scripts_painless_execute x-version-added: '1.0' description: Allows an arbitrary script to be executed and a result to be returned. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scripts_painless_execute' responses: '200': $ref: '#/components/responses/scripts_painless_execute___200' /_search: get: operationId: search.0 x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search___query._source' - $ref: '#/components/parameters/search___query._source_excludes' - $ref: '#/components/parameters/search___query._source_includes' - $ref: '#/components/parameters/search___query.allow_no_indices' - $ref: '#/components/parameters/search___query.allow_partial_search_results' - $ref: '#/components/parameters/search___query.analyze_wildcard' - $ref: '#/components/parameters/search___query.analyzer' - $ref: '#/components/parameters/search___query.batched_reduce_size' - $ref: '#/components/parameters/search___query.cancel_after_time_interval' - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search___query.default_operator' - $ref: '#/components/parameters/search___query.df' - $ref: '#/components/parameters/search___query.docvalue_fields' - $ref: '#/components/parameters/search___query.expand_wildcards' - $ref: '#/components/parameters/search___query.explain' - $ref: '#/components/parameters/search___query.from' - $ref: '#/components/parameters/search___query.ignore_throttled' - $ref: '#/components/parameters/search___query.ignore_unavailable' - $ref: '#/components/parameters/search___query.include_named_queries_score' - $ref: '#/components/parameters/search___query.index' - $ref: '#/components/parameters/search___query.lenient' - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/search___query.phase_took' - $ref: '#/components/parameters/search___query.pre_filter_shard_size' - $ref: '#/components/parameters/search___query.preference' - $ref: '#/components/parameters/search___query.q' - $ref: '#/components/parameters/search___query.request_cache' - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search___query.routing' - $ref: '#/components/parameters/search___query.scroll' - $ref: '#/components/parameters/search___query.search_pipeline' - $ref: '#/components/parameters/search___query.search_type' - $ref: '#/components/parameters/search___query.seq_no_primary_term' - $ref: '#/components/parameters/search___query.size' - $ref: '#/components/parameters/search___query.sort' - $ref: '#/components/parameters/search___query.stats' - $ref: '#/components/parameters/search___query.stored_fields' - $ref: '#/components/parameters/search___query.suggest_field' - $ref: '#/components/parameters/search___query.suggest_mode' - $ref: '#/components/parameters/search___query.suggest_size' - $ref: '#/components/parameters/search___query.suggest_text' - $ref: '#/components/parameters/search___query.terminate_after' - $ref: '#/components/parameters/search___query.timeout' - $ref: '#/components/parameters/search___query.track_scores' - $ref: '#/components/parameters/search___query.track_total_hits' - $ref: '#/components/parameters/search___query.typed_keys' - $ref: '#/components/parameters/search___query.verbose_pipeline' - $ref: '#/components/parameters/search___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search' responses: '200': $ref: '#/components/responses/search___200' '400': $ref: '#/components/responses/search___400' '404': $ref: '#/components/responses/search___404' post: operationId: search.1 x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search___query._source' - $ref: '#/components/parameters/search___query._source_excludes' - $ref: '#/components/parameters/search___query._source_includes' - $ref: '#/components/parameters/search___query.allow_no_indices' - $ref: '#/components/parameters/search___query.allow_partial_search_results' - $ref: '#/components/parameters/search___query.analyze_wildcard' - $ref: '#/components/parameters/search___query.analyzer' - $ref: '#/components/parameters/search___query.batched_reduce_size' - $ref: '#/components/parameters/search___query.cancel_after_time_interval' - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search___query.default_operator' - $ref: '#/components/parameters/search___query.df' - $ref: '#/components/parameters/search___query.docvalue_fields' - $ref: '#/components/parameters/search___query.expand_wildcards' - $ref: '#/components/parameters/search___query.explain' - $ref: '#/components/parameters/search___query.from' - $ref: '#/components/parameters/search___query.ignore_throttled' - $ref: '#/components/parameters/search___query.ignore_unavailable' - $ref: '#/components/parameters/search___query.include_named_queries_score' - $ref: '#/components/parameters/search___query.index' - $ref: '#/components/parameters/search___query.lenient' - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/search___query.phase_took' - $ref: '#/components/parameters/search___query.pre_filter_shard_size' - $ref: '#/components/parameters/search___query.preference' - $ref: '#/components/parameters/search___query.q' - $ref: '#/components/parameters/search___query.request_cache' - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search___query.routing' - $ref: '#/components/parameters/search___query.scroll' - $ref: '#/components/parameters/search___query.search_pipeline' - $ref: '#/components/parameters/search___query.search_type' - $ref: '#/components/parameters/search___query.seq_no_primary_term' - $ref: '#/components/parameters/search___query.size' - $ref: '#/components/parameters/search___query.sort' - $ref: '#/components/parameters/search___query.stats' - $ref: '#/components/parameters/search___query.stored_fields' - $ref: '#/components/parameters/search___query.suggest_field' - $ref: '#/components/parameters/search___query.suggest_mode' - $ref: '#/components/parameters/search___query.suggest_size' - $ref: '#/components/parameters/search___query.suggest_text' - $ref: '#/components/parameters/search___query.terminate_after' - $ref: '#/components/parameters/search___query.timeout' - $ref: '#/components/parameters/search___query.track_scores' - $ref: '#/components/parameters/search___query.track_total_hits' - $ref: '#/components/parameters/search___query.typed_keys' - $ref: '#/components/parameters/search___query.verbose_pipeline' - $ref: '#/components/parameters/search___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search' responses: '200': $ref: '#/components/responses/search___200' '400': $ref: '#/components/responses/search___400' '404': $ref: '#/components/responses/search___404' /_search_shards: get: operationId: search_shards.0 x-operation-group: search_shards x-version-added: '1.0' description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/search_shards___query.allow_no_indices' - $ref: '#/components/parameters/search_shards___query.expand_wildcards' - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' - $ref: '#/components/parameters/search_shards___query.local' - $ref: '#/components/parameters/search_shards___query.preference' - $ref: '#/components/parameters/search_shards___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_shards' responses: '200': $ref: '#/components/responses/search_shards___200' post: operationId: search_shards.1 x-operation-group: search_shards x-version-added: '1.0' description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/search_shards___query.allow_no_indices' - $ref: '#/components/parameters/search_shards___query.expand_wildcards' - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' - $ref: '#/components/parameters/search_shards___query.local' - $ref: '#/components/parameters/search_shards___query.preference' - $ref: '#/components/parameters/search_shards___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_shards' responses: '200': $ref: '#/components/responses/search_shards___200' /_search/pipeline: get: operationId: search_pipeline.get.0 x-operation-group: search_pipeline.get x-version-added: '2.9' description: Retrieves information about a specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.get___query.cluster_manager_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_pipeline.get___200' /_search/pipeline/{id}: delete: operationId: search_pipeline.delete.0 x-operation-group: search_pipeline.delete x-version-added: '2.9' description: Deletes the specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.delete___path.id' - $ref: '#/components/parameters/search_pipeline.delete___query.cluster_manager_timeout' - $ref: '#/components/parameters/search_pipeline.delete___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_pipeline.delete___200' get: operationId: search_pipeline.get.1 x-operation-group: search_pipeline.get x-version-added: '2.9' description: Retrieves information about a specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.get___path.id' - $ref: '#/components/parameters/search_pipeline.get___query.cluster_manager_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/search_pipeline.get___200' put: operationId: search_pipeline.put.0 x-operation-group: search_pipeline.put x-version-added: '2.9' description: Creates or replaces the specified search pipeline. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ parameters: - $ref: '#/components/parameters/search_pipeline.put___path.id' - $ref: '#/components/parameters/search_pipeline.put___query.cluster_manager_timeout' - $ref: '#/components/parameters/search_pipeline.put___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_pipeline.put' responses: '200': $ref: '#/components/responses/search_pipeline.put___200' /_search/point_in_time: delete: operationId: delete_pit.0 x-operation-group: delete_pit x-version-added: '2.4' description: Deletes one or more point in time searches based on the IDs passed. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits requestBody: $ref: '#/components/requestBodies/delete_pit' responses: '200': $ref: '#/components/responses/delete_pit___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_search/point_in_time/_all: delete: operationId: delete_all_pits.0 x-operation-group: delete_all_pits x-version-added: '2.4' description: Deletes all active point in time searches. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits responses: '200': $ref: '#/components/responses/delete_all_pits___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' get: operationId: get_all_pits.0 x-operation-group: get_all_pits x-version-added: '2.4' description: Lists all active point in time searches. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits responses: '200': $ref: '#/components/responses/get_all_pits___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_search/scroll: delete: operationId: clear_scroll.0 x-operation-group: clear_scroll x-version-added: '1.0' description: Explicitly clears the search context for a scroll. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/clear_scroll' responses: '200': $ref: '#/components/responses/clear_scroll___200' '404': $ref: '#/components/responses/clear_scroll___404' get: operationId: scroll.0 x-operation-group: scroll x-version-added: '1.0' description: Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' - $ref: '#/components/parameters/scroll___query.scroll' - $ref: '#/components/parameters/scroll___query.scroll_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scroll' responses: '200': $ref: '#/components/responses/scroll___200' post: operationId: scroll.1 x-operation-group: scroll x-version-added: '1.0' description: Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' - $ref: '#/components/parameters/scroll___query.scroll' - $ref: '#/components/parameters/scroll___query.scroll_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scroll' responses: '200': $ref: '#/components/responses/scroll___200' /_search/scroll/{scroll_id}: delete: operationId: clear_scroll.1 x-operation-group: clear_scroll deprecated: true x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' description: Explicitly clears the search context for a scroll. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ parameters: - $ref: '#/components/parameters/clear_scroll___path.scroll_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/clear_scroll' responses: '200': $ref: '#/components/responses/clear_scroll___200' '404': $ref: '#/components/responses/clear_scroll___404' get: operationId: scroll.2 x-operation-group: scroll deprecated: true x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' description: Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - $ref: '#/components/parameters/scroll___path.scroll_id' - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' - $ref: '#/components/parameters/scroll___query.scroll' - $ref: '#/components/parameters/scroll___query.scroll_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scroll' responses: '200': $ref: '#/components/responses/scroll___200' post: operationId: scroll.3 x-operation-group: scroll deprecated: true x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' description: Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - $ref: '#/components/parameters/scroll___path.scroll_id' - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' - $ref: '#/components/parameters/scroll___query.scroll' - $ref: '#/components/parameters/scroll___query.scroll_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/scroll' responses: '200': $ref: '#/components/responses/scroll___200' /_search/template: get: operationId: search_template.0 x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/search_template___query.allow_no_indices' - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search_template___query.expand_wildcards' - $ref: '#/components/parameters/search_template___query.explain' - $ref: '#/components/parameters/search_template___query.ignore_throttled' - $ref: '#/components/parameters/search_template___query.ignore_unavailable' - $ref: '#/components/parameters/search_template___query.phase_took' - $ref: '#/components/parameters/search_template___query.preference' - $ref: '#/components/parameters/search_template___query.profile' - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search_template___query.routing' - $ref: '#/components/parameters/search_template___query.scroll' - $ref: '#/components/parameters/search_template___query.search_pipeline' - $ref: '#/components/parameters/search_template___query.search_type' - $ref: '#/components/parameters/search_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_template' responses: '200': $ref: '#/components/responses/search_template___200' post: operationId: search_template.1 x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/search_template___query.allow_no_indices' - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search_template___query.expand_wildcards' - $ref: '#/components/parameters/search_template___query.explain' - $ref: '#/components/parameters/search_template___query.ignore_throttled' - $ref: '#/components/parameters/search_template___query.ignore_unavailable' - $ref: '#/components/parameters/search_template___query.phase_took' - $ref: '#/components/parameters/search_template___query.preference' - $ref: '#/components/parameters/search_template___query.profile' - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search_template___query.routing' - $ref: '#/components/parameters/search_template___query.scroll' - $ref: '#/components/parameters/search_template___query.search_pipeline' - $ref: '#/components/parameters/search_template___query.search_type' - $ref: '#/components/parameters/search_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_template' responses: '200': $ref: '#/components/responses/search_template___200' /_segments: get: operationId: indices.segments.0 x-operation-group: indices.segments x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.segments___query.allow_no_indices' - $ref: '#/components/parameters/indices.segments___query.expand_wildcards' - $ref: '#/components/parameters/indices.segments___query.ignore_unavailable' - $ref: '#/components/parameters/indices.segments___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.segments___200' /_settings: get: operationId: indices.get_settings.0 x-operation-group: indices.get_settings x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' - $ref: '#/components/parameters/indices.get_settings___query.local' - $ref: '#/components/parameters/indices.get_settings___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_settings___200' put: operationId: indices.put_settings.0 x-operation-group: indices.put_settings x-version-added: '1.0' description: Updates the index settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: - $ref: '#/components/parameters/indices.put_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.put_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.put_settings___query.flat_settings' - $ref: '#/components/parameters/indices.put_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.put_settings___query.master_timeout' - $ref: '#/components/parameters/indices.put_settings___query.preserve_existing' - $ref: '#/components/parameters/indices.put_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': $ref: '#/components/responses/indices.put_settings___200' /_settings/{name}: get: operationId: indices.get_settings.1 x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - $ref: '#/components/parameters/indices.get_settings___path.name' - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' - $ref: '#/components/parameters/indices.get_settings___query.local' - $ref: '#/components/parameters/indices.get_settings___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_settings___200' /_shard_stores: get: operationId: indices.shard_stores.0 x-operation-group: indices.shard_stores x-version-added: '1.0' description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.shard_stores___query.allow_no_indices' - $ref: '#/components/parameters/indices.shard_stores___query.expand_wildcards' - $ref: '#/components/parameters/indices.shard_stores___query.ignore_unavailable' - $ref: '#/components/parameters/indices.shard_stores___query.status' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.shard_stores___200' /_snapshot: get: operationId: snapshot.get_repository.0 x-operation-group: snapshot.get_repository x-version-added: '1.0' description: Returns information about a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: - $ref: '#/components/parameters/snapshot.get_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.get_repository___query.local' - $ref: '#/components/parameters/snapshot.get_repository___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.get_repository___200' /_snapshot/_status: get: operationId: snapshot.status.0 x-operation-group: snapshot.status x-version-added: '1.0' description: Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' - $ref: '#/components/parameters/snapshot.status___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.status___200' /_snapshot/{repository}: delete: operationId: snapshot.delete_repository.0 x-operation-group: snapshot.delete_repository x-version-added: '1.0' description: Deletes a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/ parameters: - $ref: '#/components/parameters/snapshot.delete_repository___path.repository' - $ref: '#/components/parameters/snapshot.delete_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.delete_repository___query.master_timeout' - $ref: '#/components/parameters/snapshot.delete_repository___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.delete_repository___200' get: operationId: snapshot.get_repository.1 x-operation-group: snapshot.get_repository x-version-added: '1.0' description: Returns information about a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: - $ref: '#/components/parameters/snapshot.get_repository___path.repository' - $ref: '#/components/parameters/snapshot.get_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.get_repository___query.local' - $ref: '#/components/parameters/snapshot.get_repository___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.get_repository___200' post: operationId: snapshot.create_repository.0 x-operation-group: snapshot.create_repository x-version-added: '1.0' description: Creates a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: - $ref: '#/components/parameters/snapshot.create_repository___path.repository' - $ref: '#/components/parameters/snapshot.create_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.master_timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.verify' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.create_repository' responses: '200': $ref: '#/components/responses/snapshot.create_repository___200' put: operationId: snapshot.create_repository.1 x-operation-group: snapshot.create_repository x-version-added: '1.0' description: Creates a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: - $ref: '#/components/parameters/snapshot.create_repository___path.repository' - $ref: '#/components/parameters/snapshot.create_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.master_timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.timeout' - $ref: '#/components/parameters/snapshot.create_repository___query.verify' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.create_repository' responses: '200': $ref: '#/components/responses/snapshot.create_repository___200' /_snapshot/{repository}/_cleanup: post: operationId: snapshot.cleanup_repository.0 x-operation-group: snapshot.cleanup_repository x-version-added: '1.0' description: Removes any stale data from a snapshot repository. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/snapshot.cleanup_repository___path.repository' - $ref: '#/components/parameters/snapshot.cleanup_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.cleanup_repository___query.master_timeout' - $ref: '#/components/parameters/snapshot.cleanup_repository___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.cleanup_repository___200' /_snapshot/{repository}/_status: get: operationId: snapshot.status.1 x-operation-group: snapshot.status x-version-added: '1.0' description: Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - $ref: '#/components/parameters/snapshot.status___path.repository' - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' - $ref: '#/components/parameters/snapshot.status___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.status___200' /_snapshot/{repository}/_verify: post: operationId: snapshot.verify_repository.0 x-operation-group: snapshot.verify_repository x-version-added: '1.0' description: Verifies a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/ parameters: - $ref: '#/components/parameters/snapshot.verify_repository___path.repository' - $ref: '#/components/parameters/snapshot.verify_repository___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.verify_repository___query.master_timeout' - $ref: '#/components/parameters/snapshot.verify_repository___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.verify_repository___200' /_snapshot/{repository}/{snapshot}: delete: operationId: snapshot.delete.0 x-operation-group: snapshot.delete x-version-added: '1.0' description: Deletes a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/ parameters: - $ref: '#/components/parameters/snapshot.delete___path.repository' - $ref: '#/components/parameters/snapshot.delete___path.snapshot' - $ref: '#/components/parameters/snapshot.delete___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.delete___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.delete___200' get: operationId: snapshot.get.0 x-operation-group: snapshot.get x-version-added: '1.0' description: Returns information about a snapshot. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/snapshot.get___path.repository' - $ref: '#/components/parameters/snapshot.get___path.snapshot' - $ref: '#/components/parameters/snapshot.get___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.get___query.ignore_unavailable' - $ref: '#/components/parameters/snapshot.get___query.master_timeout' - $ref: '#/components/parameters/snapshot.get___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.get___200' post: operationId: snapshot.create.0 x-operation-group: snapshot.create x-version-added: '1.0' description: Creates a snapshot within an existing repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: - $ref: '#/components/parameters/snapshot.create___path.repository' - $ref: '#/components/parameters/snapshot.create___path.snapshot' - $ref: '#/components/parameters/snapshot.create___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.create___query.master_timeout' - $ref: '#/components/parameters/snapshot.create___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.create' responses: '200': $ref: '#/components/responses/snapshot.create___200' put: operationId: snapshot.create.1 x-operation-group: snapshot.create x-version-added: '1.0' description: Creates a snapshot within an existing repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: - $ref: '#/components/parameters/snapshot.create___path.repository' - $ref: '#/components/parameters/snapshot.create___path.snapshot' - $ref: '#/components/parameters/snapshot.create___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.create___query.master_timeout' - $ref: '#/components/parameters/snapshot.create___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.create' responses: '200': $ref: '#/components/responses/snapshot.create___200' /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}: put: operationId: snapshot.clone.0 x-operation-group: snapshot.clone x-version-added: '1.0' description: Creates a clone of all or part of a snapshot in the same repository as the original snapshot. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/snapshot.clone___path.repository' - $ref: '#/components/parameters/snapshot.clone___path.snapshot' - $ref: '#/components/parameters/snapshot.clone___path.target_snapshot' - $ref: '#/components/parameters/snapshot.clone___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.clone___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.clone' responses: '200': $ref: '#/components/responses/snapshot.clone___200' /_snapshot/{repository}/{snapshot}/_restore: post: operationId: snapshot.restore.0 x-operation-group: snapshot.restore x-version-added: '1.0' description: Restores a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/ parameters: - $ref: '#/components/parameters/snapshot.restore___path.repository' - $ref: '#/components/parameters/snapshot.restore___path.snapshot' - $ref: '#/components/parameters/snapshot.restore___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.restore___query.master_timeout' - $ref: '#/components/parameters/snapshot.restore___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/snapshot.restore' responses: '200': $ref: '#/components/responses/snapshot.restore___200' /_snapshot/{repository}/{snapshot}/_status: get: operationId: snapshot.status.2 x-operation-group: snapshot.status x-version-added: '1.0' description: Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - $ref: '#/components/parameters/snapshot.status___path.repository' - $ref: '#/components/parameters/snapshot.status___path.snapshot' - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' - $ref: '#/components/parameters/snapshot.status___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/snapshot.status___200' /_stats: get: operationId: indices.stats.0 x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.stats___query.completion_fields' - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' - $ref: '#/components/parameters/indices.stats___query.fields' - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' - $ref: '#/components/parameters/indices.stats___query.groups' - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' - $ref: '#/components/parameters/indices.stats___query.level' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.stats___200' /_stats/{metric}: get: operationId: indices.stats.1 x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.stats___path.metric' - $ref: '#/components/parameters/indices.stats___query.completion_fields' - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' - $ref: '#/components/parameters/indices.stats___query.fields' - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' - $ref: '#/components/parameters/indices.stats___query.groups' - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' - $ref: '#/components/parameters/indices.stats___query.level' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.stats___200' /_tasks: get: operationId: tasks.list.0 x-operation-group: tasks.list x-version-added: '1.0' description: Returns a list of tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - $ref: '#/components/parameters/tasks.list___query.actions' - $ref: '#/components/parameters/tasks.list___query.detailed' - $ref: '#/components/parameters/tasks.list___query.group_by' - $ref: '#/components/parameters/tasks.list___query.nodes' - $ref: '#/components/parameters/tasks.list___query.parent_task_id' - $ref: '#/components/parameters/tasks.list___query.timeout' - $ref: '#/components/parameters/tasks.list___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/tasks.list___200' /_tasks/_cancel: post: operationId: tasks.cancel.0 x-operation-group: tasks.cancel x-version-added: '1.0' description: Cancels a task, if it can be cancelled through an API. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: - $ref: '#/components/parameters/tasks.cancel___query.actions' - $ref: '#/components/parameters/tasks.cancel___query.nodes' - $ref: '#/components/parameters/tasks.cancel___query.parent_task_id' - $ref: '#/components/parameters/tasks.cancel___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/tasks.cancel___200' /_tasks/{task_id}: get: operationId: tasks.get.0 x-operation-group: tasks.get x-version-added: '1.0' description: Returns information about a task. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - $ref: '#/components/parameters/tasks.get___path.task_id' - $ref: '#/components/parameters/tasks.get___query.timeout' - $ref: '#/components/parameters/tasks.get___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/tasks.get___200' /_tasks/{task_id}/_cancel: post: operationId: tasks.cancel.1 x-operation-group: tasks.cancel x-version-added: '1.0' description: Cancels a task, if it can be cancelled through an API. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: - $ref: '#/components/parameters/tasks.cancel___path.task_id' - $ref: '#/components/parameters/tasks.cancel___query.actions' - $ref: '#/components/parameters/tasks.cancel___query.nodes' - $ref: '#/components/parameters/tasks.cancel___query.parent_task_id' - $ref: '#/components/parameters/tasks.cancel___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/tasks.cancel___200' /_template: get: operationId: indices.get_template.0 x-operation-group: indices.get_template x-version-added: '1.0' description: Returns an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_template___query.flat_settings' - $ref: '#/components/parameters/indices.get_template___query.local' - $ref: '#/components/parameters/indices.get_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_template___200' /_template/{name}: delete: operationId: indices.delete_template.0 x-operation-group: indices.delete_template x-version-added: '1.0' description: Deletes an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.delete_template___path.name' - $ref: '#/components/parameters/indices.delete_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.delete_template___query.master_timeout' - $ref: '#/components/parameters/indices.delete_template___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete_template___200' get: operationId: indices.get_template.1 x-operation-group: indices.get_template x-version-added: '1.0' description: Returns an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_template___path.name' - $ref: '#/components/parameters/indices.get_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_template___query.flat_settings' - $ref: '#/components/parameters/indices.get_template___query.local' - $ref: '#/components/parameters/indices.get_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_template___200' head: operationId: indices.exists_template.0 x-operation-group: indices.exists_template x-version-added: '1.0' description: Returns information about whether a particular index template exists. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.exists_template___path.name' - $ref: '#/components/parameters/indices.exists_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.exists_template___query.flat_settings' - $ref: '#/components/parameters/indices.exists_template___query.local' - $ref: '#/components/parameters/indices.exists_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.exists_template___200' post: operationId: indices.put_template.0 x-operation-group: indices.put_template x-version-added: '1.0' description: Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.put_template___path.name' - $ref: '#/components/parameters/indices.put_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_template___query.create' - $ref: '#/components/parameters/indices.put_template___query.master_timeout' - $ref: '#/components/parameters/indices.put_template___query.order' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_template' responses: '200': $ref: '#/components/responses/indices.put_template___200' put: operationId: indices.put_template.1 x-operation-group: indices.put_template x-version-added: '1.0' description: Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - $ref: '#/components/parameters/indices.put_template___path.name' - $ref: '#/components/parameters/indices.put_template___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_template___query.create' - $ref: '#/components/parameters/indices.put_template___query.master_timeout' - $ref: '#/components/parameters/indices.put_template___query.order' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_template' responses: '200': $ref: '#/components/responses/indices.put_template___200' /_update_by_query/{task_id}/_rethrottle: post: operationId: update_by_query_rethrottle.0 x-operation-group: update_by_query_rethrottle x-version-added: '1.0' description: Changes the number of requests per second for a particular Update By Query operation. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/update_by_query_rethrottle___path.task_id' - $ref: '#/components/parameters/update_by_query_rethrottle___query.requests_per_second' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/update_by_query_rethrottle___200' /_upgrade: get: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_upgrade___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_upgrade___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_upgrade___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_upgrade___200' post: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.upgrade___query.allow_no_indices' - $ref: '#/components/parameters/indices.upgrade___query.expand_wildcards' - $ref: '#/components/parameters/indices.upgrade___query.ignore_unavailable' - $ref: '#/components/parameters/indices.upgrade___query.only_ancient_segments' - $ref: '#/components/parameters/indices.upgrade___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.upgrade___200' /_validate/query: get: operationId: indices.validate_query.0 x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query___query.all_shards' - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query___query.analyzer' - $ref: '#/components/parameters/indices.validate_query___query.default_operator' - $ref: '#/components/parameters/indices.validate_query___query.df' - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' - $ref: '#/components/parameters/indices.validate_query___query.explain' - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query___query.lenient' - $ref: '#/components/parameters/indices.validate_query___query.q' - $ref: '#/components/parameters/indices.validate_query___query.rewrite' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query___200' post: operationId: indices.validate_query.1 x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query___query.all_shards' - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query___query.analyzer' - $ref: '#/components/parameters/indices.validate_query___query.default_operator' - $ref: '#/components/parameters/indices.validate_query___query.df' - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' - $ref: '#/components/parameters/indices.validate_query___query.explain' - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query___query.lenient' - $ref: '#/components/parameters/indices.validate_query___query.q' - $ref: '#/components/parameters/indices.validate_query___query.rewrite' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query___200' /_wlm/query_group: get: operationId: wlm.get_query_group.0 x-operation-group: wlm.get_query_group x-version-added: '2.17' description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. responses: '200': $ref: '#/components/responses/wlm.get_query_group___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' put: operationId: wlm.create_query_group.0 x-operation-group: wlm.create_query_group x-version-added: '2.17' description: Creates a new query group and sets the resource limits for the new query group. requestBody: $ref: '#/components/requestBodies/wlm.create_query_group' responses: '200': $ref: '#/components/responses/wlm.create_query_group___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' /_wlm/query_group/{name}: delete: operationId: wlm.delete_query_group.0 x-operation-group: wlm.delete_query_group x-version-added: '2.17' description: Deletes the specified query group. parameters: - $ref: '#/components/parameters/wlm.delete_query_group___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/wlm.delete_query_group___200' get: operationId: wlm.get_query_group.1 x-operation-group: wlm.get_query_group x-version-added: '2.17' description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. parameters: - $ref: '#/components/parameters/wlm.get_query_group___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/wlm.get_query_group___200' put: operationId: wlm.update_query_group.0 x-operation-group: wlm.update_query_group x-version-added: '2.17' description: Updates the specified query group. parameters: - $ref: '#/components/parameters/wlm.update_query_group___path.name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/wlm.update_query_group' responses: '200': $ref: '#/components/responses/wlm.update_query_group___200' /{alias}/_rollover: post: operationId: indices.rollover.0 x-operation-group: indices.rollover x-version-added: '1.0' description: |- Updates an alias to point to a new index when the existing index is considered to be too large or too old. externalDocs: url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ parameters: - $ref: '#/components/parameters/indices.rollover___path.alias' - $ref: '#/components/parameters/indices.rollover___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.rollover___query.dry_run' - $ref: '#/components/parameters/indices.rollover___query.master_timeout' - $ref: '#/components/parameters/indices.rollover___query.timeout' - $ref: '#/components/parameters/indices.rollover___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.rollover' responses: '200': $ref: '#/components/responses/indices.rollover___200' /{alias}/_rollover/{new_index}: post: operationId: indices.rollover.1 x-operation-group: indices.rollover x-version-added: '1.0' description: |- Updates an alias to point to a new index when the existing index is considered to be too large or too old. externalDocs: url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ parameters: - $ref: '#/components/parameters/indices.rollover___path.alias' - $ref: '#/components/parameters/indices.rollover___path.new_index' - $ref: '#/components/parameters/indices.rollover___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.rollover___query.dry_run' - $ref: '#/components/parameters/indices.rollover___query.master_timeout' - $ref: '#/components/parameters/indices.rollover___query.timeout' - $ref: '#/components/parameters/indices.rollover___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.rollover' responses: '200': $ref: '#/components/responses/indices.rollover___200' /{index}: delete: operationId: indices.delete.0 x-operation-group: indices.delete x-version-added: '1.0' description: Deletes an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/ parameters: - $ref: '#/components/parameters/indices.delete___path.index' - $ref: '#/components/parameters/indices.delete___query.allow_no_indices' - $ref: '#/components/parameters/indices.delete___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.delete___query.expand_wildcards' - $ref: '#/components/parameters/indices.delete___query.ignore_unavailable' - $ref: '#/components/parameters/indices.delete___query.master_timeout' - $ref: '#/components/parameters/indices.delete___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete___200' '404': $ref: '#/components/responses/indices.delete___404' get: operationId: indices.get.0 x-operation-group: indices.get x-version-added: '1.0' description: Returns information about one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ parameters: - $ref: '#/components/parameters/indices.get___path.index' - $ref: '#/components/parameters/indices.get___query.allow_no_indices' - $ref: '#/components/parameters/indices.get___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get___query.expand_wildcards' - $ref: '#/components/parameters/indices.get___query.flat_settings' - $ref: '#/components/parameters/indices.get___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get___query.include_defaults' - $ref: '#/components/parameters/indices.get___query.local' - $ref: '#/components/parameters/indices.get___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get___200' head: operationId: indices.exists.0 x-operation-group: indices.exists x-version-added: '1.0' description: Returns information about whether a particular index exists. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/exists/ parameters: - $ref: '#/components/parameters/indices.exists___path.index' - $ref: '#/components/parameters/indices.exists___query.allow_no_indices' - $ref: '#/components/parameters/indices.exists___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.exists___query.expand_wildcards' - $ref: '#/components/parameters/indices.exists___query.flat_settings' - $ref: '#/components/parameters/indices.exists___query.ignore_unavailable' - $ref: '#/components/parameters/indices.exists___query.include_defaults' - $ref: '#/components/parameters/indices.exists___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.exists___200' '404': $ref: '#/components/responses/indices.exists___404' put: operationId: indices.create.0 x-operation-group: indices.create x-version-added: '1.0' description: Creates an index with optional settings and mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/create-index/ parameters: - $ref: '#/components/parameters/indices.create___path.index' - $ref: '#/components/parameters/indices.create___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.create___query.master_timeout' - $ref: '#/components/parameters/indices.create___query.timeout' - $ref: '#/components/parameters/indices.create___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.create' responses: '200': $ref: '#/components/responses/indices.create___200' '400': $ref: '#/components/responses/indices.create___400' '500': $ref: '#/components/responses/indices.create___500' /{index}/_alias: get: operationId: indices.get_alias.2 x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - $ref: '#/components/parameters/indices.get_alias___path.index' - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_alias___200' '404': $ref: '#/components/responses/indices.get_alias___404' put: operationId: indices.put_alias.5 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /{index}/_alias/{name}: delete: operationId: indices.delete_alias.0 x-operation-group: indices.delete_alias x-version-added: '1.0' description: Deletes an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: - $ref: '#/components/parameters/indices.delete_alias___path.index' - $ref: '#/components/parameters/indices.delete_alias___path.name' - $ref: '#/components/parameters/indices.delete_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.delete_alias___query.master_timeout' - $ref: '#/components/parameters/indices.delete_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete_alias___200' get: operationId: indices.get_alias.3 x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - $ref: '#/components/parameters/indices.get_alias___path.index' - $ref: '#/components/parameters/indices.get_alias___path.name' - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_alias___200' '404': $ref: '#/components/responses/indices.get_alias___404' head: operationId: indices.exists_alias.1 x-operation-group: indices.exists_alias x-version-added: '1.0' description: Returns information about whether a particular alias exists. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.exists_alias___path.index' - $ref: '#/components/parameters/indices.exists_alias___path.name' - $ref: '#/components/parameters/indices.exists_alias___query.allow_no_indices' - $ref: '#/components/parameters/indices.exists_alias___query.expand_wildcards' - $ref: '#/components/parameters/indices.exists_alias___query.ignore_unavailable' - $ref: '#/components/parameters/indices.exists_alias___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.exists_alias___200' '404': $ref: '#/components/responses/indices.exists_alias___404' post: operationId: indices.put_alias.6 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.7 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /{index}/_aliases: put: operationId: indices.put_alias.8 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /{index}/_aliases/{name}: delete: operationId: indices.delete_alias.1 x-operation-group: indices.delete_alias x-version-added: '1.0' description: Deletes an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: - $ref: '#/components/parameters/indices.delete_alias___path.index' - $ref: '#/components/parameters/indices.delete_alias___path.name' - $ref: '#/components/parameters/indices.delete_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.delete_alias___query.master_timeout' - $ref: '#/components/parameters/indices.delete_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.delete_alias___200' post: operationId: indices.put_alias.9 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.10 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias___path.index' - $ref: '#/components/parameters/indices.put_alias___path.name' - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' - $ref: '#/components/parameters/indices.put_alias___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias___200' /{index}/_analyze: get: operationId: indices.analyze.2 x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - $ref: '#/components/parameters/indices.analyze___path.index' - $ref: '#/components/parameters/indices.analyze___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze___200' post: operationId: indices.analyze.3 x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - $ref: '#/components/parameters/indices.analyze___path.index' - $ref: '#/components/parameters/indices.analyze___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze___200' /{index}/_block/{block}: put: operationId: indices.add_block.0 x-operation-group: indices.add_block x-version-added: '1.0' description: Adds a block to an index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.add_block___path.block' - $ref: '#/components/parameters/indices.add_block___path.index' - $ref: '#/components/parameters/indices.add_block___query.allow_no_indices' - $ref: '#/components/parameters/indices.add_block___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.add_block___query.expand_wildcards' - $ref: '#/components/parameters/indices.add_block___query.ignore_unavailable' - $ref: '#/components/parameters/indices.add_block___query.master_timeout' - $ref: '#/components/parameters/indices.add_block___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.add_block___200' /{index}/_bulk: post: operationId: bulk.2 x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk___path.index' - $ref: '#/components/parameters/bulk___query._source' - $ref: '#/components/parameters/bulk___query._source_excludes' - $ref: '#/components/parameters/bulk___query._source_includes' - $ref: '#/components/parameters/bulk___query.index' - $ref: '#/components/parameters/bulk___query.pipeline' - $ref: '#/components/parameters/bulk___query.refresh' - $ref: '#/components/parameters/bulk___query.require_alias' - $ref: '#/components/parameters/bulk___query.routing' - $ref: '#/components/parameters/bulk___query.timeout' - $ref: '#/components/parameters/bulk___query.type' - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk' responses: '200': $ref: '#/components/responses/bulk___200' put: operationId: bulk.3 x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk___path.index' - $ref: '#/components/parameters/bulk___query._source' - $ref: '#/components/parameters/bulk___query._source_excludes' - $ref: '#/components/parameters/bulk___query._source_includes' - $ref: '#/components/parameters/bulk___query.index' - $ref: '#/components/parameters/bulk___query.pipeline' - $ref: '#/components/parameters/bulk___query.refresh' - $ref: '#/components/parameters/bulk___query.require_alias' - $ref: '#/components/parameters/bulk___query.routing' - $ref: '#/components/parameters/bulk___query.timeout' - $ref: '#/components/parameters/bulk___query.type' - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk' responses: '200': $ref: '#/components/responses/bulk___200' /{index}/_bulk/stream: post: operationId: bulk_stream.2 x-operation-group: bulk_stream x-version-added: '2.17' description: Allows to perform multiple index/update/delete operations using request response streaming. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - $ref: '#/components/parameters/bulk_stream___path.index' - $ref: '#/components/parameters/bulk_stream___query._source' - $ref: '#/components/parameters/bulk_stream___query._source_excludes' - $ref: '#/components/parameters/bulk_stream___query._source_includes' - $ref: '#/components/parameters/bulk_stream___query.batch_interval' - $ref: '#/components/parameters/bulk_stream___query.batch_size' - $ref: '#/components/parameters/bulk_stream___query.pipeline' - $ref: '#/components/parameters/bulk_stream___query.refresh' - $ref: '#/components/parameters/bulk_stream___query.require_alias' - $ref: '#/components/parameters/bulk_stream___query.routing' - $ref: '#/components/parameters/bulk_stream___query.timeout' - $ref: '#/components/parameters/bulk_stream___query.type' - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk_stream' responses: '200': $ref: '#/components/responses/bulk_stream___200' put: operationId: bulk_stream.3 x-operation-group: bulk_stream x-version-added: '2.17' description: Allows to perform multiple index/update/delete operations using request response streaming. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - $ref: '#/components/parameters/bulk_stream___path.index' - $ref: '#/components/parameters/bulk_stream___query._source' - $ref: '#/components/parameters/bulk_stream___query._source_excludes' - $ref: '#/components/parameters/bulk_stream___query._source_includes' - $ref: '#/components/parameters/bulk_stream___query.batch_interval' - $ref: '#/components/parameters/bulk_stream___query.batch_size' - $ref: '#/components/parameters/bulk_stream___query.pipeline' - $ref: '#/components/parameters/bulk_stream___query.refresh' - $ref: '#/components/parameters/bulk_stream___query.require_alias' - $ref: '#/components/parameters/bulk_stream___query.routing' - $ref: '#/components/parameters/bulk_stream___query.timeout' - $ref: '#/components/parameters/bulk_stream___query.type' - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/bulk_stream' responses: '200': $ref: '#/components/responses/bulk_stream___200' /{index}/_cache/clear: post: operationId: indices.clear_cache.1 x-operation-group: indices.clear_cache x-version-added: '1.0' description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: - $ref: '#/components/parameters/indices.clear_cache___path.index' - $ref: '#/components/parameters/indices.clear_cache___query.allow_no_indices' - $ref: '#/components/parameters/indices.clear_cache___query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache___query.fielddata' - $ref: '#/components/parameters/indices.clear_cache___query.fields' - $ref: '#/components/parameters/indices.clear_cache___query.file' - $ref: '#/components/parameters/indices.clear_cache___query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache___query.index' - $ref: '#/components/parameters/indices.clear_cache___query.query' - $ref: '#/components/parameters/indices.clear_cache___query.request' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.clear_cache___200' /{index}/_clone/{target}: post: operationId: indices.clone.0 x-operation-group: indices.clone x-version-added: '1.0' description: Clones an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: - $ref: '#/components/parameters/indices.clone___path.index' - $ref: '#/components/parameters/indices.clone___path.target' - $ref: '#/components/parameters/indices.clone___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.clone___query.master_timeout' - $ref: '#/components/parameters/indices.clone___query.task_execution_timeout' - $ref: '#/components/parameters/indices.clone___query.timeout' - $ref: '#/components/parameters/indices.clone___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.clone___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.clone' responses: '200': $ref: '#/components/responses/indices.clone___200' put: operationId: indices.clone.1 x-operation-group: indices.clone x-version-added: '1.0' description: Clones an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: - $ref: '#/components/parameters/indices.clone___path.index' - $ref: '#/components/parameters/indices.clone___path.target' - $ref: '#/components/parameters/indices.clone___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.clone___query.master_timeout' - $ref: '#/components/parameters/indices.clone___query.task_execution_timeout' - $ref: '#/components/parameters/indices.clone___query.timeout' - $ref: '#/components/parameters/indices.clone___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.clone___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.clone' responses: '200': $ref: '#/components/responses/indices.clone___200' /{index}/_close: post: operationId: indices.close.0 x-operation-group: indices.close x-version-added: '1.0' description: Closes an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/close-index/ parameters: - $ref: '#/components/parameters/indices.close___path.index' - $ref: '#/components/parameters/indices.close___query.allow_no_indices' - $ref: '#/components/parameters/indices.close___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.close___query.expand_wildcards' - $ref: '#/components/parameters/indices.close___query.ignore_unavailable' - $ref: '#/components/parameters/indices.close___query.master_timeout' - $ref: '#/components/parameters/indices.close___query.timeout' - $ref: '#/components/parameters/indices.close___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.close___200' /{index}/_count: get: operationId: count.2 x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count___path.index' - $ref: '#/components/parameters/count___query.allow_no_indices' - $ref: '#/components/parameters/count___query.analyze_wildcard' - $ref: '#/components/parameters/count___query.analyzer' - $ref: '#/components/parameters/count___query.default_operator' - $ref: '#/components/parameters/count___query.df' - $ref: '#/components/parameters/count___query.expand_wildcards' - $ref: '#/components/parameters/count___query.ignore_throttled' - $ref: '#/components/parameters/count___query.ignore_unavailable' - $ref: '#/components/parameters/count___query.lenient' - $ref: '#/components/parameters/count___query.min_score' - $ref: '#/components/parameters/count___query.preference' - $ref: '#/components/parameters/count___query.q' - $ref: '#/components/parameters/count___query.routing' - $ref: '#/components/parameters/count___query.terminate_after' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/count' responses: '200': $ref: '#/components/responses/count___200' post: operationId: count.3 x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count___path.index' - $ref: '#/components/parameters/count___query.allow_no_indices' - $ref: '#/components/parameters/count___query.analyze_wildcard' - $ref: '#/components/parameters/count___query.analyzer' - $ref: '#/components/parameters/count___query.default_operator' - $ref: '#/components/parameters/count___query.df' - $ref: '#/components/parameters/count___query.expand_wildcards' - $ref: '#/components/parameters/count___query.ignore_throttled' - $ref: '#/components/parameters/count___query.ignore_unavailable' - $ref: '#/components/parameters/count___query.lenient' - $ref: '#/components/parameters/count___query.min_score' - $ref: '#/components/parameters/count___query.preference' - $ref: '#/components/parameters/count___query.q' - $ref: '#/components/parameters/count___query.routing' - $ref: '#/components/parameters/count___query.terminate_after' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/count' responses: '200': $ref: '#/components/responses/count___200' /{index}/_create/{id}: post: operationId: create.0 x-operation-group: create x-version-added: '1.0' description: |- Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/create___path.id' - $ref: '#/components/parameters/create___path.index' - $ref: '#/components/parameters/create___query.pipeline' - $ref: '#/components/parameters/create___query.refresh' - $ref: '#/components/parameters/create___query.routing' - $ref: '#/components/parameters/create___query.timeout' - $ref: '#/components/parameters/create___query.version' - $ref: '#/components/parameters/create___query.version_type' - $ref: '#/components/parameters/create___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/create' responses: '201': $ref: '#/components/responses/create___201' put: operationId: create.1 x-operation-group: create x-version-added: '1.0' description: |- Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/create___path.id' - $ref: '#/components/parameters/create___path.index' - $ref: '#/components/parameters/create___query.pipeline' - $ref: '#/components/parameters/create___query.refresh' - $ref: '#/components/parameters/create___query.routing' - $ref: '#/components/parameters/create___query.timeout' - $ref: '#/components/parameters/create___query.version' - $ref: '#/components/parameters/create___query.version_type' - $ref: '#/components/parameters/create___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/create' responses: '201': $ref: '#/components/responses/create___201' /{index}/_delete_by_query: post: operationId: delete_by_query.0 x-operation-group: delete_by_query x-version-added: '1.0' description: Deletes documents matching the provided query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/ parameters: - $ref: '#/components/parameters/delete_by_query___path.index' - $ref: '#/components/parameters/delete_by_query___query._source' - $ref: '#/components/parameters/delete_by_query___query._source_excludes' - $ref: '#/components/parameters/delete_by_query___query._source_includes' - $ref: '#/components/parameters/delete_by_query___query.allow_no_indices' - $ref: '#/components/parameters/delete_by_query___query.analyze_wildcard' - $ref: '#/components/parameters/delete_by_query___query.analyzer' - $ref: '#/components/parameters/delete_by_query___query.conflicts' - $ref: '#/components/parameters/delete_by_query___query.default_operator' - $ref: '#/components/parameters/delete_by_query___query.df' - $ref: '#/components/parameters/delete_by_query___query.expand_wildcards' - $ref: '#/components/parameters/delete_by_query___query.from' - $ref: '#/components/parameters/delete_by_query___query.ignore_unavailable' - $ref: '#/components/parameters/delete_by_query___query.lenient' - $ref: '#/components/parameters/delete_by_query___query.max_docs' - $ref: '#/components/parameters/delete_by_query___query.preference' - $ref: '#/components/parameters/delete_by_query___query.q' - $ref: '#/components/parameters/delete_by_query___query.refresh' - $ref: '#/components/parameters/delete_by_query___query.request_cache' - $ref: '#/components/parameters/delete_by_query___query.requests_per_second' - $ref: '#/components/parameters/delete_by_query___query.routing' - $ref: '#/components/parameters/delete_by_query___query.scroll' - $ref: '#/components/parameters/delete_by_query___query.scroll_size' - $ref: '#/components/parameters/delete_by_query___query.search_timeout' - $ref: '#/components/parameters/delete_by_query___query.search_type' - $ref: '#/components/parameters/delete_by_query___query.size' - $ref: '#/components/parameters/delete_by_query___query.slices' - $ref: '#/components/parameters/delete_by_query___query.sort' - $ref: '#/components/parameters/delete_by_query___query.stats' - $ref: '#/components/parameters/delete_by_query___query.terminate_after' - $ref: '#/components/parameters/delete_by_query___query.timeout' - $ref: '#/components/parameters/delete_by_query___query.version' - $ref: '#/components/parameters/delete_by_query___query.wait_for_active_shards' - $ref: '#/components/parameters/delete_by_query___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/delete_by_query' responses: '200': $ref: '#/components/responses/delete_by_query___200' /{index}/_doc: post: operationId: index.0 x-operation-group: index x-version-added: '1.0' description: Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/index___path.index' - $ref: '#/components/parameters/index___query.if_primary_term' - $ref: '#/components/parameters/index___query.if_seq_no' - $ref: '#/components/parameters/index___query.op_type' - $ref: '#/components/parameters/index___query.pipeline' - $ref: '#/components/parameters/index___query.refresh' - $ref: '#/components/parameters/index___query.require_alias' - $ref: '#/components/parameters/index___query.routing' - $ref: '#/components/parameters/index___query.timeout' - $ref: '#/components/parameters/index___query.version' - $ref: '#/components/parameters/index___query.version_type' - $ref: '#/components/parameters/index___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/index' responses: '200': $ref: '#/components/responses/index___200' '201': $ref: '#/components/responses/index___201' /{index}/_doc/{id}: delete: operationId: delete.0 x-operation-group: delete x-version-added: '1.0' description: Removes a document from the index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/ parameters: - $ref: '#/components/parameters/delete___path.id' - $ref: '#/components/parameters/delete___path.index' - $ref: '#/components/parameters/delete___query.if_primary_term' - $ref: '#/components/parameters/delete___query.if_seq_no' - $ref: '#/components/parameters/delete___query.refresh' - $ref: '#/components/parameters/delete___query.routing' - $ref: '#/components/parameters/delete___query.timeout' - $ref: '#/components/parameters/delete___query.version' - $ref: '#/components/parameters/delete___query.version_type' - $ref: '#/components/parameters/delete___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/delete___200' '404': $ref: '#/components/responses/delete___404' get: operationId: get.0 x-operation-group: get x-version-added: '1.0' description: Returns a document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - $ref: '#/components/parameters/get___path.id' - $ref: '#/components/parameters/get___path.index' - $ref: '#/components/parameters/get___query._source' - $ref: '#/components/parameters/get___query._source_excludes' - $ref: '#/components/parameters/get___query._source_includes' - $ref: '#/components/parameters/get___query.preference' - $ref: '#/components/parameters/get___query.realtime' - $ref: '#/components/parameters/get___query.refresh' - $ref: '#/components/parameters/get___query.routing' - $ref: '#/components/parameters/get___query.stored_fields' - $ref: '#/components/parameters/get___query.version' - $ref: '#/components/parameters/get___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/get___200' '404': $ref: '#/components/responses/get___404' head: operationId: exists.0 x-operation-group: exists x-version-added: '1.0' description: Returns information about whether a document exists in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - $ref: '#/components/parameters/exists___path.id' - $ref: '#/components/parameters/exists___path.index' - $ref: '#/components/parameters/exists___query._source' - $ref: '#/components/parameters/exists___query._source_excludes' - $ref: '#/components/parameters/exists___query._source_includes' - $ref: '#/components/parameters/exists___query.preference' - $ref: '#/components/parameters/exists___query.realtime' - $ref: '#/components/parameters/exists___query.refresh' - $ref: '#/components/parameters/exists___query.routing' - $ref: '#/components/parameters/exists___query.stored_fields' - $ref: '#/components/parameters/exists___query.version' - $ref: '#/components/parameters/exists___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/exists___200' '404': $ref: '#/components/responses/exists___404' post: operationId: index.1 x-operation-group: index x-version-added: '1.0' description: Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/index___path.id' - $ref: '#/components/parameters/index___path.index' - $ref: '#/components/parameters/index___query.if_primary_term' - $ref: '#/components/parameters/index___query.if_seq_no' - $ref: '#/components/parameters/index___query.op_type' - $ref: '#/components/parameters/index___query.pipeline' - $ref: '#/components/parameters/index___query.refresh' - $ref: '#/components/parameters/index___query.require_alias' - $ref: '#/components/parameters/index___query.routing' - $ref: '#/components/parameters/index___query.timeout' - $ref: '#/components/parameters/index___query.version' - $ref: '#/components/parameters/index___query.version_type' - $ref: '#/components/parameters/index___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/index' responses: '200': $ref: '#/components/responses/index___200' '201': $ref: '#/components/responses/index___201' put: operationId: index.2 x-operation-group: index x-version-added: '1.0' description: Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/index___path.id' - $ref: '#/components/parameters/index___path.index' - $ref: '#/components/parameters/index___query.if_primary_term' - $ref: '#/components/parameters/index___query.if_seq_no' - $ref: '#/components/parameters/index___query.op_type' - $ref: '#/components/parameters/index___query.pipeline' - $ref: '#/components/parameters/index___query.refresh' - $ref: '#/components/parameters/index___query.require_alias' - $ref: '#/components/parameters/index___query.routing' - $ref: '#/components/parameters/index___query.timeout' - $ref: '#/components/parameters/index___query.version' - $ref: '#/components/parameters/index___query.version_type' - $ref: '#/components/parameters/index___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/index' responses: '200': $ref: '#/components/responses/index___200' '201': $ref: '#/components/responses/index___201' /{index}/_explain/{id}: get: operationId: explain.0 x-operation-group: explain x-version-added: '1.0' description: Returns information about why a specific document matches (or doesn't match) a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: - $ref: '#/components/parameters/explain___path.id' - $ref: '#/components/parameters/explain___path.index' - $ref: '#/components/parameters/explain___query._source' - $ref: '#/components/parameters/explain___query._source_excludes' - $ref: '#/components/parameters/explain___query._source_includes' - $ref: '#/components/parameters/explain___query.analyze_wildcard' - $ref: '#/components/parameters/explain___query.analyzer' - $ref: '#/components/parameters/explain___query.default_operator' - $ref: '#/components/parameters/explain___query.df' - $ref: '#/components/parameters/explain___query.lenient' - $ref: '#/components/parameters/explain___query.preference' - $ref: '#/components/parameters/explain___query.q' - $ref: '#/components/parameters/explain___query.routing' - $ref: '#/components/parameters/explain___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/explain' responses: '200': $ref: '#/components/responses/explain___200' post: operationId: explain.1 x-operation-group: explain x-version-added: '1.0' description: Returns information about why a specific document matches (or doesn't match) a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: - $ref: '#/components/parameters/explain___path.id' - $ref: '#/components/parameters/explain___path.index' - $ref: '#/components/parameters/explain___query._source' - $ref: '#/components/parameters/explain___query._source_excludes' - $ref: '#/components/parameters/explain___query._source_includes' - $ref: '#/components/parameters/explain___query.analyze_wildcard' - $ref: '#/components/parameters/explain___query.analyzer' - $ref: '#/components/parameters/explain___query.default_operator' - $ref: '#/components/parameters/explain___query.df' - $ref: '#/components/parameters/explain___query.lenient' - $ref: '#/components/parameters/explain___query.preference' - $ref: '#/components/parameters/explain___query.q' - $ref: '#/components/parameters/explain___query.routing' - $ref: '#/components/parameters/explain___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/explain' responses: '200': $ref: '#/components/responses/explain___200' /{index}/_field_caps: get: operationId: field_caps.2 x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - $ref: '#/components/parameters/field_caps___path.index' - $ref: '#/components/parameters/field_caps___query.allow_no_indices' - $ref: '#/components/parameters/field_caps___query.expand_wildcards' - $ref: '#/components/parameters/field_caps___query.fields' - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' - $ref: '#/components/parameters/field_caps___query.include_unmapped' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/field_caps' responses: '200': $ref: '#/components/responses/field_caps___200' post: operationId: field_caps.3 x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - $ref: '#/components/parameters/field_caps___path.index' - $ref: '#/components/parameters/field_caps___query.allow_no_indices' - $ref: '#/components/parameters/field_caps___query.expand_wildcards' - $ref: '#/components/parameters/field_caps___query.fields' - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' - $ref: '#/components/parameters/field_caps___query.include_unmapped' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/field_caps' responses: '200': $ref: '#/components/responses/field_caps___200' /{index}/_flush: get: operationId: indices.flush.2 x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush___path.index' - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' - $ref: '#/components/parameters/indices.flush___query.force' - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.flush___200' post: operationId: indices.flush.3 x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush___path.index' - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' - $ref: '#/components/parameters/indices.flush___query.force' - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.flush___200' /{index}/_forcemerge: post: operationId: indices.forcemerge.1 x-operation-group: indices.forcemerge x-version-added: '1.0' description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.forcemerge___path.index' - $ref: '#/components/parameters/indices.forcemerge___query.allow_no_indices' - $ref: '#/components/parameters/indices.forcemerge___query.expand_wildcards' - $ref: '#/components/parameters/indices.forcemerge___query.flush' - $ref: '#/components/parameters/indices.forcemerge___query.ignore_unavailable' - $ref: '#/components/parameters/indices.forcemerge___query.max_num_segments' - $ref: '#/components/parameters/indices.forcemerge___query.only_expunge_deletes' - $ref: '#/components/parameters/indices.forcemerge___query.primary_only' - $ref: '#/components/parameters/indices.forcemerge___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.forcemerge___200' /{index}/_mapping: get: operationId: indices.get_mapping.1 x-operation-group: indices.get_mapping x-version-added: '1.0' description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: - $ref: '#/components/parameters/indices.get_mapping___path.index' - $ref: '#/components/parameters/indices.get_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_mapping___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping___query.index' - $ref: '#/components/parameters/indices.get_mapping___query.local' - $ref: '#/components/parameters/indices.get_mapping___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_mapping___200' post: operationId: indices.put_mapping.0 x-operation-group: indices.put_mapping x-version-added: '1.0' description: Updates the index mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: - $ref: '#/components/parameters/indices.put_mapping___path.index' - $ref: '#/components/parameters/indices.put_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.put_mapping___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.put_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.put_mapping___query.master_timeout' - $ref: '#/components/parameters/indices.put_mapping___query.timeout' - $ref: '#/components/parameters/indices.put_mapping___query.write_index_only' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_mapping' responses: '200': $ref: '#/components/responses/indices.put_mapping___200' put: operationId: indices.put_mapping.1 x-operation-group: indices.put_mapping x-version-added: '1.0' description: Updates the index mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: - $ref: '#/components/parameters/indices.put_mapping___path.index' - $ref: '#/components/parameters/indices.put_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.put_mapping___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.put_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.put_mapping___query.master_timeout' - $ref: '#/components/parameters/indices.put_mapping___query.timeout' - $ref: '#/components/parameters/indices.put_mapping___query.write_index_only' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_mapping' responses: '200': $ref: '#/components/responses/indices.put_mapping___200' /{index}/_mapping/field/{fields}: get: operationId: indices.get_field_mapping.1 x-operation-group: indices.get_field_mapping x-version-added: '1.0' description: Returns mapping for one or more fields. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: - $ref: '#/components/parameters/indices.get_field_mapping___path.fields' - $ref: '#/components/parameters/indices.get_field_mapping___path.index' - $ref: '#/components/parameters/indices.get_field_mapping___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_field_mapping___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_field_mapping___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_field_mapping___query.include_defaults' - $ref: '#/components/parameters/indices.get_field_mapping___query.local' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_field_mapping___200' /{index}/_mget: get: operationId: mget.2 x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - $ref: '#/components/parameters/mget___path.index' - $ref: '#/components/parameters/mget___query._source' - $ref: '#/components/parameters/mget___query._source_excludes' - $ref: '#/components/parameters/mget___query._source_includes' - $ref: '#/components/parameters/mget___query.preference' - $ref: '#/components/parameters/mget___query.realtime' - $ref: '#/components/parameters/mget___query.refresh' - $ref: '#/components/parameters/mget___query.routing' - $ref: '#/components/parameters/mget___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mget' responses: '200': $ref: '#/components/responses/mget___200' post: operationId: mget.3 x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - $ref: '#/components/parameters/mget___path.index' - $ref: '#/components/parameters/mget___query._source' - $ref: '#/components/parameters/mget___query._source_excludes' - $ref: '#/components/parameters/mget___query._source_includes' - $ref: '#/components/parameters/mget___query.preference' - $ref: '#/components/parameters/mget___query.realtime' - $ref: '#/components/parameters/mget___query.refresh' - $ref: '#/components/parameters/mget___query.routing' - $ref: '#/components/parameters/mget___query.stored_fields' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mget' responses: '200': $ref: '#/components/responses/mget___200' /{index}/_msearch: get: operationId: msearch.2 x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch___path.index' - $ref: '#/components/parameters/msearch___query.allow_partial_results' - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch___query.search_type' - $ref: '#/components/parameters/msearch___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch' responses: '200': $ref: '#/components/responses/msearch___200' post: operationId: msearch.3 x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch___path.index' - $ref: '#/components/parameters/msearch___query.allow_partial_results' - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch___query.search_type' - $ref: '#/components/parameters/msearch___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch' responses: '200': $ref: '#/components/responses/msearch___200' /{index}/_msearch/template: get: operationId: msearch_template.2 x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/msearch_template___path.index' - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch_template___query.search_type' - $ref: '#/components/parameters/msearch_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch_template' responses: '200': $ref: '#/components/responses/msearch_template___200' post: operationId: msearch_template.3 x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/msearch_template___path.index' - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/msearch_template___query.search_type' - $ref: '#/components/parameters/msearch_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/msearch_template' responses: '200': $ref: '#/components/responses/msearch_template___200' /{index}/_mtermvectors: get: operationId: mtermvectors.2 x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors___path.index' - $ref: '#/components/parameters/mtermvectors___query.field_statistics' - $ref: '#/components/parameters/mtermvectors___query.fields' - $ref: '#/components/parameters/mtermvectors___query.ids' - $ref: '#/components/parameters/mtermvectors___query.offsets' - $ref: '#/components/parameters/mtermvectors___query.payloads' - $ref: '#/components/parameters/mtermvectors___query.positions' - $ref: '#/components/parameters/mtermvectors___query.preference' - $ref: '#/components/parameters/mtermvectors___query.realtime' - $ref: '#/components/parameters/mtermvectors___query.routing' - $ref: '#/components/parameters/mtermvectors___query.term_statistics' - $ref: '#/components/parameters/mtermvectors___query.version' - $ref: '#/components/parameters/mtermvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': $ref: '#/components/responses/mtermvectors___200' post: operationId: mtermvectors.3 x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors___path.index' - $ref: '#/components/parameters/mtermvectors___query.field_statistics' - $ref: '#/components/parameters/mtermvectors___query.fields' - $ref: '#/components/parameters/mtermvectors___query.ids' - $ref: '#/components/parameters/mtermvectors___query.offsets' - $ref: '#/components/parameters/mtermvectors___query.payloads' - $ref: '#/components/parameters/mtermvectors___query.positions' - $ref: '#/components/parameters/mtermvectors___query.preference' - $ref: '#/components/parameters/mtermvectors___query.realtime' - $ref: '#/components/parameters/mtermvectors___query.routing' - $ref: '#/components/parameters/mtermvectors___query.term_statistics' - $ref: '#/components/parameters/mtermvectors___query.version' - $ref: '#/components/parameters/mtermvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': $ref: '#/components/responses/mtermvectors___200' /{index}/_open: post: operationId: indices.open.0 x-operation-group: indices.open x-version-added: '1.0' description: Opens an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/open-index/ parameters: - $ref: '#/components/parameters/indices.open___path.index' - $ref: '#/components/parameters/indices.open___query.allow_no_indices' - $ref: '#/components/parameters/indices.open___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.open___query.expand_wildcards' - $ref: '#/components/parameters/indices.open___query.ignore_unavailable' - $ref: '#/components/parameters/indices.open___query.master_timeout' - $ref: '#/components/parameters/indices.open___query.task_execution_timeout' - $ref: '#/components/parameters/indices.open___query.timeout' - $ref: '#/components/parameters/indices.open___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.open___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.open___200' /{index}/_rank_eval: get: operationId: rank_eval.2 x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - $ref: '#/components/parameters/rank_eval___path.index' - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' - $ref: '#/components/parameters/rank_eval___query.search_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': $ref: '#/components/responses/rank_eval___200' post: operationId: rank_eval.3 x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - $ref: '#/components/parameters/rank_eval___path.index' - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' - $ref: '#/components/parameters/rank_eval___query.search_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': $ref: '#/components/responses/rank_eval___200' /{index}/_recovery: get: operationId: indices.recovery.1 x-operation-group: indices.recovery x-version-added: '1.0' description: Returns information about ongoing index shard recoveries. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.recovery___path.index' - $ref: '#/components/parameters/indices.recovery___query.active_only' - $ref: '#/components/parameters/indices.recovery___query.detailed' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.recovery___200' /{index}/_refresh: get: operationId: indices.refresh.2 x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - $ref: '#/components/parameters/indices.refresh___path.index' - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.refresh___200' post: operationId: indices.refresh.3 x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - $ref: '#/components/parameters/indices.refresh___path.index' - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.refresh___200' /{index}/_search: get: operationId: search.2 x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search___path.index' - $ref: '#/components/parameters/search___query._source' - $ref: '#/components/parameters/search___query._source_excludes' - $ref: '#/components/parameters/search___query._source_includes' - $ref: '#/components/parameters/search___query.allow_no_indices' - $ref: '#/components/parameters/search___query.allow_partial_search_results' - $ref: '#/components/parameters/search___query.analyze_wildcard' - $ref: '#/components/parameters/search___query.analyzer' - $ref: '#/components/parameters/search___query.batched_reduce_size' - $ref: '#/components/parameters/search___query.cancel_after_time_interval' - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search___query.default_operator' - $ref: '#/components/parameters/search___query.df' - $ref: '#/components/parameters/search___query.docvalue_fields' - $ref: '#/components/parameters/search___query.expand_wildcards' - $ref: '#/components/parameters/search___query.explain' - $ref: '#/components/parameters/search___query.from' - $ref: '#/components/parameters/search___query.ignore_throttled' - $ref: '#/components/parameters/search___query.ignore_unavailable' - $ref: '#/components/parameters/search___query.include_named_queries_score' - $ref: '#/components/parameters/search___query.index' - $ref: '#/components/parameters/search___query.lenient' - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/search___query.phase_took' - $ref: '#/components/parameters/search___query.pre_filter_shard_size' - $ref: '#/components/parameters/search___query.preference' - $ref: '#/components/parameters/search___query.q' - $ref: '#/components/parameters/search___query.request_cache' - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search___query.routing' - $ref: '#/components/parameters/search___query.scroll' - $ref: '#/components/parameters/search___query.search_pipeline' - $ref: '#/components/parameters/search___query.search_type' - $ref: '#/components/parameters/search___query.seq_no_primary_term' - $ref: '#/components/parameters/search___query.size' - $ref: '#/components/parameters/search___query.sort' - $ref: '#/components/parameters/search___query.stats' - $ref: '#/components/parameters/search___query.stored_fields' - $ref: '#/components/parameters/search___query.suggest_field' - $ref: '#/components/parameters/search___query.suggest_mode' - $ref: '#/components/parameters/search___query.suggest_size' - $ref: '#/components/parameters/search___query.suggest_text' - $ref: '#/components/parameters/search___query.terminate_after' - $ref: '#/components/parameters/search___query.timeout' - $ref: '#/components/parameters/search___query.track_scores' - $ref: '#/components/parameters/search___query.track_total_hits' - $ref: '#/components/parameters/search___query.typed_keys' - $ref: '#/components/parameters/search___query.verbose_pipeline' - $ref: '#/components/parameters/search___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search' responses: '200': $ref: '#/components/responses/search___200' '400': $ref: '#/components/responses/search___400' '404': $ref: '#/components/responses/search___404' post: operationId: search.3 x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search___path.index' - $ref: '#/components/parameters/search___query._source' - $ref: '#/components/parameters/search___query._source_excludes' - $ref: '#/components/parameters/search___query._source_includes' - $ref: '#/components/parameters/search___query.allow_no_indices' - $ref: '#/components/parameters/search___query.allow_partial_search_results' - $ref: '#/components/parameters/search___query.analyze_wildcard' - $ref: '#/components/parameters/search___query.analyzer' - $ref: '#/components/parameters/search___query.batched_reduce_size' - $ref: '#/components/parameters/search___query.cancel_after_time_interval' - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search___query.default_operator' - $ref: '#/components/parameters/search___query.df' - $ref: '#/components/parameters/search___query.docvalue_fields' - $ref: '#/components/parameters/search___query.expand_wildcards' - $ref: '#/components/parameters/search___query.explain' - $ref: '#/components/parameters/search___query.from' - $ref: '#/components/parameters/search___query.ignore_throttled' - $ref: '#/components/parameters/search___query.ignore_unavailable' - $ref: '#/components/parameters/search___query.include_named_queries_score' - $ref: '#/components/parameters/search___query.index' - $ref: '#/components/parameters/search___query.lenient' - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' - $ref: '#/components/parameters/search___query.phase_took' - $ref: '#/components/parameters/search___query.pre_filter_shard_size' - $ref: '#/components/parameters/search___query.preference' - $ref: '#/components/parameters/search___query.q' - $ref: '#/components/parameters/search___query.request_cache' - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search___query.routing' - $ref: '#/components/parameters/search___query.scroll' - $ref: '#/components/parameters/search___query.search_pipeline' - $ref: '#/components/parameters/search___query.search_type' - $ref: '#/components/parameters/search___query.seq_no_primary_term' - $ref: '#/components/parameters/search___query.size' - $ref: '#/components/parameters/search___query.sort' - $ref: '#/components/parameters/search___query.stats' - $ref: '#/components/parameters/search___query.stored_fields' - $ref: '#/components/parameters/search___query.suggest_field' - $ref: '#/components/parameters/search___query.suggest_mode' - $ref: '#/components/parameters/search___query.suggest_size' - $ref: '#/components/parameters/search___query.suggest_text' - $ref: '#/components/parameters/search___query.terminate_after' - $ref: '#/components/parameters/search___query.timeout' - $ref: '#/components/parameters/search___query.track_scores' - $ref: '#/components/parameters/search___query.track_total_hits' - $ref: '#/components/parameters/search___query.typed_keys' - $ref: '#/components/parameters/search___query.verbose_pipeline' - $ref: '#/components/parameters/search___query.version' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search' responses: '200': $ref: '#/components/responses/search___200' '400': $ref: '#/components/responses/search___400' '404': $ref: '#/components/responses/search___404' /{index}/_search_shards: get: operationId: search_shards.2 x-operation-group: search_shards x-version-added: '1.0' description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/search_shards___path.index' - $ref: '#/components/parameters/search_shards___query.allow_no_indices' - $ref: '#/components/parameters/search_shards___query.expand_wildcards' - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' - $ref: '#/components/parameters/search_shards___query.local' - $ref: '#/components/parameters/search_shards___query.preference' - $ref: '#/components/parameters/search_shards___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_shards' responses: '200': $ref: '#/components/responses/search_shards___200' post: operationId: search_shards.3 x-operation-group: search_shards x-version-added: '1.0' description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/search_shards___path.index' - $ref: '#/components/parameters/search_shards___query.allow_no_indices' - $ref: '#/components/parameters/search_shards___query.expand_wildcards' - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' - $ref: '#/components/parameters/search_shards___query.local' - $ref: '#/components/parameters/search_shards___query.preference' - $ref: '#/components/parameters/search_shards___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_shards' responses: '200': $ref: '#/components/responses/search_shards___200' /{index}/_search/point_in_time: post: operationId: create_pit.0 x-operation-group: create_pit x-version-added: '2.4' description: Creates point in time context. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit parameters: - $ref: '#/components/parameters/create_pit___path.index' - $ref: '#/components/parameters/create_pit___query.allow_partial_pit_creation' - $ref: '#/components/parameters/create_pit___query.expand_wildcards' - $ref: '#/components/parameters/create_pit___query.keep_alive' - $ref: '#/components/parameters/create_pit___query.preference' - $ref: '#/components/parameters/create_pit___query.routing' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/create_pit___200' /{index}/_search/template: get: operationId: search_template.2 x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/search_template___path.index' - $ref: '#/components/parameters/search_template___query.allow_no_indices' - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search_template___query.expand_wildcards' - $ref: '#/components/parameters/search_template___query.explain' - $ref: '#/components/parameters/search_template___query.ignore_throttled' - $ref: '#/components/parameters/search_template___query.ignore_unavailable' - $ref: '#/components/parameters/search_template___query.phase_took' - $ref: '#/components/parameters/search_template___query.preference' - $ref: '#/components/parameters/search_template___query.profile' - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search_template___query.routing' - $ref: '#/components/parameters/search_template___query.scroll' - $ref: '#/components/parameters/search_template___query.search_pipeline' - $ref: '#/components/parameters/search_template___query.search_type' - $ref: '#/components/parameters/search_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_template' responses: '200': $ref: '#/components/responses/search_template___200' post: operationId: search_template.3 x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - $ref: '#/components/parameters/search_template___path.index' - $ref: '#/components/parameters/search_template___query.allow_no_indices' - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/search_template___query.expand_wildcards' - $ref: '#/components/parameters/search_template___query.explain' - $ref: '#/components/parameters/search_template___query.ignore_throttled' - $ref: '#/components/parameters/search_template___query.ignore_unavailable' - $ref: '#/components/parameters/search_template___query.phase_took' - $ref: '#/components/parameters/search_template___query.preference' - $ref: '#/components/parameters/search_template___query.profile' - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' - $ref: '#/components/parameters/search_template___query.routing' - $ref: '#/components/parameters/search_template___query.scroll' - $ref: '#/components/parameters/search_template___query.search_pipeline' - $ref: '#/components/parameters/search_template___query.search_type' - $ref: '#/components/parameters/search_template___query.typed_keys' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/search_template' responses: '200': $ref: '#/components/responses/search_template___200' /{index}/_segments: get: operationId: indices.segments.1 x-operation-group: indices.segments x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.segments___path.index' - $ref: '#/components/parameters/indices.segments___query.allow_no_indices' - $ref: '#/components/parameters/indices.segments___query.expand_wildcards' - $ref: '#/components/parameters/indices.segments___query.ignore_unavailable' - $ref: '#/components/parameters/indices.segments___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.segments___200' /{index}/_settings: get: operationId: indices.get_settings.2 x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - $ref: '#/components/parameters/indices.get_settings___path.index' - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' - $ref: '#/components/parameters/indices.get_settings___query.local' - $ref: '#/components/parameters/indices.get_settings___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_settings___200' put: operationId: indices.put_settings.1 x-operation-group: indices.put_settings x-version-added: '1.0' description: Updates the index settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: - $ref: '#/components/parameters/indices.put_settings___path.index' - $ref: '#/components/parameters/indices.put_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.put_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.put_settings___query.flat_settings' - $ref: '#/components/parameters/indices.put_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.put_settings___query.master_timeout' - $ref: '#/components/parameters/indices.put_settings___query.preserve_existing' - $ref: '#/components/parameters/indices.put_settings___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': $ref: '#/components/responses/indices.put_settings___200' /{index}/_settings/{name}: get: operationId: indices.get_settings.3 x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - $ref: '#/components/parameters/indices.get_settings___path.index' - $ref: '#/components/parameters/indices.get_settings___path.name' - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' - $ref: '#/components/parameters/indices.get_settings___query.local' - $ref: '#/components/parameters/indices.get_settings___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_settings___200' /{index}/_shard_stores: get: operationId: indices.shard_stores.1 x-operation-group: indices.shard_stores x-version-added: '1.0' description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.shard_stores___path.index' - $ref: '#/components/parameters/indices.shard_stores___query.allow_no_indices' - $ref: '#/components/parameters/indices.shard_stores___query.expand_wildcards' - $ref: '#/components/parameters/indices.shard_stores___query.ignore_unavailable' - $ref: '#/components/parameters/indices.shard_stores___query.status' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.shard_stores___200' /{index}/_shrink/{target}: post: operationId: indices.shrink.0 x-operation-group: indices.shrink x-version-added: '1.0' description: Allow to shrink an existing index into a new index with fewer primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: - $ref: '#/components/parameters/indices.shrink___path.index' - $ref: '#/components/parameters/indices.shrink___path.target' - $ref: '#/components/parameters/indices.shrink___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.shrink___query.copy_settings' - $ref: '#/components/parameters/indices.shrink___query.master_timeout' - $ref: '#/components/parameters/indices.shrink___query.task_execution_timeout' - $ref: '#/components/parameters/indices.shrink___query.timeout' - $ref: '#/components/parameters/indices.shrink___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.shrink___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.shrink' responses: '200': $ref: '#/components/responses/indices.shrink___200' put: operationId: indices.shrink.1 x-operation-group: indices.shrink x-version-added: '1.0' description: Allow to shrink an existing index into a new index with fewer primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: - $ref: '#/components/parameters/indices.shrink___path.index' - $ref: '#/components/parameters/indices.shrink___path.target' - $ref: '#/components/parameters/indices.shrink___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.shrink___query.copy_settings' - $ref: '#/components/parameters/indices.shrink___query.master_timeout' - $ref: '#/components/parameters/indices.shrink___query.task_execution_timeout' - $ref: '#/components/parameters/indices.shrink___query.timeout' - $ref: '#/components/parameters/indices.shrink___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.shrink___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.shrink' responses: '200': $ref: '#/components/responses/indices.shrink___200' /{index}/_source/{id}: get: operationId: get_source.0 x-operation-group: get_source x-version-added: '1.0' description: Returns the source of a document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - $ref: '#/components/parameters/get_source___path.id' - $ref: '#/components/parameters/get_source___path.index' - $ref: '#/components/parameters/get_source___query._source' - $ref: '#/components/parameters/get_source___query._source_excludes' - $ref: '#/components/parameters/get_source___query._source_includes' - $ref: '#/components/parameters/get_source___query.preference' - $ref: '#/components/parameters/get_source___query.realtime' - $ref: '#/components/parameters/get_source___query.refresh' - $ref: '#/components/parameters/get_source___query.routing' - $ref: '#/components/parameters/get_source___query.version' - $ref: '#/components/parameters/get_source___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/get_source___200' '404': $ref: '#/components/responses/get_source___404' head: operationId: exists_source.0 x-operation-group: exists_source x-version-added: '1.0' description: Returns information about whether a document source exists in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - $ref: '#/components/parameters/exists_source___path.id' - $ref: '#/components/parameters/exists_source___path.index' - $ref: '#/components/parameters/exists_source___query._source' - $ref: '#/components/parameters/exists_source___query._source_excludes' - $ref: '#/components/parameters/exists_source___query._source_includes' - $ref: '#/components/parameters/exists_source___query.preference' - $ref: '#/components/parameters/exists_source___query.realtime' - $ref: '#/components/parameters/exists_source___query.refresh' - $ref: '#/components/parameters/exists_source___query.routing' - $ref: '#/components/parameters/exists_source___query.version' - $ref: '#/components/parameters/exists_source___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/exists_source___200' '404': $ref: '#/components/responses/exists_source___404' /{index}/_split/{target}: post: operationId: indices.split.0 x-operation-group: indices.split x-version-added: '1.0' description: Allows you to split an existing index into a new index with more primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: - $ref: '#/components/parameters/indices.split___path.index' - $ref: '#/components/parameters/indices.split___path.target' - $ref: '#/components/parameters/indices.split___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.split___query.copy_settings' - $ref: '#/components/parameters/indices.split___query.master_timeout' - $ref: '#/components/parameters/indices.split___query.task_execution_timeout' - $ref: '#/components/parameters/indices.split___query.timeout' - $ref: '#/components/parameters/indices.split___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.split___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.split' responses: '200': $ref: '#/components/responses/indices.split___200' put: operationId: indices.split.1 x-operation-group: indices.split x-version-added: '1.0' description: Allows you to split an existing index into a new index with more primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: - $ref: '#/components/parameters/indices.split___path.index' - $ref: '#/components/parameters/indices.split___path.target' - $ref: '#/components/parameters/indices.split___query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.split___query.copy_settings' - $ref: '#/components/parameters/indices.split___query.master_timeout' - $ref: '#/components/parameters/indices.split___query.task_execution_timeout' - $ref: '#/components/parameters/indices.split___query.timeout' - $ref: '#/components/parameters/indices.split___query.wait_for_active_shards' - $ref: '#/components/parameters/indices.split___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.split' responses: '200': $ref: '#/components/responses/indices.split___200' /{index}/_stats: get: operationId: indices.stats.2 x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.stats___path.index' - $ref: '#/components/parameters/indices.stats___query.completion_fields' - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' - $ref: '#/components/parameters/indices.stats___query.fields' - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' - $ref: '#/components/parameters/indices.stats___query.groups' - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' - $ref: '#/components/parameters/indices.stats___query.level' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.stats___200' /{index}/_stats/{metric}: get: operationId: indices.stats.3 x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.stats___path.index' - $ref: '#/components/parameters/indices.stats___path.metric' - $ref: '#/components/parameters/indices.stats___query.completion_fields' - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' - $ref: '#/components/parameters/indices.stats___query.fields' - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' - $ref: '#/components/parameters/indices.stats___query.groups' - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' - $ref: '#/components/parameters/indices.stats___query.level' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.stats___200' /{index}/_termvectors: get: operationId: termvectors.0 x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors___path.index' - $ref: '#/components/parameters/termvectors___query.field_statistics' - $ref: '#/components/parameters/termvectors___query.fields' - $ref: '#/components/parameters/termvectors___query.offsets' - $ref: '#/components/parameters/termvectors___query.payloads' - $ref: '#/components/parameters/termvectors___query.positions' - $ref: '#/components/parameters/termvectors___query.preference' - $ref: '#/components/parameters/termvectors___query.realtime' - $ref: '#/components/parameters/termvectors___query.routing' - $ref: '#/components/parameters/termvectors___query.term_statistics' - $ref: '#/components/parameters/termvectors___query.version' - $ref: '#/components/parameters/termvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': $ref: '#/components/responses/termvectors___200' post: operationId: termvectors.1 x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors___path.index' - $ref: '#/components/parameters/termvectors___query.field_statistics' - $ref: '#/components/parameters/termvectors___query.fields' - $ref: '#/components/parameters/termvectors___query.offsets' - $ref: '#/components/parameters/termvectors___query.payloads' - $ref: '#/components/parameters/termvectors___query.positions' - $ref: '#/components/parameters/termvectors___query.preference' - $ref: '#/components/parameters/termvectors___query.realtime' - $ref: '#/components/parameters/termvectors___query.routing' - $ref: '#/components/parameters/termvectors___query.term_statistics' - $ref: '#/components/parameters/termvectors___query.version' - $ref: '#/components/parameters/termvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': $ref: '#/components/responses/termvectors___200' /{index}/_termvectors/{id}: get: operationId: termvectors.2 x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors___path.id' - $ref: '#/components/parameters/termvectors___path.index' - $ref: '#/components/parameters/termvectors___query.field_statistics' - $ref: '#/components/parameters/termvectors___query.fields' - $ref: '#/components/parameters/termvectors___query.offsets' - $ref: '#/components/parameters/termvectors___query.payloads' - $ref: '#/components/parameters/termvectors___query.positions' - $ref: '#/components/parameters/termvectors___query.preference' - $ref: '#/components/parameters/termvectors___query.realtime' - $ref: '#/components/parameters/termvectors___query.routing' - $ref: '#/components/parameters/termvectors___query.term_statistics' - $ref: '#/components/parameters/termvectors___query.version' - $ref: '#/components/parameters/termvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': $ref: '#/components/responses/termvectors___200' post: operationId: termvectors.3 x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors___path.id' - $ref: '#/components/parameters/termvectors___path.index' - $ref: '#/components/parameters/termvectors___query.field_statistics' - $ref: '#/components/parameters/termvectors___query.fields' - $ref: '#/components/parameters/termvectors___query.offsets' - $ref: '#/components/parameters/termvectors___query.payloads' - $ref: '#/components/parameters/termvectors___query.positions' - $ref: '#/components/parameters/termvectors___query.preference' - $ref: '#/components/parameters/termvectors___query.realtime' - $ref: '#/components/parameters/termvectors___query.routing' - $ref: '#/components/parameters/termvectors___query.term_statistics' - $ref: '#/components/parameters/termvectors___query.version' - $ref: '#/components/parameters/termvectors___query.version_type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': $ref: '#/components/responses/termvectors___200' /{index}/_update_by_query: post: operationId: update_by_query.0 x-operation-group: update_by_query x-version-added: '1.0' description: |- Performs an update on every document in the index without changing the source, for example to pick up a mapping change. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/ parameters: - $ref: '#/components/parameters/update_by_query___path.index' - $ref: '#/components/parameters/update_by_query___query._source' - $ref: '#/components/parameters/update_by_query___query._source_excludes' - $ref: '#/components/parameters/update_by_query___query._source_includes' - $ref: '#/components/parameters/update_by_query___query.allow_no_indices' - $ref: '#/components/parameters/update_by_query___query.analyze_wildcard' - $ref: '#/components/parameters/update_by_query___query.analyzer' - $ref: '#/components/parameters/update_by_query___query.conflicts' - $ref: '#/components/parameters/update_by_query___query.default_operator' - $ref: '#/components/parameters/update_by_query___query.df' - $ref: '#/components/parameters/update_by_query___query.expand_wildcards' - $ref: '#/components/parameters/update_by_query___query.from' - $ref: '#/components/parameters/update_by_query___query.ignore_unavailable' - $ref: '#/components/parameters/update_by_query___query.lenient' - $ref: '#/components/parameters/update_by_query___query.max_docs' - $ref: '#/components/parameters/update_by_query___query.pipeline' - $ref: '#/components/parameters/update_by_query___query.preference' - $ref: '#/components/parameters/update_by_query___query.q' - $ref: '#/components/parameters/update_by_query___query.refresh' - $ref: '#/components/parameters/update_by_query___query.request_cache' - $ref: '#/components/parameters/update_by_query___query.requests_per_second' - $ref: '#/components/parameters/update_by_query___query.routing' - $ref: '#/components/parameters/update_by_query___query.scroll' - $ref: '#/components/parameters/update_by_query___query.scroll_size' - $ref: '#/components/parameters/update_by_query___query.search_timeout' - $ref: '#/components/parameters/update_by_query___query.search_type' - $ref: '#/components/parameters/update_by_query___query.size' - $ref: '#/components/parameters/update_by_query___query.slices' - $ref: '#/components/parameters/update_by_query___query.sort' - $ref: '#/components/parameters/update_by_query___query.stats' - $ref: '#/components/parameters/update_by_query___query.terminate_after' - $ref: '#/components/parameters/update_by_query___query.timeout' - $ref: '#/components/parameters/update_by_query___query.version' - $ref: '#/components/parameters/update_by_query___query.wait_for_active_shards' - $ref: '#/components/parameters/update_by_query___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/update_by_query' responses: '200': $ref: '#/components/responses/update_by_query___200' /{index}/_update/{id}: post: operationId: update.0 x-operation-group: update x-version-added: '1.0' description: Updates a document with a script or partial document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/update-document/ parameters: - $ref: '#/components/parameters/update___path.id' - $ref: '#/components/parameters/update___path.index' - $ref: '#/components/parameters/update___query._source' - $ref: '#/components/parameters/update___query._source_excludes' - $ref: '#/components/parameters/update___query._source_includes' - $ref: '#/components/parameters/update___query.if_primary_term' - $ref: '#/components/parameters/update___query.if_seq_no' - $ref: '#/components/parameters/update___query.lang' - $ref: '#/components/parameters/update___query.refresh' - $ref: '#/components/parameters/update___query.require_alias' - $ref: '#/components/parameters/update___query.retry_on_conflict' - $ref: '#/components/parameters/update___query.routing' - $ref: '#/components/parameters/update___query.timeout' - $ref: '#/components/parameters/update___query.wait_for_active_shards' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/update' responses: '200': $ref: '#/components/responses/update___200' /{index}/_upgrade: get: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_upgrade___path.index' - $ref: '#/components/parameters/indices.get_upgrade___query.allow_no_indices' - $ref: '#/components/parameters/indices.get_upgrade___query.expand_wildcards' - $ref: '#/components/parameters/indices.get_upgrade___query.ignore_unavailable' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.get_upgrade___200' post: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.upgrade___path.index' - $ref: '#/components/parameters/indices.upgrade___query.allow_no_indices' - $ref: '#/components/parameters/indices.upgrade___query.expand_wildcards' - $ref: '#/components/parameters/indices.upgrade___query.ignore_unavailable' - $ref: '#/components/parameters/indices.upgrade___query.only_ancient_segments' - $ref: '#/components/parameters/indices.upgrade___query.wait_for_completion' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/indices.upgrade___200' /{index}/_validate/query: get: operationId: indices.validate_query.2 x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query___path.index' - $ref: '#/components/parameters/indices.validate_query___query.all_shards' - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query___query.analyzer' - $ref: '#/components/parameters/indices.validate_query___query.default_operator' - $ref: '#/components/parameters/indices.validate_query___query.df' - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' - $ref: '#/components/parameters/indices.validate_query___query.explain' - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query___query.lenient' - $ref: '#/components/parameters/indices.validate_query___query.q' - $ref: '#/components/parameters/indices.validate_query___query.rewrite' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query___200' post: operationId: indices.validate_query.3 x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query___path.index' - $ref: '#/components/parameters/indices.validate_query___query.all_shards' - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query___query.analyzer' - $ref: '#/components/parameters/indices.validate_query___query.default_operator' - $ref: '#/components/parameters/indices.validate_query___query.df' - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' - $ref: '#/components/parameters/indices.validate_query___query.explain' - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query___query.lenient' - $ref: '#/components/parameters/indices.validate_query___query.q' - $ref: '#/components/parameters/indices.validate_query___query.rewrite' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query___200' /{index}/ingestion/_pause: post: summary: Pause streaming ingestion for the given index. operationId: ingestion.pause.0 x-operation-group: ingestion.pause x-version-added: '3.1' description: Use this API to pause ingestion for a given index. externalDocs: url: https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/ parameters: - $ref: '#/components/parameters/ingestion.pause___path.index' - $ref: '#/components/parameters/ingestion.pause___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingestion.pause___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingestion.pause___200' /{index}/ingestion/_resume: post: summary: Resume streaming ingestion for the given index. operationId: ingestion.resume.0 x-operation-group: ingestion.resume x-version-added: '3.1' description: Use this API to resume ingestion for the given index. externalDocs: url: https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/ parameters: - $ref: '#/components/parameters/ingestion.resume___path.index' - $ref: '#/components/parameters/ingestion.resume___query.cluster_manager_timeout' - $ref: '#/components/parameters/ingestion.resume___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ingestion.resume' responses: '200': $ref: '#/components/responses/ingestion.resume___200' /{index}/ingestion/_state: get: summary: Get the current ingestion state for a given index. operationId: ingestion.get_state.0 x-operation-group: ingestion.get_state x-version-added: '3.1' description: Use this API to retrieve the ingestion state for a given index. externalDocs: url: https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/ parameters: - $ref: '#/components/parameters/ingestion.get_state___path.index' - $ref: '#/components/parameters/ingestion.get_state___query.next_token' - $ref: '#/components/parameters/ingestion.get_state___query.size' - $ref: '#/components/parameters/ingestion.get_state___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ingestion.get_state___200' /_opendistro/_asynchronous_search: post: operationId: asynchronous_search.search.0_superseded x-operation-group: asynchronous_search.search x-version-added: '1.0' description: Performs an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: - $ref: '#/components/parameters/asynchronous_search.search___query.index' - $ref: '#/components/parameters/asynchronous_search.search___query.keep_alive' - $ref: '#/components/parameters/asynchronous_search.search___query.keep_on_completion' - $ref: '#/components/parameters/asynchronous_search.search___query.wait_for_completion_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/asynchronous_search.search' responses: '200': $ref: '#/components/responses/asynchronous_search.search___200' deprecated: true x-ignorable: true /_opendistro/_asynchronous_search/stats: get: operationId: asynchronous_search.stats.0_superseded x-operation-group: asynchronous_search.stats x-version-added: '1.0' description: Monitors any asynchronous searches that are `running`, `completed`, or `persisted`. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: '200': $ref: '#/components/responses/asynchronous_search.stats___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_asynchronous_search/{id}: get: operationId: asynchronous_search.get.0_superseded x-operation-group: asynchronous_search.get x-version-added: '1.0' description: Gets partial responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: - $ref: '#/components/parameters/asynchronous_search.get___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/asynchronous_search.get___200' deprecated: true x-ignorable: true delete: operationId: asynchronous_search.delete.0_superseded x-operation-group: asynchronous_search.delete x-version-added: '1.0' description: Deletes any responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: - $ref: '#/components/parameters/asynchronous_search.delete___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/asynchronous_search.delete___200' deprecated: true x-ignorable: true /_opendistro/_ism/add: post: operationId: ism.add_policy.0_superseded x-operation-group: ism.add_policy description: Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - $ref: '#/components/parameters/ism.add_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.add_policy' responses: '200': $ref: '#/components/responses/ism.add_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/add/{index}: post: operationId: ism.add_policy.1_superseded x-operation-group: ism.add_policy description: Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - $ref: '#/components/parameters/ism.add_policy___path.index' - $ref: '#/components/parameters/ism.add_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.add_policy' responses: '200': $ref: '#/components/responses/ism.add_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/change_policy: post: operationId: ism.change_policy.0_superseded x-operation-group: ism.change_policy description: Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - $ref: '#/components/parameters/ism.change_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.change_policy' responses: '200': $ref: '#/components/responses/ism.change_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/change_policy/{index}: post: operationId: ism.change_policy.1_superseded x-operation-group: ism.change_policy description: Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - $ref: '#/components/parameters/ism.change_policy___path.index' - $ref: '#/components/parameters/ism.change_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.change_policy' responses: '200': $ref: '#/components/responses/ism.change_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/explain: get: operationId: ism.explain_policy.0_superseded x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true post: operationId: ism.explain_policy.1_superseded x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_ism/explain/{index}: get: operationId: ism.explain_policy.3_superseded x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - $ref: '#/components/parameters/ism.explain_policy___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' deprecated: true x-ignorable: true post: operationId: ism.explain_policy.4_superseded x-operation-group: ism.explain_policy description: Retrieves the currently applied policy on the specified indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - $ref: '#/components/parameters/ism.explain_policy___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': $ref: '#/components/responses/ism.explain_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/policies: get: operationId: ism.get_policies.0_superseded x-operation-group: ism.get_policies description: Retrieves the policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy responses: '200': $ref: '#/components/responses/ism.get_policies___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true put: operationId: ism.put_policies.0_superseded x-operation-group: ism.put_policies description: Creates or updates policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy requestBody: $ref: '#/components/requestBodies/ism.put_policies' parameters: - $ref: '#/components/parameters/ism.put_policies___query.if_primary_term' - $ref: '#/components/parameters/ism.put_policies___query.if_seq_no' - $ref: '#/components/parameters/ism.put_policies___query.policyID' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.put_policies___200' deprecated: true x-ignorable: true /_opendistro/_ism/policies/{policy_id}: get: operationId: ism.get_policy.0_superseded x-operation-group: ism.get_policy description: Retrieves a specific policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy parameters: - $ref: '#/components/parameters/ism.get_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.get_policy___200' deprecated: true x-ignorable: true head: operationId: ism.exists_policy.0_superseded x-operation-group: ism.exists_policy description: Checks for the existence of a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy parameters: - $ref: '#/components/parameters/ism.exists_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.exists_policy___200' '404': $ref: '#/components/responses/ism.exists_policy___404' deprecated: true x-ignorable: true put: operationId: ism.put_policy.0_superseded x-operation-group: ism.put_policy description: Creates or updates a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy parameters: - $ref: '#/components/parameters/ism.put_policy___path.policy_id' - $ref: '#/components/parameters/ism.put_policy___query.if_primary_term' - $ref: '#/components/parameters/ism.put_policy___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.put_policy' responses: '200': $ref: '#/components/responses/ism.put_policy___200' '201': $ref: '#/components/responses/ism.put_policy___201' deprecated: true x-ignorable: true delete: operationId: ism.delete_policy.0_superseded x-operation-group: ism.delete_policy description: Deletes a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy parameters: - $ref: '#/components/parameters/ism.delete_policy___path.policy_id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.delete_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/remove: post: operationId: ism.remove_policy.0_superseded x-operation-group: ism.remove_policy description: Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - $ref: '#/components/parameters/ism.remove_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.remove_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/remove/{index}: post: operationId: ism.remove_policy.1_superseded x-operation-group: ism.remove_policy description: Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - $ref: '#/components/parameters/ism.remove_policy___path.index' - $ref: '#/components/parameters/ism.remove_policy___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.remove_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/retry: post: operationId: ism.retry_index.0_superseded x-operation-group: ism.retry_index description: Retries the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - $ref: '#/components/parameters/ism.retry_index___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.retry_index' responses: '200': $ref: '#/components/responses/ism.retry_index___200' deprecated: true x-ignorable: true /_opendistro/_ism/retry/{index}: post: operationId: ism.retry_index.1_superseded x-operation-group: ism.retry_index description: Retries the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - $ref: '#/components/parameters/ism.retry_index___path.index' - $ref: '#/components/parameters/ism.retry_index___query.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ism.retry_index' responses: '200': $ref: '#/components/responses/ism.retry_index___200' deprecated: true x-ignorable: true /_opendistro/_knn/stats/{stat}: get: operationId: knn.stats.1_superseded x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___path.stat' - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' deprecated: true x-ignorable: true /_opendistro/_knn/warmup/{index}: get: operationId: knn.warmup.0_superseded x-operation-group: knn.warmup x-version-added: '1.0' description: Preloads native library files into memory, reducing initial search latency for specified indexes. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#warmup-operation parameters: - $ref: '#/components/parameters/knn.warmup___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.warmup___200' deprecated: true x-ignorable: true /_opendistro/_knn/{node_id}/stats/{stat}: get: operationId: knn.stats.3_superseded x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. externalDocs: url: https://docs.opensearch.org/latest/vector-search/api/knn/#stats parameters: - $ref: '#/components/parameters/knn.stats___path.node_id' - $ref: '#/components/parameters/knn.stats___path.stat' - $ref: '#/components/parameters/knn.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/knn.stats___200' deprecated: true x-ignorable: true /_opendistro/_ppl: post: operationId: ppl.query.0_superseded x-operation-group: ppl.query x-version-added: '1.0' description: Executes a PPL query against OpenSearch indexes. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/ppl.query___query.format' - $ref: '#/components/parameters/ppl.query___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.query' responses: '200': $ref: '#/components/responses/ppl.query___200' deprecated: true x-ignorable: true /_opendistro/_ppl/_explain: post: operationId: ppl.explain.0_superseded x-operation-group: ppl.explain x-version-added: '1.0' description: Returns the execution plan for a PPL query. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/ppl.explain___query.format' - $ref: '#/components/parameters/ppl.explain___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.explain' responses: '200': $ref: '#/components/responses/ppl.explain___200' deprecated: true x-ignorable: true /_opendistro/_ppl/stats: get: operationId: ppl.get_stats.0_superseded x-operation-group: ppl.get_stats x-version-added: '1.0' description: Retrieves performance metrics for the PPL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/ppl.get_stats___query.format' - $ref: '#/components/parameters/ppl.get_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ppl.get_stats___200' deprecated: true x-ignorable: true post: operationId: ppl.post_stats.1_superseded x-operation-group: ppl.post_stats x-version-added: '1.0' description: Retrieves filtered performance metrics for the PPL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/ppl.post_stats___query.format' - $ref: '#/components/parameters/ppl.post_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/ppl.post_stats' responses: '200': $ref: '#/components/responses/ppl.post_stats___200' deprecated: true x-ignorable: true /_opendistro/_refresh_search_analyzers/{index}: post: operationId: ism.refresh_search_analyzers.0_superseded x-operation-group: ism.refresh_search_analyzers description: Refreshes search analyzers in real time. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ parameters: - $ref: '#/components/parameters/ism.refresh_search_analyzers___path.index' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/ism.refresh_search_analyzers___200' deprecated: true x-ignorable: true /_opendistro/_rollup/jobs/{id}: get: operationId: rollups.get.0_superseded x-operation-group: rollups.get x-version-added: '1.0' description: Retrieves an index rollup job configuration by ID. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.get___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.get___200' deprecated: true x-ignorable: true put: operationId: rollups.put.0_superseded x-operation-group: rollups.put x-version-added: '1.0' description: Creates or updates an index rollup job configuration. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: '201': $ref: '#/components/responses/rollups.put___201' parameters: - $ref: '#/components/parameters/rollups.put___path.id' - $ref: '#/components/parameters/rollups.put___query.if_primary_term' - $ref: '#/components/parameters/rollups.put___query.if_seq_no' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/rollups.put' deprecated: true x-ignorable: true delete: operationId: rollups.delete.0_superseded x-operation-group: rollups.delete x-version-added: '1.0' description: Deletes an index rollup job configuration. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job responses: '200': $ref: '#/components/responses/rollups.delete___200' parameters: - $ref: '#/components/parameters/rollups.delete___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_rollup/jobs/{id}/_explain: get: operationId: rollups.explain.0_superseded x-operation-group: rollups.explain x-version-added: '1.0' description: Retrieves the execution status information for an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.explain___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.explain___200' deprecated: true x-ignorable: true /_opendistro/_rollup/jobs/{id}/_start: post: operationId: rollups.start.0_superseded x-operation-group: rollups.start x-version-added: '1.0' description: Starts the execution of an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.start___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.start___200' deprecated: true x-ignorable: true /_opendistro/_rollup/jobs/{id}/_stop: post: operationId: rollups.stop.0_superseded x-operation-group: rollups.stop x-version-added: '1.0' description: Stops the execution of an index rollup job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - $ref: '#/components/parameters/rollups.stop___path.id' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/rollups.stop___200' deprecated: true x-ignorable: true /_opendistro/_security/api/account: get: operationId: security.get_account_details.0_superseded x-operation-group: security.get_account_details x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns account information for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details responses: '200': $ref: '#/components/responses/security.get_account_details___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true put: operationId: security.change_password.0_superseded x-operation-group: security.change_password x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Changes the password for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#change-password requestBody: $ref: '#/components/requestBodies/security.change_password' responses: '200': $ref: '#/components/responses/security.change_password___200' '403': $ref: '#/components/responses/security.change_password___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/actiongroups/{action_group}: get: operationId: security.get_action_group.0_superseded x-operation-group: security.get_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves one action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group parameters: - $ref: '#/components/parameters/security.get_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_action_group___200' deprecated: true x-ignorable: true put: operationId: security.create_action_group.0_superseded x-operation-group: security.create_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group parameters: - $ref: '#/components/parameters/security.create_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_action_group' responses: '200': $ref: '#/components/responses/security.create_action_group___200' '201': $ref: '#/components/responses/security.create_action_group___201' deprecated: true x-ignorable: true patch: operationId: security.patch_action_group.0_superseded x-operation-group: security.patch_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of an action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group parameters: - $ref: '#/components/parameters/security.patch_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_action_group' responses: '200': $ref: '#/components/responses/security.patch_action_group___200' deprecated: true x-ignorable: true delete: operationId: security.delete_action_group.0_superseded x-operation-group: security.delete_action_group x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - $ref: '#/components/parameters/security.delete_action_group___path.action_group' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_action_group___200' deprecated: true x-ignorable: true /_opendistro/_security/api/audit/config: put: operationId: security.update_audit_configuration.0_superseded x-operation-group: security.update_audit_configuration x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs requestBody: $ref: '#/components/requestBodies/security.update_audit_configuration' responses: '200': $ref: '#/components/responses/security.update_audit_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/authtoken: post: operationId: security.authtoken.0_superseded x-operation-group: security.authtoken x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns the authorization token for the current user. responses: '200': $ref: '#/components/responses/security.authtoken___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/cache: get: operationId: security.cache.1_superseded x-operation-group: security.cache x-ignorable: true x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true post: operationId: security.cache.2_superseded x-operation-group: security.cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless x-ignorable: true description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true put: operationId: security.cache.3_superseded x-operation-group: security.cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless x-ignorable: true description: Not supported for the Cache API. responses: '405': $ref: '#/components/responses/security.cache___405' '501': $ref: '#/components/responses/security.cache___501' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true delete: operationId: security.flush_cache.0_superseded x-operation-group: security.flush_cache x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Flushes the Security plugin's user, authentication, and authorization cache. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: '200': $ref: '#/components/responses/security.flush_cache___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/internalusers/{username}: get: operationId: security.get_user.0_superseded x-operation-group: security.get_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve information about the specified internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user parameters: - $ref: '#/components/parameters/security.get_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_user___200' deprecated: true x-ignorable: true put: operationId: security.create_user.0_superseded x-operation-group: security.create_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user parameters: - $ref: '#/components/parameters/security.create_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_user' responses: '200': $ref: '#/components/responses/security.create_user___200' '201': $ref: '#/components/responses/security.create_user___201' deprecated: true x-ignorable: true patch: operationId: security.patch_user.0_superseded x-operation-group: security.patch_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates individual attributes for an internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user parameters: - $ref: '#/components/parameters/security.patch_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_user' responses: '200': $ref: '#/components/responses/security.patch_user___200' deprecated: true x-ignorable: true delete: operationId: security.delete_user.0_superseded x-operation-group: security.delete_user x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: - $ref: '#/components/parameters/security.delete_user___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_user___200' deprecated: true x-ignorable: true /_opendistro/_security/api/internalusers/{username}/authtoken: post: operationId: security.generate_user_token.0_superseded x-operation-group: security.generate_user_token x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Generates an authorization token for the specified user. parameters: - $ref: '#/components/parameters/security.generate_user_token___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.generate_user_token___200' '400': $ref: '#/components/responses/security.generate_user_token___400' deprecated: true x-ignorable: true /_opendistro/_security/api/migrate: post: operationId: security.migrate.0_superseded x-operation-group: security.migrate x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Migrates the security configuration from v6 to v7. responses: '200': $ref: '#/components/responses/security.migrate___200' '400': $ref: '#/components/responses/security.migrate___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/permissionsinfo: get: operationId: security.get_permissions_info.0_superseded x-operation-group: security.get_permissions_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the evaluated REST API permissions for the currently logged in user. responses: '200': $ref: '#/components/responses/security.get_permissions_info___200' '500': $ref: '#/components/responses/security.get_permissions_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/roles/{role}: get: operationId: security.get_role.0_superseded x-operation-group: security.get_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves one role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role parameters: - $ref: '#/components/parameters/security.get_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_role___200' deprecated: true x-ignorable: true put: operationId: security.create_role.0_superseded x-operation-group: security.create_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role parameters: - $ref: '#/components/parameters/security.create_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_role' responses: '200': $ref: '#/components/responses/security.create_role___200' '201': $ref: '#/components/responses/security.create_role___201' deprecated: true x-ignorable: true patch: operationId: security.patch_role.0_superseded x-operation-group: security.patch_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of a role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role parameters: - $ref: '#/components/parameters/security.patch_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_role' responses: '200': $ref: '#/components/responses/security.patch_role___200' '400': $ref: '#/components/responses/security.patch_role___400' deprecated: true x-ignorable: true delete: operationId: security.delete_role.0_superseded x-operation-group: security.delete_role x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: - $ref: '#/components/parameters/security.delete_role___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_role___200' deprecated: true x-ignorable: true /_opendistro/_security/api/rolesmapping/{role}: get: operationId: security.get_role_mapping.0_superseded x-operation-group: security.get_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping parameters: - $ref: '#/components/parameters/security.get_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_role_mapping___200' deprecated: true x-ignorable: true put: operationId: security.create_role_mapping.0_superseded x-operation-group: security.create_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping parameters: - $ref: '#/components/parameters/security.create_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_role_mapping' responses: '200': $ref: '#/components/responses/security.create_role_mapping___200' '201': $ref: '#/components/responses/security.create_role_mapping___201' deprecated: true x-ignorable: true patch: operationId: security.patch_role_mapping.0_superseded x-operation-group: security.patch_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the individual attributes of a role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping parameters: - $ref: '#/components/parameters/security.patch_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_role_mapping' responses: '200': $ref: '#/components/responses/security.patch_role_mapping___200' '400': $ref: '#/components/responses/security.patch_role_mapping___400' deprecated: true x-ignorable: true delete: operationId: security.delete_role_mapping.0_superseded x-operation-group: security.delete_role_mapping x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: - $ref: '#/components/parameters/security.delete_role_mapping___path.role' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_role_mapping___200' deprecated: true x-ignorable: true /_opendistro/_security/api/securityconfig: get: operationId: security.get_configuration.0_superseded x-operation-group: security.get_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns the current Security plugin configuration in a JSON format. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: '200': $ref: '#/components/responses/security.get_configuration___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true patch: operationId: security.patch_configuration.0_superseded x-operation-group: security.patch_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the existing security configuration using the REST API. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: $ref: '#/components/requestBodies/security.patch_configuration' responses: '200': $ref: '#/components/responses/security.patch_configuration___200' '403': $ref: '#/components/responses/security.patch_configuration___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/securityconfig/config: put: operationId: security.update_configuration.0_superseded x-operation-group: security.update_configuration x-version-added: '2.10' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the settings for an existing security configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: $ref: '#/components/requestBodies/security.update_configuration' responses: '200': $ref: '#/components/responses/security.update_configuration___200' '403': $ref: '#/components/responses/security.update_configuration___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/ssl/certs: get: operationId: security.get_certificates.0_superseded x-operation-group: security.get_certificates x-version-added: '2.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: '200': $ref: '#/components/responses/security.get_certificates___200' '400': $ref: '#/components/responses/security.get_certificates___400' '403': $ref: '#/components/responses/security.get_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/ssl/transport/reloadcerts: put: operationId: security.reload_transport_certificates.0_superseded x-operation-group: security.reload_transport_certificates x-version-added: '2.8' x-distributions-excluded: - amazon-managed - amazon-serverless description: Reloads the transport communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: '200': $ref: '#/components/responses/security.reload_transport_certificates___200' '400': $ref: '#/components/responses/security.reload_transport_certificates___400' '403': $ref: '#/components/responses/security.reload_transport_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/ssl/http/reloadcerts: put: operationId: security.reload_http_certificates.0_superseded x-operation-group: security.reload_http_certificates x-version-added: '2.8' x-distributions-excluded: - amazon-managed - amazon-serverless description: Reloads the HTTP communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates responses: '200': $ref: '#/components/responses/security.reload_http_certificates___200' '400': $ref: '#/components/responses/security.reload_http_certificates___400' '403': $ref: '#/components/responses/security.reload_http_certificates___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/nodesdn/{cluster_name}: get: operationId: security.get_distinguished_name.0_superseded x-operation-group: security.get_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all node distinguished names. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - $ref: '#/components/parameters/security.get_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/security.get_distinguished_name___query.show_all' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_distinguished_name___200' '400': $ref: '#/components/responses/security.get_distinguished_name___400' '403': $ref: '#/components/responses/security.get_distinguished_name___403' deprecated: true x-ignorable: true put: operationId: security.update_distinguished_name.0_superseded x-operation-group: security.update_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: - $ref: '#/components/parameters/security.update_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.update_distinguished_name' responses: '200': $ref: '#/components/responses/security.update_distinguished_name___200' '201': $ref: '#/components/responses/security.update_distinguished_name___201' '400': $ref: '#/components/responses/security.update_distinguished_name___400' '403': $ref: '#/components/responses/security.update_distinguished_name___403' deprecated: true x-ignorable: true patch: operationId: security.patch_distinguished_name.0_superseded x-operation-group: security.patch_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions. parameters: - $ref: '#/components/parameters/security.patch_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_distinguished_name' responses: '200': $ref: '#/components/responses/security.patch_distinguished_name___200' '400': $ref: '#/components/responses/security.patch_distinguished_name___400' '403': $ref: '#/components/responses/security.patch_distinguished_name___403' deprecated: true x-ignorable: true delete: operationId: security.delete_distinguished_name.0_superseded x-operation-group: security.delete_distinguished_name x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: - $ref: '#/components/parameters/security.delete_distinguished_name___path.cluster_name' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_distinguished_name___200' '400': $ref: '#/components/responses/security.delete_distinguished_name___400' '403': $ref: '#/components/responses/security.delete_distinguished_name___403' deprecated: true x-ignorable: true /_opendistro/_security/api/tenancy/config: get: operationId: security.get_tenancy_config.0_superseded x-operation-group: security.get_tenancy_config x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api responses: '200': $ref: '#/components/responses/security.get_tenancy_config___200' '400': $ref: '#/components/responses/security.get_tenancy_config___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true put: operationId: security.create_update_tenancy_config.0_superseded x-operation-group: security.create_update_tenancy_config x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api requestBody: $ref: '#/components/requestBodies/security.create_update_tenancy_config' responses: '200': $ref: '#/components/responses/security.create_update_tenancy_config___200' '400': $ref: '#/components/responses/security.create_update_tenancy_config___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/tenants: get: operationId: security.get_tenants.0_superseded x-operation-group: security.get_tenants x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves all tenants. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: '200': $ref: '#/components/responses/security.get_tenants___200' '400': $ref: '#/components/responses/security.get_tenants___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true patch: operationId: security.patch_tenants.0_superseded x-operation-group: security.patch_tenants x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds, deletes, or modifies multiple tenants in a single request. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants requestBody: $ref: '#/components/requestBodies/security.patch_tenants' responses: '200': $ref: '#/components/responses/security.patch_tenants___200' '400': $ref: '#/components/responses/security.patch_tenants___400' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/tenants/{tenant}: get: operationId: security.get_tenant.0_superseded x-operation-group: security.get_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant parameters: - $ref: '#/components/parameters/security.get_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_tenant___200' deprecated: true x-ignorable: true put: operationId: security.create_tenant.0_superseded x-operation-group: security.create_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant parameters: - $ref: '#/components/parameters/security.create_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_tenant' responses: '200': $ref: '#/components/responses/security.create_tenant___200' '201': $ref: '#/components/responses/security.create_tenant___201' '400': $ref: '#/components/responses/security.create_tenant___400' deprecated: true x-ignorable: true patch: operationId: security.patch_tenant.0_superseded x-operation-group: security.patch_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Adds, deletes, or modifies a single tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant parameters: - $ref: '#/components/parameters/security.patch_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.patch_tenant' responses: '200': $ref: '#/components/responses/security.patch_tenant___200' '400': $ref: '#/components/responses/security.patch_tenant___400' deprecated: true x-ignorable: true delete: operationId: security.delete_tenant.0_superseded x-operation-group: security.delete_tenant x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Deletes the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - $ref: '#/components/parameters/security.delete_tenant___path.tenant' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_tenant___200' '400': $ref: '#/components/responses/security.delete_tenant___400' deprecated: true x-ignorable: true /_opendistro/_security/api/user: get: operationId: security.get_users_legacy.0_superseded x-operation-group: security.get_users_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve all internal users. Legacy API. responses: '200': $ref: '#/components/responses/security.get_users_legacy___200' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/api/user/{username}: get: operationId: security.get_user_legacy.0_superseded x-operation-group: security.get_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieve one user. Legacy API. parameters: - $ref: '#/components/parameters/security.get_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.get_user_legacy___200' deprecated: true x-ignorable: true put: operationId: security.create_user_legacy.0_superseded x-operation-group: security.create_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.create_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/security.create_user_legacy' responses: '200': $ref: '#/components/responses/security.create_user_legacy___200' '201': $ref: '#/components/responses/security.create_user_legacy___201' deprecated: true x-ignorable: true delete: operationId: security.delete_user_legacy.0_superseded x-operation-group: security.delete_user_legacy x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Delete the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.delete_user_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.delete_user_legacy___200' deprecated: true x-ignorable: true /_opendistro/_security/api/user/{username}/authtoken: post: operationId: security.generate_user_token_legacy.0_superseded x-operation-group: security.generate_user_token_legacy x-version-added: '2.7' x-distributions-excluded: - amazon-managed - amazon-serverless description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '501': $ref: '#/components/responses/security.generate_user_token_legacy___501' deprecated: true x-ignorable: true /_opendistro/_security/api/validate: get: operationId: security.validate.0_superseded x-operation-group: security.validate x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks whether the v6 security configuration is valid and ready to be migrated to v7. parameters: - $ref: '#/components/parameters/security.validate___query.accept_invalid' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.validate___200' '400': $ref: '#/components/responses/security.validate___400' deprecated: true x-ignorable: true /_opendistro/_security/api/allowlist: get: operationId: security.get_allowlist.0_superseded x-operation-group: security.get_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current list of allowed APIs accessible to a normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': $ref: '#/components/responses/security.get_allowlist___200' '403': $ref: '#/components/responses/security.get_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true put: operationId: security.create_allowlist.0_superseded x-operation-group: security.create_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.create_allowlist' responses: '200': $ref: '#/components/responses/security.create_allowlist___200' '403': $ref: '#/components/responses/security.create_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true patch: operationId: security.patch_allowlist.0_superseded x-operation-group: security.patch_allowlist x-version-added: '2.1' x-distributions-excluded: - amazon-managed - amazon-serverless description: Updates the current list of APIs accessible for users on the allow list. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.patch_allowlist' responses: '200': $ref: '#/components/responses/security.patch_allowlist___200' '403': $ref: '#/components/responses/security.patch_allowlist___403' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/authinfo: get: operationId: security.authinfo.0_superseded x-operation-group: security.authinfo x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns or updates authentication information for the currently authenticated user. parameters: - $ref: '#/components/parameters/security.authinfo___query.auth_type' - $ref: '#/components/parameters/security.authinfo___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.authinfo___200' '500': $ref: '#/components/responses/security.authinfo___500' deprecated: true x-ignorable: true post: operationId: security.authinfo.1_superseded x-operation-group: security.authinfo x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Returns or updates authentication information for the currently authenticated user. parameters: - $ref: '#/components/parameters/security.authinfo___query.auth_type' - $ref: '#/components/parameters/security.authinfo___query.verbose' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/security.authinfo___200' '500': $ref: '#/components/responses/security.authinfo___500' deprecated: true x-ignorable: true /_opendistro/_security/health: get: operationId: security.health.0_superseded x-operation-group: security.health x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks to see if the Security plugin is running. parameters: - $ref: '#/components/parameters/security.health___query.mode' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': $ref: '#/components/responses/security.health___200' deprecated: true x-ignorable: true post: operationId: security.health.1_superseded x-operation-group: security.health x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Checks to see if the Security plugin is running. parameters: - $ref: '#/components/parameters/security.health___query.mode' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': $ref: '#/components/responses/security.health___200' deprecated: true x-ignorable: true /_opendistro/_security/kibanainfo: get: operationId: security.get_dashboards_info.0_superseded x-operation-group: security.get_dashboards_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current values for dynamic security settings for OpenSearch Dashboards. responses: '200': $ref: '#/components/responses/security.get_dashboards_info___200' '500': $ref: '#/components/responses/security.get_dashboards_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true post: operationId: security.post_dashboards_info.1_superseded x-operation-group: security.post_dashboards_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the current values for dynamic security settings for OpenSearch Dashboards. responses: '200': $ref: '#/components/responses/security.post_dashboards_info___200' '500': $ref: '#/components/responses/security.post_dashboards_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_security/tenantinfo: get: operationId: security.tenant_info.0_superseded x-operation-group: security.tenant_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions. responses: '200': $ref: '#/components/responses/security.tenant_info___200' '403': $ref: '#/components/responses/security.tenant_info___403' '500': $ref: '#/components/responses/security.tenant_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true post: operationId: security.tenant_info.1_superseded x-operation-group: security.tenant_info x-version-added: '1.0' x-distributions-excluded: - amazon-managed - amazon-serverless description: Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions. responses: '200': $ref: '#/components/responses/security.tenant_info___200' '403': $ref: '#/components/responses/security.tenant_info___403' '500': $ref: '#/components/responses/security.tenant_info___500' parameters: - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' deprecated: true x-ignorable: true /_opendistro/_sql: post: operationId: sql.query.0_superseded x-operation-group: sql.query x-version-added: '1.0' description: Executes SQL or PPL queries against OpenSearch indexes. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.query___query.format' - $ref: '#/components/parameters/sql.query___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.query' responses: '200': $ref: '#/components/responses/sql.query___200' deprecated: true x-ignorable: true /_opendistro/_sql/_explain: post: operationId: sql.explain.0_superseded x-operation-group: sql.explain x-version-added: '1.0' description: Returns the execution plan for a SQL or PPL query. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.explain___query.format' - $ref: '#/components/parameters/sql.explain___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.explain' responses: '200': $ref: '#/components/responses/sql.explain___200' deprecated: true x-ignorable: true /_opendistro/_sql/close: post: operationId: sql.close.0_superseded x-operation-group: sql.close x-version-added: '1.0' description: Closes an open cursor to free server-side resources. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: - $ref: '#/components/parameters/sql.close___query.format' - $ref: '#/components/parameters/sql.close___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.close' responses: '200': $ref: '#/components/responses/sql.close___200' deprecated: true x-ignorable: true /_opendistro/_sql/settings: put: operationId: sql.settings.0_superseded x-operation-group: sql.settings x-version-added: '1.0' description: Updates SQL plugin settings in the OpenSearch cluster configuration. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ parameters: - $ref: '#/components/parameters/sql.settings___query.format' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.settings' responses: '200': $ref: '#/components/responses/sql.settings___200' deprecated: true x-ignorable: true /_opendistro/_sql/stats: get: operationId: sql.get_stats.0_superseded x-operation-group: sql.get_stats x-version-added: '1.0' description: Retrieves performance metrics for the SQL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/sql.get_stats___query.format' - $ref: '#/components/parameters/sql.get_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/sql.get_stats___200' deprecated: true x-ignorable: true post: operationId: sql.post_stats.1_superseded x-operation-group: sql.post_stats x-version-added: '1.0' description: Retrieves filtered performance metrics for the SQL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: - $ref: '#/components/parameters/sql.post_stats___query.format' - $ref: '#/components/parameters/sql.post_stats___query.sanitize' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' requestBody: $ref: '#/components/requestBodies/sql.post_stats' responses: '200': $ref: '#/components/responses/sql.post_stats___200' deprecated: true x-ignorable: true /_cluster/nodes/hotthreads: get: operationId: nodes.hot_threads.0_superseded x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_cluster/nodes/{node_id}/hotthreads: get: operationId: nodes.hot_threads.2_superseded x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___path.node_id' - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' /_nodes/{node_id}/hotthreads: get: operationId: nodes.hot_threads.6_superseded x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___path.node_id' - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' deprecated: true x-ignorable: true /_nodes/hotthreads: get: operationId: nodes.hot_threads.4_superseded x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - $ref: '#/components/parameters/nodes.hot_threads___query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads___query.interval' - $ref: '#/components/parameters/nodes.hot_threads___query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads___query.threads' - $ref: '#/components/parameters/nodes.hot_threads___query.timeout' - $ref: '#/components/parameters/nodes.hot_threads___query.type' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads___200' deprecated: true x-ignorable: true components: parameters: _global___query.pretty: name: pretty in: query description: Whether to pretty-format the returned JSON response. x-protobuf-excluded: true schema: type: boolean default: false x-global: true _global___query.human: name: human in: query description: Whether to return human-readable values for statistics. schema: type: boolean default: false x-global: true _global___query.error_trace: name: error_trace in: query description: Whether to include the stack trace of returned errors. schema: type: boolean default: false x-global: true _global___query.source: name: source in: query x-protobuf-excluded: true description: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. schema: type: string x-global: true _global___query.filter_path: name: filter_path in: query description: A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`. schema: $ref: '#/components/schemas/_common___StringOrStringArray' x-global: true asynchronous_search.delete___path.id: name: id in: path schema: type: string required: true asynchronous_search.get___path.id: name: id in: path schema: type: string required: true asynchronous_search.search___query.index: name: index in: query description: The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names. schema: type: string asynchronous_search.search___query.keep_alive: name: keep_alive in: query description: |- The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query exceeds this amount of time, the process cancels this query automatically. schema: type: string asynchronous_search.search___query.keep_on_completion: name: keep_on_completion in: query description: Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time. schema: type: boolean asynchronous_search.search___query.wait_for_completion_timeout: name: wait_for_completion_timeout in: query description: The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`. schema: type: string bulk_stream___path.index: in: path name: index description: Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: $ref: '#/components/schemas/_common___IndexName' style: simple bulk_stream___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form bulk_stream___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude from the response. schema: $ref: '#/components/schemas/_common___Fields' style: form bulk_stream___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: $ref: '#/components/schemas/_common___Fields' style: form bulk_stream___query.batch_interval: in: query name: batch_interval description: Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: $ref: '#/components/schemas/_common___Duration' style: form bulk_stream___query.batch_size: in: query name: batch_size description: Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: $ref: '#/components/schemas/_common___BatchSize' style: form x-default: 1 bulk_stream___query.pipeline: in: query name: pipeline description: |- ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. schema: type: string style: form bulk_stream___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: $ref: '#/components/schemas/_common___Refresh' style: form bulk_stream___query.require_alias: in: query name: require_alias description: If `true`, the request's actions must target an index alias. schema: type: boolean default: false style: form bulk_stream___query.routing: in: query name: routing description: A custom value used to route operations to a specific shard. schema: $ref: '#/components/schemas/_common___RoutingInQueryString' style: form bulk_stream___query.timeout: in: query name: timeout description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '#/components/schemas/_common___Duration' style: form bulk_stream___query.type: name: type in: query description: Default document type for items which don't provide one. schema: type: string description: Default document type for items which don't provide one. bulk_stream___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' bulk___path.index: in: path name: index description: Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: $ref: '#/components/schemas/_common___IndexName' style: simple x-protobuf-excluded: true bulk___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form bulk___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude from the response. schema: $ref: '#/components/schemas/_common___Fields' style: form bulk___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: $ref: '#/components/schemas/_common___Fields' style: form bulk___query.index: in: query name: index description: Name of the data stream, index, or index alias to perform bulk actions on. schema: $ref: '#/components/schemas/_common___IndexName' style: form bulk___query.pipeline: in: query name: pipeline description: |- ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. schema: type: string style: form bulk___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: $ref: '#/components/schemas/_common___Refresh' style: form bulk___query.require_alias: in: query name: require_alias description: If `true`, the request's actions must target an index alias. schema: type: boolean default: false style: form bulk___query.routing: in: query name: routing description: A custom value used to route operations to a specific shard. schema: $ref: '#/components/schemas/_common___Routing' style: form bulk___query.timeout: in: query name: timeout description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '#/components/schemas/_common___Duration' style: form bulk___query.type: name: type in: query description: Default document type for items which don't provide one. schema: type: string description: Default document type for items which don't provide one. bulk___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' cat.aliases___path.name: in: path name: name required: true schema: $ref: '#/components/schemas/_common___Names' style: simple cat.aliases___query.expand_wildcards: in: query name: expand_wildcards schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cat.aliases___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.aliases___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.aliases___query.help: name: help in: query description: Returns help information. schema: description: Returns help information. type: boolean default: false cat.aliases___query.local: name: local in: query description: Whether to return information from the local node only instead of from the cluster manager node. schema: type: boolean default: false description: Whether to return information from the local node only instead of from the cluster manager node. cat.aliases___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.aliases___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.all_pit_segments___query.bytes: name: bytes in: query description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.all_pit_segments___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.all_pit_segments___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.all_pit_segments___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.all_pit_segments___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.all_pit_segments___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.allocation___path.node_id: in: path name: node_id description: A comma-separated list of node IDs or names used to limit the returned information. required: true schema: $ref: '#/components/schemas/_common___NodeIds' style: simple cat.allocation___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.allocation___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.allocation___query.format: name: format in: query description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. cat.allocation___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.allocation___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.allocation___query.local: name: local in: query description: Returns local information but does not retrieve the state from cluster-manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from cluster-manager node. cat.allocation___query.master_timeout: name: master_timeout in: query description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.allocation___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.allocation___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.cluster_manager___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.cluster_manager___query.format: name: format in: query description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. cat.cluster_manager___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.cluster_manager___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.cluster_manager___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.cluster_manager___query.master_timeout: name: master_timeout in: query description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.cluster_manager___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.cluster_manager___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.count___path.index: in: path name: index description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cat.count___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.count___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.count___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.count___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.count___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.fielddata___path.fields: in: path name: fields description: |- A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. required: true schema: $ref: '#/components/schemas/_common___Fields' style: simple cat.fielddata___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.fielddata___query.fields: in: query name: fields description: A comma-separated list of fields used to limit the amount of returned information. schema: $ref: '#/components/schemas/_common___Fields' style: form cat.fielddata___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.fielddata___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.fielddata___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.fielddata___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.fielddata___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.health___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.health___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.health___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.health___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.health___query.time: in: query name: time description: The unit used to display time values. schema: $ref: '#/components/schemas/_common___TimeUnit' style: form cat.health___query.ts: in: query name: ts description: When `true`, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true style: form cat.health___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.indices___path.index: in: path name: index description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cat.indices___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.indices___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.indices___query.expand_wildcards: in: query name: expand_wildcards schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cat.indices___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.indices___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.indices___query.health: in: query name: health description: Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. schema: $ref: '#/components/schemas/_common___HealthStatus' style: form cat.indices___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.indices___query.include_unloaded_segments: in: query name: include_unloaded_segments description: Whether to include information from segments not loaded into memory. schema: type: boolean default: false style: form cat.indices___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.indices___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.indices___query.pri: in: query name: pri description: When `true`, returns information only from the primary shards. schema: type: boolean default: false style: form cat.indices___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.indices___query.time: in: query name: time description: Specifies the time units. schema: $ref: '#/components/schemas/_common___TimeUnit' style: form cat.indices___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.master___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.master___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.master___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.master___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.master___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.master___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.master___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.master___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.nodeattrs___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.nodeattrs___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodeattrs___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.nodeattrs___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.nodeattrs___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.nodeattrs___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.nodeattrs___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodeattrs___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.nodes___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.nodes___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.nodes___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodes___query.full_id: in: query name: full_id description: When `true`, returns the full node ID. When `false`, returns the shortened node ID. schema: $ref: '#/components/schemas/_common___StringifiedBoolean' default: false style: form cat.nodes___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.nodes___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.nodes___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. deprecated: true x-version-deprecated: '1.0' x-deprecation-message: This parameter does not cause this API to act locally. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.nodes___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.nodes___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodes___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.nodes___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.pending_tasks___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.pending_tasks___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pending_tasks___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.pending_tasks___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.pending_tasks___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.pending_tasks___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.pending_tasks___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pending_tasks___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.pending_tasks___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.pit_segments___query.bytes: name: bytes in: query description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.pit_segments___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pit_segments___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.pit_segments___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.pit_segments___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pit_segments___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.plugins___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.plugins___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.plugins___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.plugins___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.plugins___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.plugins___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.plugins___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.plugins___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.recovery___path.index: in: path name: index description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cat.recovery___query.active_only: in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. schema: type: boolean default: false style: form cat.recovery___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.recovery___query.detailed: in: query name: detailed description: When `true`, includes detailed information about shard recoveries. schema: type: boolean default: false style: form cat.recovery___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.recovery___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.recovery___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.recovery___query.index: name: index in: query description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array items: type: string description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.recovery___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.recovery___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.recovery___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.repositories___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.repositories___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.repositories___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.repositories___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.repositories___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.repositories___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.repositories___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.repositories___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.segment_replication___path.index: name: index in: path description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. schema: type: array description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. items: type: string required: true cat.segment_replication___query.active_only: name: active_only in: query description: When `true`, the response only includes ongoing segment replication events. schema: type: boolean default: false description: When `true`, the response only includes ongoing segment replication events. cat.segment_replication___query.allow_no_indices: name: allow_no_indices in: query description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. schema: type: boolean description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. cat.segment_replication___query.bytes: name: bytes in: query description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.segment_replication___query.completed_only: name: completed_only in: query description: When `true`, the response only includes the last-completed segment replication events. schema: type: boolean default: false description: When `true`, the response only includes the last-completed segment replication events. cat.segment_replication___query.detailed: name: detailed in: query description: When `true`, the response includes additional metrics for each stage of a segment replication event. schema: type: boolean default: false description: When `true`, the response includes additional metrics for each stage of a segment replication event. cat.segment_replication___query.expand_wildcards: name: expand_wildcards in: query schema: $ref: '#/components/schemas/_common___ExpandWildcards' cat.segment_replication___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segment_replication___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.segment_replication___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.segment_replication___query.ignore_throttled: name: ignore_throttled in: query description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. schema: type: boolean description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. cat.segment_replication___query.ignore_unavailable: name: ignore_unavailable in: query description: Whether the specified concrete indexes should be ignored when missing or closed. schema: type: boolean description: Whether the specified concrete indexes should be ignored when missing or closed. cat.segment_replication___query.index: name: index in: query description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array items: type: string description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.segment_replication___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segment_replication___query.shards: name: shards in: query description: A comma-separated list of shards to display. style: form schema: type: array items: type: string description: A comma-separated list of shards to display. explode: true cat.segment_replication___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.segment_replication___query.timeout: name: timeout in: query description: The operation timeout. schema: $ref: '#/components/schemas/_common___Duration' cat.segment_replication___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.segments___path.index: in: path name: index description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cat.segments___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.segments___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.segments___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segments___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.segments___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.segments___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.segments___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segments___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.shards___path.index: in: path name: index required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cat.shards___query.bytes: in: query name: bytes description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.shards___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.shards___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.shards___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.shards___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.shards___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.shards___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.shards___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.shards___query.time: name: time in: query schema: $ref: '#/components/schemas/_common___TimeUnit' cat.shards___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.snapshots___path.repository: in: path name: repository description: |- A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. required: true schema: $ref: '#/components/schemas/_common___Names' style: simple cat.snapshots___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.snapshots___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.snapshots___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.snapshots___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.snapshots___query.ignore_unavailable: in: query name: ignore_unavailable description: When `true`, the response does not include information from unavailable snapshots. schema: type: boolean default: false style: form cat.snapshots___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.snapshots___query.repository: in: query name: repository description: |- A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. required: true schema: $ref: '#/components/schemas/_common___Names' cat.snapshots___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.snapshots___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.snapshots___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.tasks___query.actions: in: query name: actions description: The task action names used to limit the response. schema: type: array items: type: string style: form cat.tasks___query.detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean default: false style: form cat.tasks___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.tasks___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.tasks___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.tasks___query.nodes: name: nodes in: query description: |- A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. style: form schema: type: array items: type: string description: |- A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. cat.tasks___query.parent_task_id: in: query name: parent_task_id description: The parent task identifier, which is used to limit the response. schema: type: string style: form cat.tasks___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.tasks___query.time: name: time in: query description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.tasks___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.templates___path.name: in: path name: name description: |- The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. required: true schema: $ref: '#/components/schemas/_common___Name' style: simple cat.templates___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.templates___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.templates___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.templates___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.templates___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.templates___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.templates___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.templates___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. cat.thread_pool___path.thread_pool_patterns: in: path name: thread_pool_patterns description: |- A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. required: true schema: $ref: '#/components/schemas/_common___Names' style: simple cat.thread_pool___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.thread_pool___query.format: name: format in: query description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string description: A short version of the `Accept` header, such as `json` or `yaml`. cat.thread_pool___query.h: name: h in: query description: A comma-separated list of column names to display. style: form schema: type: array items: type: string description: A comma-separated list of column names to display. explode: true cat.thread_pool___query.help: name: help in: query description: Returns help information. schema: type: boolean default: false description: Returns help information. cat.thread_pool___query.local: name: local in: query description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false description: Returns local information but does not retrieve the state from the cluster manager node. cat.thread_pool___query.master_timeout: name: master_timeout in: query description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.thread_pool___query.s: name: s in: query description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string description: A comma-separated list of column names or column aliases to sort by. explode: true cat.thread_pool___query.size: name: size in: query description: The multiplier in which to display values. schema: type: integer description: The multiplier in which to display values. format: int32 cat.thread_pool___query.v: name: v in: query description: Enables verbose mode, which displays column headers. schema: type: boolean default: false description: Enables verbose mode, which displays column headers. clear_scroll___path.scroll_id: in: path name: scroll_id description: |- A comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. required: true deprecated: true schema: $ref: '#/components/schemas/_common___ScrollIds' style: simple cluster.allocation_explain___query.include_disk_info: in: query name: include_disk_info description: When `true`, returns information about disk usage and shard sizes. schema: type: boolean default: false style: form cluster.allocation_explain___query.include_yes_decisions: in: query name: include_yes_decisions description: When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node. schema: type: boolean default: false style: form cluster.delete_component_template___path.name: in: path name: name description: |- The name of the component template to delete. Supports wildcard (*) expressions. required: true schema: $ref: '#/components/schemas/_common___Name' style: simple cluster.delete_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.delete_component_template___query.master_timeout: in: query name: master_timeout deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.delete_component_template___query.timeout: in: query name: timeout schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.delete_voting_config_exclusions___query.wait_for_removal: in: query name: wait_for_removal description: |- Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. When `true`, all excluded nodes are removed from the cluster before this API takes any action. When `false`, the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. schema: type: boolean default: true style: form cluster.exists_component_template___path.name: in: path name: name description: |- The name of the component template. Wildcard (*) expressions are supported. required: true schema: $ref: '#/components/schemas/_common___Name' style: simple cluster.exists_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). in: query schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.exists_component_template___query.local: in: query name: local description: |- When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. schema: type: boolean default: false style: form cluster.exists_component_template___query.master_timeout: in: query name: master_timeout deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_component_template___path.name: in: path name: name description: |- The name of the component template to retrieve. Wildcard (`*`) expressions are supported. required: true schema: $ref: '#/components/schemas/_common___Name' style: simple cluster.get_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). in: query schema: $ref: '#/components/schemas/_common___Duration' default: 30s x-version-added: '2.0' cluster.get_component_template___query.flat_settings: in: query name: flat_settings description: |- Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`. schema: type: boolean default: false style: form cluster.get_component_template___query.local: in: query name: local description: |- When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. schema: type: boolean default: false style: form cluster.get_component_template___query.master_timeout: in: query name: master_timeout deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_decommission_awareness___path.awareness_attribute_name: name: awareness_attribute_name in: path description: The name of the awareness attribute. schema: type: string description: The name of the awareness attribute. required: true cluster.get_settings___query.cluster_manager_timeout: name: cluster_manager_timeout description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). in: query schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.get_settings___query.flat_settings: in: query name: flat_settings description: |- Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`. schema: type: boolean default: false style: form cluster.get_settings___query.include_defaults: in: query name: include_defaults description: When `true`, returns default cluster settings from the local node. schema: type: boolean default: false style: form cluster.get_settings___query.master_timeout: in: query name: master_timeout deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_settings___query.timeout: in: query name: timeout schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.get_weighted_routing___path.attribute: name: attribute in: path description: The name of the awareness attribute. schema: type: string description: The name of the awareness attribute. required: true cluster.health___path.index: in: path name: index required: true schema: $ref: '#/components/schemas/_common___Indices' style: simple cluster.health___query.awareness_attribute: name: awareness_attribute in: query description: The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`. schema: type: string description: The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`. cluster.health___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.health___query.expand_wildcards: in: query name: expand_wildcards schema: $ref: '#/components/schemas/_common___ExpandWildcards' default: open style: form cluster.health___query.level: in: query name: level schema: $ref: '#/components/schemas/cluster.health___Level' default: cluster style: form cluster.health___query.local: in: query name: local description: Whether to return information from the local node only instead of from the cluster manager node. schema: type: boolean default: false style: form cluster.health___query.master_timeout: in: query name: master_timeout deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.health___query.timeout: in: query name: timeout description: The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units). schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.health___query.wait_for_active_shards: in: query name: wait_for_active_shards schema: default: 0 $ref: '#/components/schemas/_common___WaitForActiveShards' style: form cluster.health___query.wait_for_events: in: query name: wait_for_events schema: $ref: '#/components/schemas/_common___WaitForEvents' style: form cluster.health___query.wait_for_no_initializing_shards: in: query name: wait_for_no_initializing_shards description: Whether to wait until there are no initializing shards in the cluster. schema: type: boolean default: false style: form cluster.health___query.wait_for_no_relocating_shards: in: query name: wait_for_no_relocating_shards description: Whether to wait until there are no relocating shards in the cluster. schema: type: boolean default: false style: form cluster.health___query.wait_for_nodes: in: query name: wait_for_nodes description: Waits until the specified number of nodes (`N`) is available. Accepts `>=N`, `<=N`, `>N`, and `