OpenSearch

OpenSearch is the open source, community-driven search, analytics, and observability suite (forked from Elasticsearch and Kibana) maintained under the Linux Foundation's OpenSearch Software Foundation. The platform exposes REST APIs across the search engine, the OpenSearch Dashboards UI, and a set of plugins. The Security plugin REST API lets administrators programmatically create and manage internal users, roles, role mappings, action groups, tenants, security configuration, audit log configuration, and SSL certificates.

OpenSearch publishes 15 API contracts indexed on the APIs.io network, including Account API, Action Groups API, Allowlist API, and 12 more. Tagged areas include OpenSearch, Search, Analytics, Observability, and Open Source.

The OpenSearch catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

OpenSearch’s developer surface includes authentication, developer portal, documentation, getting-started guide, engineering blog, and 18 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

37.2/100 thin ▬ flat Agent 26/100 agent aware Front door AI 5/6 prominent Heartbeat 97/100 alive Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

1 published contract 1 MCP Servers 10 Agent Skills

OpenSearch Search Analytics Observability Open Source Security

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Cybersecurity Management

BC-620

AccountAction GroupsInternal UsersRole MappingsRoles

PUT /_plugins/_security/api/internalusers/{username} PUT /_plugins/_security/api/rolesmapping/{name} PUT /_plugins/_security/api/roles/{name} GET /_plugins/_security/api/account

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 37.2/100 · thin

Contract Quality 9.2 / 19

Developer Ergonomics 8.1 / 15

Access Clarity 1.2 / 15

Operational Transparency 2.3 / 10

Contract Governance 0.9 / 9

Discoverability 4.9 / 8

Regulatory Posture 2.5 / 15

Create-or-Update Ergonomics 2.2 / 10

Agent readiness — 26/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/opensearch/"><img src="https://apis.io/badge/opensearch/card.svg" alt="OpenSearch on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)

7 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 7.9 — up to +18.4 composite points
Contract Quality scores 49.3 — up to +12.7 composite points
Contract Governance scores 9.8 — up to +10.8 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/opensearch/apis.yml: open an issue on github.com/api-evangelist/opensearch to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Search API (Elasticsearch / OpenSearch shape)	mixed	49.2	-	2
Retrieval, Vector and RAG	mixed	49.2	-	2
Agent Skills (SKILL.md packages)	mixed	49.2	-	2
Infrastructure-as-Code Provider Registries (Terraform, OpenTofu, Pulumi)	mixed	49.2	-	2
OpenSSF Best Practices Badge Holders	mixed	49.2	-	2
Artifact Hub Cloud-Native Packages	mixed	49.2	-	2

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 2

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

Model Context Protocol (MCP)

measured — observed by APIs.io (documented)

OpenAPI

measured — observed by APIs.io (published)

APIs 15

Individual APIs this provider publishes, each with its own machine-readable definition.

OpenSearch Search and Indexing REST API

The core OpenSearch REST API for indexing documents, performing search queries (full text, vector, hybrid), aggregations, and managing indices, mappings, templates, aliases, and...

OpenSearch Account API

Self-service account endpoints for the calling user.

OpenSearch Action Groups API

Reusable groups of cluster and index permissions.

OpenSearch Allowlist API

Allowlist of HTTP APIs available to non-admin users.

OpenSearch Audit API

Audit log configuration.

OpenSearch Cache API

Manage the security cache.

OpenSearch Certificates API

Inspect SSL certificates loaded by the cluster.

OpenSearch Health API

Security plugin health check.

OpenSearch Internal Users API

CRUD for internal user database entries.

OpenSearch Nodes DN API

Allowlisted distinguished names for cross-cluster nodes.

OpenSearch Role Mappings API

Map users, backend roles, and hosts to security roles.

OpenSearch Roles API

CRUD for security roles and their permissions.

OpenSearch Security Config API

Inspect and update the running security configuration.

OpenSearch SSL Info API

Inspect SSL handshake information for the calling client.

OpenSearch Tenants API

Multi-tenancy support for OpenSearch Dashboards.

Scroll for all 15

Open Collections 15

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

OpenSearch Security Plugin REST Account API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Action Groups API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Allowlist API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Audit API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Cache API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Certificates API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Health API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Internal Users API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Nodes DN API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Role Mappings API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Roles API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Security Config API

OPEN COLLECTION

OpenSearch Security Plugin REST API

OPEN COLLECTION

OpenSearch Security Plugin REST Account SSL Info API

OPEN COLLECTION

OpenSearch Security Plugin REST Account Tenants API

OPEN COLLECTION

Scroll for all 15

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

MCP Server

MCP SERVER

Agent Skills 10

Packaged agent skills for driving this provider's APIs from an AI assistant.

aoss-nextgen-provisioning

AGENT SKILL

aws-setup

AGENT SKILL

cloud

AGENT SKILL

log-analytics

AGENT SKILL

observability

AGENT SKILL

opensearch-launchpad

AGENT SKILL

opensearch-skills

AGENT SKILL

search

AGENT SKILL

solr-opensearch-migration-advisor

AGENT SKILL

trace-analytics

AGENT SKILL

Scroll for all 10

OpenSearch API pricing

Not yet checked against OpenSearch's own pricing page. Compiled by API Evangelist on 2026-05-04; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Free freemium	Free
Professional paid	Free
Enterprise enterprise	—

Plan details, limits and sources →

Rate limits

Free Tier Default: 10 requests per minute
Free Tier Monthly Quota: 1000 requests per month
Professional Tier Default: 100 requests per minute

Compiled by API Evangelist, not yet checked against OpenSearch's documentation. All 5 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Opensearch Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Opensearch Rate Limits

5 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

OpenSearch

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Opensearch Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Opensearch Context

3 classes · 0 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

OpenSearch — jsonschema rules

5 rules · 4 warnings 1 info

SPECTRAL

JSON Schema 1

Standalone JSON Schema definitions for this provider's data models.

OpenSearch Security Role

7 properties

JSON SCHEMA

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Opensearch Authentication

http · 1 scheme

SECURITY

Opensearch Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Opensearch Agentic Access

47 operations · 27 acting

AGENTIC

Resources

Get Started 2

Portal, sign-up, and the first successful call

Portal

Portal

GettingStarted

GettingStarted

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 3

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

MCPServer

MCPServer

AgentSkills

AgentSkills

Build 3

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

GitHubRepository

GitHubRepository

GitHubRepository

GitHubRepository

Access & Security 3

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Security

Security

Operate 3

Status, limits, changes, and where to get help

RateLimits

RateLimits

Community

Community

Forums

Forums

Commercial 3

Pricing, plans, and the legal terms of use

Plans

Plans

FinOps

FinOps

License

License

Company 3

The organization behind the API

LinkedIn

Website

Website

Blog

Blog

Other 2

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Download

Download

Source (apis.yml)

aid: opensearch
name: OpenSearch
description: OpenSearch is the open source, community-driven search, analytics, and observability suite (forked from Elasticsearch
  and Kibana) maintained under the Linux Foundation's OpenSearch Software Foundation. The platform exposes REST APIs across
  the search engine, the OpenSearch Dashboards UI, and a set of plugins. The Security plugin REST API lets administrators
  programmatically create and manage internal users, roles, role mappings, action groups, tenants, security configuration,
  audit log configuration, and SSL certificates.
type: Index
deliveryModel:
  model: unknown
  license: License (Apache 2.0)
  open_source: false
  commercial: false
  callable_host: false
  label: Delivery model not determined — needs a product licence on record
  confidence: low
  source:
  - license
  - openapi
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
position: Consuming
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/opensearch.png
tags:
- OpenSearch
- Search
- Analytics
- Observability
- Open Source
- Security
tags_raw:
- OpenSearch
- Search
- Analytics
- Observability
- Open Source
- Security
- Open-Source
created: '2025-01-08'
modified: '2026-05-19'
url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/apis.yml
specificationVersion: '0.23'
apis:
- aid: opensearch:opensearch-search-api
  name: OpenSearch Search and Indexing REST API
  description: The core OpenSearch REST API for indexing documents, performing search queries (full text, vector, hybrid),
    aggregations, and managing indices, mappings, templates, aliases, and snapshots.
  humanURL: https://docs.opensearch.org/latest/api-reference/
  baseURL: https://{cluster-host}:9200
  tags:
  - Search
  - Indexing
  - Vector Search
  - Aggregations
  properties:
  - type: Documentation
    url: https://docs.opensearch.org/latest/api-reference/
  - type: Documentation
    url: https://docs.opensearch.org/latest/search-plugins/
  - type: Reference
    url: https://docs.opensearch.org/latest/api-reference/search/
- aid: opensearch:opensearch-account-api
  name: OpenSearch Account API
  description: Self-service account endpoints for the calling user.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Account
  properties:
  - type: OpenAPI
    url: openapi/opensearch-account-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-action-groups-api
  name: OpenSearch Action Groups API
  description: Reusable groups of cluster and index permissions.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Action Groups
  properties:
  - type: OpenAPI
    url: openapi/opensearch-action-groups-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-allowlist-api
  name: OpenSearch Allowlist API
  description: Allowlist of HTTP APIs available to non-admin users.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Allowlist
  properties:
  - type: OpenAPI
    url: openapi/opensearch-allowlist-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-audit-api
  name: OpenSearch Audit API
  description: Audit log configuration.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Audit
  properties:
  - type: OpenAPI
    url: openapi/opensearch-audit-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-cache-api
  name: OpenSearch Cache API
  description: Manage the security cache.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Cache
  properties:
  - type: OpenAPI
    url: openapi/opensearch-cache-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-certificates-api
  name: OpenSearch Certificates API
  description: Inspect SSL certificates loaded by the cluster.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Certificates
  properties:
  - type: OpenAPI
    url: openapi/opensearch-certificates-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-health-api
  name: OpenSearch Health API
  description: Security plugin health check.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/opensearch-health-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-internal-users-api
  name: OpenSearch Internal Users API
  description: CRUD for internal user database entries.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Internal Users
  properties:
  - type: OpenAPI
    url: openapi/opensearch-internal-users-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-nodes-dn-api
  name: OpenSearch Nodes DN API
  description: Allowlisted distinguished names for cross-cluster nodes.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Nodes DN
  properties:
  - type: OpenAPI
    url: openapi/opensearch-nodes-dn-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-role-mappings-api
  name: OpenSearch Role Mappings API
  description: Map users, backend roles, and hosts to security roles.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Role Mappings
  properties:
  - type: OpenAPI
    url: openapi/opensearch-role-mappings-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-roles-api
  name: OpenSearch Roles API
  description: CRUD for security roles and their permissions.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Roles
  properties:
  - type: OpenAPI
    url: openapi/opensearch-roles-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-security-config-api
  name: OpenSearch Security Config API
  description: Inspect and update the running security configuration.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Security Config
  properties:
  - type: OpenAPI
    url: openapi/opensearch-security-config-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-ssl-info-api
  name: OpenSearch SSL Info API
  description: Inspect SSL handshake information for the calling client.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - SSL Info
  properties:
  - type: OpenAPI
    url: openapi/opensearch-ssl-info-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
- aid: opensearch:opensearch-tenants-api
  name: OpenSearch Tenants API
  description: Multi-tenancy support for OpenSearch Dashboards.
  humanURL: https://docs.opensearch.org/latest/security/access-control/api/
  baseURL: https://{cluster-host}:9200
  tags:
  - Tenants
  properties:
  - type: OpenAPI
    url: openapi/opensearch-tenants-api-openapi.yml
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/api/
  - type: Documentation
    url: https://docs.opensearch.org/latest/security/access-control/index/
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json
  - type: JSONLDContext
    url: https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
common:
- type: Plans
  url: plans/opensearch-plans-pricing.yml
- type: RateLimits
  url: rate-limits/opensearch-rate-limits.yml
- type: FinOps
  url: finops/opensearch-finops.yml
- type: CapabilityMap
  url: capabilities/opensearch-capability-edges.yml
  name: OpenSearch Business Capability Map
- type: AgenticAccess
  url: agentic-access/opensearch-agentic-access.yml
- type: DomainSecurity
  url: security/opensearch-domain-security.yml
- type: Authentication
  url: authentication/opensearch-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/opensearch-project
- url: https://opensearch.org/
  name: OpenSearch
  type: Website
- url: https://docs.opensearch.org/
  name: Documentation Portal
  type: Portal
- url: https://docs.opensearch.org/latest/api-reference/
  name: API Reference
  type: Documentation
- url: https://docs.opensearch.org/latest/getting-started/
  name: Getting Started
  type: GettingStarted
- url: https://opensearch.org/community/
  name: Community
  type: Community
- url: https://forum.opensearch.org/
  name: Discussion Forum
  type: Forums
- url: https://opensearch.org/blog/
  name: Blog
  type: Blog
- url: https://github.com/opensearch-project
  name: GitHub Organization
  type: GitHubOrganization
- url: https://github.com/opensearch-project/security
  name: Security Plugin Source
  type: GitHubRepository
- url: https://github.com/opensearch-project/OpenSearch
  name: OpenSearch Core Source
  type: GitHubRepository
- url: https://opensearch.org/downloads/
  name: Downloads
  type: Download
- url: https://opensearch.org/license.html
  name: License (Apache 2.0)
  type: License
- url: https://opensearch.org/security
  name: Security Advisories
  type: Security
- name: MCP Server
  url: https://github.com/opensearch-project/opensearch-mcp-server-py
  type: MCPServer
- name: Agent Skills
  url: https://github.com/opensearch-project/opensearch-agent-skills
  type: AgentSkills
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

OpenSearch API — frequently asked questions

Does OpenSearch have an API?

Yes. APIs.io lists 15 APIs from OpenSearch, including OpenSearch Search and Indexing REST API, OpenSearch Account API and OpenSearch Action Groups API, and 12 more.

Is there an OpenAPI specification for the OpenSearch API?

Yes. APIs.io indexes 14 OpenAPI specifications for OpenSearch, each linked for download from this page.

How do I authenticate with the OpenSearch API?

OpenSearch uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Opensearch Authentication.

How much does the OpenSearch API cost?

APIs.io lists 3 pricing plans for OpenSearch, with each plan's price, limits and inclusions under Pricing on this page.

Does OpenSearch have an MCP server?

Yes. APIs.io lists 1 MCP server for OpenSearch.

Is the OpenSearch API ready for AI agents?

OpenSearch has a Kin Score of 37.2 out of 100 (thin) and an Agent Readiness score of 25.8 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/opensearch"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/opensearch/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/opensearch/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.