Aiven

Aiven Service:_OpenSearch API

The Service:_OpenSearch API from Aiven — 19 operation(s) for service:_opensearch.

GitHub OpenAPI

Operations 24

GET /project/{project}/service/{service_name}/opensearch/acl Show OpenSearch ACL configuration #
POST /project/{project}/service/{service_name}/opensearch/acl Set OpenSearch ACL configuration #
PUT /project/{project}/service/{service_name}/opensearch/acl Update OpenSearch ACL configuration #
POST /project/{project}/service/{service_name}/opensearch/{index_pattern}/_close Open OpenSearch indices #
POST /project/{project}/service/{service_name}/index/close_multiple Close multiple OpenSearch indexes #
DELETE /project/{project}/service/{service_name}/index/{index_pattern} Delete an OpenSearch index #
GET /project/{project}/service/{service_name}/index List OpenSearch indexes #
POST /project/{project}/service/{service_name}/opensearch/{index_pattern}/_open Open OpenSearch indices #
POST /project/{project}/service/{service_name}/index/open_multiple Open multiple OpenSearch indexes #
GET /project/{project}/service/{service_name}/opensearch/security Show OpenSearch security configuration status #
PUT /project/{project}/service/{service_name}/opensearch/security/admin Change Opensearch Security Admin password #
POST /project/{project}/service/{service_name}/opensearch/security/admin Enable Opensearch Security Admin by setting the password #
POST /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name} Create a snapshot to custom repository #
DELETE /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name} Delete a snapshot from custom repository #
GET /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name} Show snapshot details #
GET /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_all List all snapshots in custom repository #
POST /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_verify Verify custom repo name is allowed #
POST /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_restore Restore a snapshot from custom repository #
POST /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_restore_check Dry run endpoint to check for conflicted indices before restoring a snapshot #
GET /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_status Show full status of a snapshot in custom repository #
GET /project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_status List currently running snapshots for a custom repository #
GET /project/{project}/service/{service_name}/opensearch/_snapshot List custom repositories defined for OpenSearch service #
GET /project/{project}/service/{service_name}/opensearch/_snapshot/restoration_in_progress List restorations in progress for this service #
GET /project/{project}/service/{service_name}/opensearch/tiered-storage/summary Get OpenSearch tiered storage summary #

Documentation

📖
Documentation
https://aiven.io/docs/tools/api
📖
Authentication
https://aiven.io/docs/platform/howto/create_authentication_token

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/openapi/aiven-service-opensearch-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-service-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-service-list.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-project-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-account-auth.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-billing-group.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-organization-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-vpc-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-user-info.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-project.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-kafka-service.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-postgresql-service.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-list-services.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aiven:aiven-service-opensearch-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aiven-service-opensearch-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@aiven.io
    name: Aiven support team
    url: https://aiven.io/support-services
  title: 'Aiven API Documentation Service: Open Search API'
  version: v1
  x-logo:
    altText: Aiven logo
    backgroundColor: '#fafafa'
    href: https://api.aiven.io/doc
    url: https://aiven.io/assets/img/aiven-logo.png
  description: '# Introduction


    Direct link to openapi.json for use with external tools


    Aiven is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud.'
servers:
- url: https://api.aiven.io/v1
tags:


# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/openapi/aiven-service-opensearch-api-openapi.yml