+++
title = "Releases API Introduction"
weight = 98
updated = 2026-10-13
aliases = ["/docs/releases-api-introduction.html", "/docs/bonsai-api/endpoints/releases-api/", "/docs/api/endpoints/releases-api/"]

[extra]
nav_title = "Releases API Introduction"
weight = 30
+++

The Releases API provides users a method to explore the different versions of Elasticsearch and OpenSearch available to their account.

{{ legacy_api_notice() }}

The Releases API provides users a method to explore the different versions of Elasticsearch and OpenSearch available to their account. This API supports the following actions:

- View all available releases for your account
- View a single release for your account

All calls to the Releases API must be [authenticated](@/docs/api/legacy/authentication/overview/index.md) with an active [API token](@/docs/account/api-tokens/index.md) that has the `account:read` [scope](@/docs/account/api-tokens/index.md#scopes).

## The Bonsai Release Object

The Bonsai API provides a standard format for Release objects. A Release object includes:

| Attribute | Description |
| --- | --- |
| name | A String representing the human-readable name of the release. |
| slug | A String representing the machine-readable name of the release. Use it as the `release` when [creating a cluster](@/docs/api/legacy/endpoints/cluster-api/index.md#create-new-cluster). |
| service_type | A String naming the search service: `elasticsearch` or `opensearch`. |
| version | A String representing the version of the release. |
| package_name | A String representing the package name of the release. |
| multitenant | A Boolean representing whether or not the release is available on multitenant deployments. |
| uri | A URI to retrieve more information about this release. |

## View all available releases

The Bonsai API provides a method to get a list of all releases available to your account. An HTTP GET call is made to the `/releases` endpoint, and Bonsai will return a JSON list of Release objects.

#### Supported Parameters

No parameters are supported for this action.

#### HTTP Request

An HTTP GET call is made to `/releases`.

#### HTTP Response

Upon success, Bonsai responds with an `HTTP 200: OK` code, along with a JSON list representing the releases available to your account, sorted by service type and then by version:

```javascript
{
  "releases": [
    {
      "name": "Elasticsearch 6.8.21",
      "slug": "elasticsearch-6.8.21",
      "service_type": "elasticsearch",
      "version": "6.8.21",
      "package_name": "6.8.21",
      "multitenant": true,
      "uri": "https://api.bonsai.io/releases/elasticsearch-6.8.21"
    },
    {
      "name": "Elasticsearch 7.10.2",
      "slug": "elasticsearch-7.10.2",
      "service_type": "elasticsearch",
      "version": "7.10.2",
      "package_name": "7.10.2",
      "multitenant": true,
      "uri": "https://api.bonsai.io/releases/elasticsearch-7.10.2"
    },
    {
      "name": "OpenSearch 2.19.4",
      "slug": "opensearch-2.19.4",
      "service_type": "opensearch",
      "version": "2.19.4",
      "package_name": "2.19.4",
      "multitenant": true,
      "uri": "https://api.bonsai.io/releases/opensearch-2.19.4"
    }
  ]
}
```

## View a single release

The Bonsai API provides a method to get information about a single release available to your account.

#### Supported Parameters

No parameters are supported for this action.

#### HTTP Request

An HTTP GET call is made to `/releases/[:slug]`.

#### HTTP Response

Upon success, Bonsai responds with an `HTTP 200: OK` code, along with a JSON body representing the Release object:

```javascript
{
  "name": "Elasticsearch 7.10.2",
  "slug": "elasticsearch-7.10.2",
  "service_type": "elasticsearch",
  "version": "7.10.2",
  "package_name": "7.10.2",
  "multitenant": true,
  "uri": "https://api.bonsai.io/releases/elasticsearch-7.10.2"
}
```

A slug that does not name a release available to your account gets an [HTTP 404: Not Found](@/docs/api/legacy/errors/404-not-found/index.md) error, with the message `Release not found.`