API

Every bonsai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Clusters

get

clusters.get Get Bonsai cluster details by slug Risk: read

await corsair.bonsai.api.clusters.get({});

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`cluster`	`object`	Yes	—

cluster full type

{
  slug: string,
  name: string,
  uri: string,
  plan: {
    slug: string,
    uri: string
  },
  release: {
    version: string,
    slug: string,
    package_name: string,
    service_type: string,
    uri: string
  },
  space: {
    path: string,
    region: string,
    uri: string
  },
  stats: {
    docs: number,
    shards_used: number,
    data_bytes_used: number
  },
  access: {
    host: string,
    port: number,
    scheme: string
  },
  state: string
}

Spaces

get

spaces.get Retrieve space details by path Risk: read

await corsair.bonsai.api.spaces.get({});

Input

Name	Type	Required	Description
`path`	`string`	Yes	—

Output

Name	Type	Required	Description
`path`	`string`	Yes	—
`private_network`	`boolean`	Yes	—
`cloud`	`object`	Yes	—

cloud full type

{
  provider: string,
  region: string
}

list

spaces.list List all spaces Risk: read

await corsair.bonsai.api.spaces.list({});

Input: empty object Output

Name	Type	Required	Description
`spaces`	`object[]`	Yes	—

spaces full type

{
  path: string,
  private_network: boolean,
  cloud: {
    provider: string,
    region: string
  }
}[]

Overview

Plugins

Clusters

get

Spaces

get

list

​Clusters

​get

​Spaces

​get

​list

Clusters

get

Spaces

get

list