This is an earlier version of the OpenSearch documentation. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

OpenSearch language clients

OpenSearch provides clients in JavaScript, Python, Ruby, Java, PHP, .NET, Go and Rust.

OpenSearch clients

OpenSearch provides clients for the following programming languages and platforms:

• Python
  • OpenSearch high-level Python client
  • OpenSearch low-level Python client
• Java
  • OpenSearch Java client
• JavaScript
  • OpenSearch JavaScript (Node.js) client
• Go
  • OpenSearch Go client
• Ruby
  • OpenSearch Ruby client
• PHP
  • OpenSearch PHP client
• .NET
  • OpenSearch .NET clients
• Rust
  • OpenSearch Rust client

All clients are compatible with any version of OpenSearch.

Legacy clients

Most clients that work with Elasticsearch OSS 7.10.2 should work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.

OpenSearch 2.0.0 no longer supports compatibility with legacy clients. Due to breaking changes with REST APIs, some features are not supported when using OpenSearch 1.x clients to connect to OpenSearch 2.0.

If you test a legacy client and verify that it works, please submit a PR and add it to this table.