How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Aiven

Aiven Service:_OpenSearch API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Aiven Service:_OpenSearch API is one of 34 APIs that Aiven publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Service:_OpenSearch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 24 operations across 19 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.aiven.io/v1.

24 operations 19 paths 33 schemas 2 DELETE10 GET10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.aiven.io/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
Aiven support team
Resource Areas
1

Authentication & Security 2

Aiven Service:_OpenSearch API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 34 scopes.

  • tokenAuth — Header should be of the format authorization: aivenv1 . Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)
  • oauth2 — OAuth2 security scheme

Paths & Operations 24

Across 19 paths, the API surfaces 24 operations — 2 DELETE, 10 GET, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Service:_OpenSearch 24
GET
/project/{project}/service/{service_name}/opensearch/acl
Show OpenSearch ACL configuration
ServiceOpenSearchAclGet 2 params → 200
POST
/project/{project}/service/{service_name}/opensearch/acl
Set OpenSearch ACL configuration
ServiceOpenSearchAclSet 2 params body → 200
PUT
/project/{project}/service/{service_name}/opensearch/acl
Update OpenSearch ACL configuration
ServiceOpenSearchAclUpdate 2 params body → 200
POST
/project/{project}/service/{service_name}/opensearch/{index_pattern}/_close
Open OpenSearch indices
ServiceOpenSearchIndexClose 3 params → 200400409429502
POST
/project/{project}/service/{service_name}/index/close_multiple
Close multiple OpenSearch indexes
ServiceOpenSearchIndexCloseMultiple 2 params body → 200409
DELETE
/project/{project}/service/{service_name}/index/{index_pattern}
Delete an OpenSearch index
ServiceOpenSearchIndexDelete 3 params → 200403404409429502
GET
/project/{project}/service/{service_name}/index
List OpenSearch indexes
ServiceOpenSearchIndexList 2 params → 200409
POST
/project/{project}/service/{service_name}/opensearch/{index_pattern}/_open
Open OpenSearch indices
ServiceOpenSearchIndexOpen 3 params → 200409429502
POST
/project/{project}/service/{service_name}/index/open_multiple
Open multiple OpenSearch indexes
ServiceOpenSearchIndexOpenMultiple 2 params body → 200409
GET
/project/{project}/service/{service_name}/opensearch/security
Show OpenSearch security configuration status
ServiceOpenSearchSecurityGet 2 params → 200
PUT
/project/{project}/service/{service_name}/opensearch/security/admin
Change Opensearch Security Admin password
ServiceOpenSearchSecurityReset 2 params body → 200
POST
/project/{project}/service/{service_name}/opensearch/security/admin
Enable Opensearch Security Admin by setting the password
ServiceOpenSearchSecuritySet 2 params body → 200
POST
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}
Create a snapshot to custom repository
ServiceOpensearchCustomRepoCreateSnapshot 4 params body → 200400404409429502
DELETE
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}
Delete a snapshot from custom repository
ServiceOpensearchCustomRepoDeleteSnapshot 4 params → 200400404409429502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}
Show snapshot details
ServiceOpensearchCustomRepoShowSnapshot 4 params → 200404409429502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_all
List all snapshots in custom repository
ServiceOpensearchCustomRepoListSnapshots 3 params → 200404409429502
POST
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_verify
Verify custom repo name is allowed
ServiceOpensearchCustomRepoNameVerify 3 params → 200400404409429502
POST
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_restore
Restore a snapshot from custom repository
ServiceOpensearchCustomRepoRestoreSnapshot 4 params body → 200400404409429500502
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
ServiceOpensearchCustomRepoRestoreSnapshotCheck 4 params body → 200400404409429500502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_status
Show full status of a snapshot in custom repository
ServiceOpensearchCustomRepoShowSnapshotStatus 4 params → 200404409429502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/_status
List currently running snapshots for a custom repository
ServiceOpensearchCustomRepoSnapshotsInProgress 3 params → 200404409429502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot
List custom repositories defined for OpenSearch service
ServiceOpensearchListCustomRepos 2 params → 200409429502
GET
/project/{project}/service/{service_name}/opensearch/_snapshot/restoration_in_progress
List restorations in progress for this service
ServiceOpensearchListRestorationsInProgress 2 params → 200404409429502
GET
/project/{project}/service/{service_name}/opensearch/tiered-storage/summary
Get OpenSearch tiered storage summary
ServiceOpensearchTieredStorageSummary 2 params → 200404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ServiceOpensearchCustomRepoRestoreSnapshotRequestBody (11 properties), ServiceOpensearchTieredStorageSummaryResponse (7 properties), ServiceOpenSearchSecuritySetResponse (5 properties), ServiceOpenSearchSecurityGetResponse (5 properties). Each schema is shown below with its type and property counts.

ServiceOpensearchListCustomReposResponse
object
ServiceOpensearchListCustomReposResponse
3 properties 1 required
ServiceOpensearchCustomRepoSnapshotsInProgressResponse
object
ServiceOpensearchCustomRepoSnapshotsInProgressResponse
3 properties 1 required
ServiceOpenSearchSecuritySetResponse
object
ServiceOpenSearchSecuritySetResponse
5 properties 2 required
ServiceOpensearchCustomRepoCreateSnapshotResponse
object
ServiceOpensearchCustomRepoCreateSnapshotResponse
3 properties 1 required
ServiceOpensearchCustomRepoRestoreSnapshotRequestBody
object
ServiceOpensearchCustomRepoRestoreSnapshotRequestBody
11 properties 1 required
ServiceOpensearchCustomRepoListSnapshotsResponse
object
ServiceOpensearchCustomRepoListSnapshotsResponse
3 properties 1 required
ServiceOpensearchCustomRepoRestoreSnapshotCheckResponse
object
ServiceOpensearchCustomRepoRestoreSnapshotCheckResponse
5 properties 3 required
ServiceOpensearchListRestorationsInProgressResponse
object
ServiceOpensearchListRestorationsInProgressResponse
3 properties
ServiceOpenSearchIndexOpenMultipleRequestBody
object
ServiceOpenSearchIndexOpenMultipleRequestBody
1 property 1 required
ServiceOpenSearchSecuritySetRequestBody
object
ServiceOpenSearchSecuritySetRequestBody
1 property 1 required
ServiceOpenSearchAclUpdateRequestBody
object
ServiceOpenSearchAclUpdateRequestBody
1 property 1 required
ServiceOpenSearchIndexCloseMultipleResponse
object
ServiceOpenSearchIndexCloseMultipleResponse
3 properties 1 required
ServiceOpensearchCustomRepoDeleteSnapshotResponse
object
ServiceOpensearchCustomRepoDeleteSnapshotResponse
3 properties 1 required
ServiceOpensearchCustomRepoNameVerifyResponse
object
ServiceOpensearchCustomRepoNameVerifyResponse
3 properties
ServiceOpenSearchIndexCloseMultipleRequestBody
object
ServiceOpenSearchIndexCloseMultipleRequestBody
1 property 1 required
ServiceOpenSearchSecurityGetResponse
object
ServiceOpenSearchSecurityGetResponse
5 properties 2 required
ServiceOpensearchTieredStorageSummaryResponse
object
ServiceOpensearchTieredStorageSummaryResponse
7 properties 4 required
ServiceOpenSearchAclSetRequestBody
object
ServiceOpenSearchAclSetRequestBody
1 property 1 required
ServiceOpenSearchSecurityResetRequestBody
object
ServiceOpenSearchSecurityResetRequestBody
2 properties 2 required
ServiceOpenSearchIndexDeleteResponse
object
ServiceOpenSearchIndexDeleteResponse
2 properties
ServiceOpensearchCustomRepoShowSnapshotStatusResponse
object
ServiceOpensearchCustomRepoShowSnapshotStatusResponse
3 properties 1 required
ServiceOpensearchCustomRepoRestoreSnapshotResponse
object
ServiceOpensearchCustomRepoRestoreSnapshotResponse
3 properties 1 required
ServiceOpensearchCustomRepoShowSnapshotResponse
object
ServiceOpensearchCustomRepoShowSnapshotResponse
3 properties 1 required
ServiceOpensearchCustomRepoRestoreSnapshotCheckRequestBody
object
ServiceOpensearchCustomRepoRestoreSnapshotCheckRequestBody
5 properties 1 required
ServiceOpenSearchIndexListResponse
object
ServiceOpenSearchIndexListResponse
3 properties 1 required
ServiceOpenSearchIndexOpenResponse
object
ServiceOpenSearchIndexOpenResponse
3 properties 1 required
ServiceOpensearchCustomRepoCreateSnapshotRequestBody
object
ServiceOpensearchCustomRepoCreateSnapshotRequestBody
4 properties
ServiceOpenSearchSecurityResetResponse
object
ServiceOpenSearchSecurityResetResponse
5 properties 2 required
ServiceOpenSearchIndexOpenMultipleResponse
object
ServiceOpenSearchIndexOpenMultipleResponse
3 properties 1 required
ServiceOpenSearchAclGetResponse
object
ServiceOpenSearchAclGetResponse
3 properties 1 required
ServiceOpenSearchAclSetResponse
object
ServiceOpenSearchAclSetResponse
3 properties 1 required
ServiceOpenSearchAclUpdateResponse
object
ServiceOpenSearchAclUpdateResponse
3 properties 1 required
ServiceOpenSearchIndexCloseResponse
object
ServiceOpenSearchIndexCloseResponse
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-service-opensearch-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
AE Profile APIs.io
Aiven Application_Users API
AE Profile APIs.io
Aiven Authentication_Methods API
AE Profile APIs.io
Aiven Billing API
AE Profile APIs.io
Aiven BillingGroup API
AE Profile APIs.io
Aiven Cloud_platforms API
AE Profile APIs.io
Aiven Custom_Cloud API
AE Profile APIs.io
Aiven Domains API
AE Profile APIs.io
Aiven Groups API
AE Profile APIs.io
Aiven Organization_Vpc API
AE Profile APIs.io
Aiven OrganizationBillingGroup API
AE Profile APIs.io
Aiven OrganizationEmissions API
AE Profile APIs.io
#Service:_OpenSearch
← Back to A APIs
API Details
ID
aiven:aiven-service-opensearch-api
Base URL
https://api.aiven.io/v1
Docs
https://aiven.io/docs/tools/api
Provider
Aiven
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aiven-service-opensearch-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aiven-service-opensearch-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Aiven Service:_OpenSearch API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.