Skip to main content

Plans API Introduction

Rob Sears

Alpha Stage

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.

The Plans API gives users the ability to explore the different cluster subscription plans available to their account. This API supports the following actions:

  • View all plans available for your account.
  • View a single plan available for your account.

All calls to the Plans API must be authenticated with an active API token.

The Bonsai Plan Object

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

Attribute Description
slug A String representing a machine-readable name for the plan. 

name A String representing the human-readable name of the plan.

price_in_cents An Integer representing the plan price in cents.

billing_interval_in_months An Integer representing the plan billing interval in months.
single_tenant A Boolean indicating whether the plan is single-tenant or not. A value of false indicates the Cluster will share hardware with other Clusters. Single tenant environments can be reached via the public Internet. Additional documentation here.
private_network A Boolean indicating whether the plan is on a publicly addressable network. Private plans provide environments that cannot be reached by the public Internet. A VPC connection will be needed to communicate with a private cluster.
available_releases An Array with a collection of search release slugs available for the plan. Additional information about a release can be retrieved from the Releases API.
available_spaces An Array with a collection of Space paths available for the plan. Additional information about a space can be retrieved from the Spaces API.

View all plans

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

Supported Parameters

No parameters are supported for this action.

HTTP Request

An HTTP GET call is made to /plans.

HTTP Response

Upon success, Bonsai responds with an HTTP 200: OK code, along with a JSON list representing the Plans available to your account:

{
   "plans": [
      {
          "slug": "sandbox-aws-us-east-1",
          "name": "Sandbox",
          "price_in_cents": 0,
          "billing_interval_in_months": 1,
          "single_tenant": false,
          "private_network": false,
          "available_releases": [
              "7.2.0"
          ],
          "available_spaces": [
              "omc/bonsai-gcp/us-east4/common",
              "omc/bonsai/ap-northeast-1/common",
              "omc/bonsai/ap-southeast-2/common",
              "omc/bonsai/eu-central-1/common",
              "omc/bonsai/eu-west-1/common",
              "omc/bonsai/us-east-1/common",
              "omc/bonsai/us-west-2/common"
          ]
      },
      {
         "slug": "standard-sm",
         "name": "Standard Small",
         "price_in_cents": 5000,
         "billing_interval_in_months": 1,
         "single_tenant": false,
         "private_network": false,
         "available_releases": [
            "elasticsearch-5.6.16",
            "elasticsearch-6.8.3",
            "elasticsearch-7.2.0"
         ],
         "available_spaces": [
            "omc/bonsai/ap-northeast-1/common",
            "omc/bonsai/ap-southeast-2/common",
            "omc/bonsai/eu-central-1/common",
            "omc/bonsai/eu-west-1/common",
            "omc/bonsai/us-east-1/common",
            "omc/bonsai/us-west-2/common"
         ]
      }
    ]
  }

View a single plan

The Bonsai API provides a method to retrieve information about a single Plan available to your account.
Supported Parameters

No parameters are supported for this action.

HTTP Request

An HTTP GET call is made to /plans/[:plan-slug].

HTTP Response

Upon success, Bonsai will respond with an HTTP 200: OK code, along with a JSON body representing the Plan object:

{
    "slug": "sandbox-aws-us-east-1",
    "name": "Sandbox",
    "price_in_cents": 0,
    "billing_interval_in_months": 1,
    "single_tenant": false,
    "private_network": false,
    "available_releases": [
        "elasticsearch-7.2.0"
    ],
    "available_spaces": [
        "omc/bonsai-gcp/us-east4/common",
        "omc/bonsai/ap-northeast-1/common",
        "omc/bonsai/ap-southeast-2/common",
        "omc/bonsai/eu-central-1/common",
        "omc/bonsai/eu-west-1/common",
        "omc/bonsai/us-east-1/common",
        "omc/bonsai/us-west-2/common"
    ]
}

Related articles