Bonsai

Bonsai Clusters API

The Clusters API from Bonsai — 2 operation(s) for clusters.

GitHub OpenAPI

Operations 5

GET /clusters View all clusters #
POST /clusters Create a new cluster #
GET /clusters/{slug} View a single cluster #
PUT /clusters/{slug} Update a cluster #
DELETE /clusters/{slug} Destroy a cluster #

Documentation

📖
Documentation
https://bonsai.io/docs/api/overview/
📖
APIReference
https://bonsai.io/docs/api/reference/
📖
Authentication
https://bonsai.io/docs/api/authentication/overview/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bonsai-io/openapi/bonsai-io-clusters-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/bonsai-io/json-schema/bonsai-io-cluster-schema.json
📊
JSONSchema
https://artifacts.apis.io/bonsai-io/json-schema/bonsai-io-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/bonsai-io/json-schema/bonsai-io-space-schema.json
📊
JSONSchema
https://artifacts.apis.io/bonsai-io/json-schema/bonsai-io-release-schema.json
📊
JSONSchema
https://artifacts.apis.io/bonsai-io/json-schema/bonsai-io-pagination-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/bonsai-io/apis.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/bonsai-io:bonsai-io-clusters-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

OpenAPI Specification

bonsai-io-clusters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bonsai Cloud Clusters API
  version: alpha
  description: Bonsai REST API for managing clusters and exploring plans, releases and spaces. GENERATED by API Evangelist from the public documentation at https://bonsai.io/docs/api/ on 2026-10-14; this is not the provider's own document. Every operation carries x-source naming the page it was read from.
  contact:
    email: support@bonsai.io
  x-generated-from: documentation
  x-generated: '2026-10-14'
  x-generator: api-evangelist (hand-transcribed from docs, local-v5)
servers:
- url: https://api.bonsai.io
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Clusters
paths:
  /clusters:
    get:
      operationId: listClusters
      summary: View all clusters
      tags:
      - Clusters
      x-source: https://bonsai.io/docs/api/endpoints/cluster-api/
      responses:
        '200':
          description: A paginated list of active clusters
          content:
            application/json:
              schema:
                type: object
                properties:
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                  clusters:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cluster'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Returns all active (not deprovisioned) clusters on the account. Paginated.
      parameters:
      - name: q
        in: query
        schema:
          type: string
        description: Optional. A query string for filtering matching clusters. This currently works on name
      - name: tenancy
        in: query
        schema:
          type: string
          enum:
          - parent
          - child
        description: Optional. Constrain results to parent or child cluster.
      - name: location
        in: query
        schema:
          type: string
        description: Optional. Account, region, space, or cluster path where the cluster is located; space path prefixes work.
      - name: page
        in: query
        schema:
          type: integer
          minimum: 1
        description: The page number, starting at 1
        x-source: https://bonsai.io/docs/api/reference/api-result-pagination/
      - name: size
        in: query
        schema:
          type: integer
          maximum: 100
        description: The size of each page, with a max of 100
        x-source: https://bonsai.io/docs/api/reference/api-result-pagination/
    post:
      operationId: createCluster
      summary: Create a new cluster
      tags:
      - Clusters
      x-source: https://bonsai.io/docs/api/endpoints/cluster-api/
      responses:
        '202':
          description: Cluster is being provisioned
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  monitor:
                    type: string
                    format: uri
                  status:
                    type: integer
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Required. The name for your new cluster.
                plan:
                  type: string
                  description: Slug of the plan for the cluster.
                space:
                  type: string
                  description: Space slug where the new cluster will be created.
                release:
                  type: string
                  description: The search service release to use.
  /clusters/{slug}:
    parameters:
    - name: slug
      in: path
      required: true
      schema:
        type: string
      description: The cluster slug.
    get:
      operationId: getCluster
      summary: View a single cluster
      tags:
      - Clusters
      x-source: https://bonsai.io/docs/api/endpoints/cluster-api/
      responses:
        '200':
          description: The cluster
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster:
                    $ref: '#/components/schemas/Cluster'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    put:
      operationId: updateCluster
      summary: Update a cluster
      tags:
      - Clusters
      x-source: https://bonsai.io/docs/api/endpoints/cluster-api/
      responses:
        '202':
          description: Cluster is being updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  monitor:
                    type: string
                    format: uri
                  status:
                    type: integer
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Update the name or plan of a cluster. Changing the name does not change its URL; updating the plan may trigger a data migration.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                plan:
                  type: string
    delete:
      operationId: deleteCluster
      summary: Destroy a cluster
      tags:
      - Clusters
      x-source: https://bonsai.io/docs/api/endpoints/cluster-api/
      responses:
        '202':
          description: Cluster is being deprovisioned
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  monitor:
                    type: string
                    format: uri
                  status:
                    type: integer
        '400':
          description: Missing or blank name; the cluster is not deleted
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: The request body must include the cluster's exact name (not its slug) as a confirmation guard.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The cluster's name, matched exactly including case.
components:
  schemas:
    Pagination:
      type: object
      properties:
        page_number:
          type: integer
        page_size:
          type: integer
        total_records:
          type: integer
    Cluster:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        uri:
          type: string
          format: uri
        plan:
          type: object
          properties:
            slug:
              type: string
            uri:
              type: string
        release:
          type: object
          properties:
            version:
              type: string
            slug:
              type: string
            package_name:
              type: string
            service_type:
              type: string
            uri:
              type: string
        space:
          type: object
          properties:
            path:
              type: string
            region:
              type: string
            uri:
              type: string
        stats:
          type: object
          properties:
            docs:
              type: integer
            shards_used:
              type: integer
            data_bytes_used:
              type: integer
        access:
          type: object
          properties:
            host:
              type: string
            port:
              type: integer
            scheme:
              type: string
        state:
          type: string
          enum:
          - DEPROVISIONED
          - DEPROVISIONING
          - DISABLED
          - MAINTENANCE
          - PROVISIONED
          - PROVISIONING
          - READONLY
          - UPDATING PLAN
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
        status:
          type: integer
  responses:
    NotFound:
      description: 'HTTP 404: Not Found'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: 'HTTP 429: Too Many Requests'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: 'HTTP 403: Forbidden - token lacks the required scope'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: 'HTTP 401: Unauthorized'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: 'HTTP 422: Unprocessable Entity'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer bonsai_<key>_<secret>'
    basicAuth:
      type: http
      scheme: basic
      description: The token's key and secret as username and password.