+++
title = "Releases API Introduction"
weight = 77
updated = 2023-07-07
aliases = ["/docs/releases-api-introduction.html", "/docs/bonsai-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 available to their account.

### Alpha Stage

{% admonition(title="Info") %}
The Bonsai API is currently in its Alpha release phase. It may not be feature-complete, and is subject to change without notice. If you have any questions about the roadmap of the API, please reach out to [support](mailto:support@bonsai.io).
{% end %}

The Releases API provides users a method to explore the different versions of Elasticsearch 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/authentication/overview/index.md) with an active [API token](@/docs/account/api-tokens/index.md).

## 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 name for the release. |
| slug | A String representing the machine-readable name for the deployment. |
| version | A String representing the version of the release. |
| multitenant | A Boolean representing whether or not the release is available on multitenant deployments. |

## 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:

```javascript
{
  "releases": [
    {
      "name": "Elasticsearch 5.6.16",
      "slug": "elasticsearch-5.6.16",
      "service_type": "elasticsearch",
      "version": "5.6.16",
      "multitenant": true
    },
    {
      "name": "Elasticsearch 6.5.4",
      "slug": "elasticsearch-6.5.4",
      "service_type": "elasticsearch",
      "version": "6.5.4",
      "multitenant": true
    },
    {
      "name": "Elasticsearch 7.2.0",
      "slug": "elasticsearch-7.2.0",
      "service_type": "elasticsearch",
      "version": "7.2.0",
      "multitenant": true
    }
  ]
}
```

## 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.2.0",
  "slug": "elasticsearch-7.2.0",
  "service_type": "elasticsearch",
  "version": "7.2.0",
  "multitenant": true
}
```