GenericOpenSearchApiTool
Call any OpenSearch API endpoint with full control over HTTP method, path, query parameters, body, and headers. Ideal for accessing APIs without dedicated tools.
Instructions
A flexible tool for calling any OpenSearch API endpoint. Supports all HTTP methods with custom paths, query parameters, request bodies, and headers. Use this when you need to access OpenSearch APIs that don't have dedicated tools, or when you need more control over the request. Leverages your knowledge of OpenSearch API documentation to construct appropriate requests.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| opensearch_url | Yes | OpenSearch endpoint URL. | |
| opensearch_username | No | Username for basic authentication. | |
| opensearch_password | No | Password for basic authentication. | |
| opensearch_no_auth | No | If true, connect without authentication. | |
| aws_region | No | AWS region for IAM/Serverless authentication. | |
| aws_iam_arn | No | IAM role ARN for role-based authentication. | |
| aws_profile | No | AWS profile name for authentication. | |
| aws_opensearch_serverless | No | If true, use OpenSearch Serverless service. | |
| opensearch_ssl_verify | No | If false, disable SSL certificate verification. | |
| opensearch_timeout | No | Connection timeout in seconds. | |
| path | Yes | The API endpoint path (e.g., "/_search", "/_cat/indices", "/my_index/_doc/1"). Should start with "/". | |
| method | No | HTTP method to use (GET, POST, PUT, DELETE, HEAD, PATCH) | GET |
| query_params | No | Query parameters to include in the request URL as key-value pairs | |
| body | No | Request body for GET/POST/PUT requests. Can be a JSON object, string, or None | |
| headers | No | Additional HTTP headers to include in the request |