Class default

Sandbox client — spark (FaaS) functions/apps, long-running runtimes, and their K8s deployments. All routes go through the sandbox/… gateway prefix (/luma/sandbox/v1/...), matching the sandbox service's REST surface (internal/controllers/{spark.go,spark.v1.go,runtime.v1.go} and the deployment lifecycle in internal/controllers/ecomm/deployment.go).

Hierarchy (View Summary)

default
- default

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/platformBaseClient.ts:24

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

cancelSpark

cancelSpark(
uuid: string,
env?: SparkEnv,
): Promise<AxiosResponse<{ status: boolean }, any>>
Cancel an in-progress spark deployment.
Parameters
- uuid: string
- Optionalenv: SparkEnv
  defaults to "dev" on the server if omitted
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:98

createRuntime

createRuntime(
payload: CreateRuntimePayload,
): Promise<AxiosResponse<{ status: boolean }, any>>
Create a new runtime.
Parameters
- payload: CreateRuntimePayload
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:167

createSpark

createSpark(payload: CreateSparkPayload): Promise<AxiosResponse<Spark, any>>
Create a new spark (function or app).
Parameters
- payload: CreateSparkPayload
Returns Promise<AxiosResponse<Spark, any>>
Example
```
const spark = await platform.sandbox().createSpark({ name: "myFunction", runtime: "node20", memory: 256 })
```
- Defined in v0.10/api/sandbox.ts:51

deleteRuntime

deleteRuntime(ref: string): Promise<AxiosResponse<{ status: boolean }, any>>
Delete a runtime.
Parameters
- ref: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:188

deleteSpark

deleteSpark(uuid: string): Promise<AxiosResponse<{ status: boolean }, any>>
Delete a spark.
Parameters
- uuid: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:72

deployRuntime

deployRuntime(ref: string): Promise<AxiosResponse<{ status: boolean }, any>>
(Re)deploy a runtime.
Parameters
- ref: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:195

deploySpark

deploySpark(
uuid: string,
version: string,
): Promise<AxiosResponse<{ status: boolean }, any>>
Deploy a specific spark version to the dev environment.
Parameters
- uuid: string
- version: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:86

execSpark

execSpark(
    name: string,
    data?: any,
    options?: {
        headers?: Record<string, string>;
        method?: "GET" | "DELETE" | "POST" | "PUT" | "PATCH";
        query?: Record<string, string>;
    },
): Promise<AxiosResponse<any, any>>
Execute a deployed spark by name. Mirrors spark() but accepts the full request shape (method/query/headers) — the exec route accepts GET/POST/PATCH/PUT/DELETE.
Parameters
- name: string
- Optionaldata: any
- Optionaloptions: {
      headers?: Record<string, string>;
      method?: "GET" | "DELETE" | "POST" | "PUT" | "PATCH";
      query?: Record<string, string>;
  }
Returns Promise<AxiosResponse<any, any>>
Example
```
const result = await platform.sandbox().execSpark("myFunction", { foo: "bar" })
const result = await platform.sandbox().execSpark("myFunction", undefined, { method: "GET" })
```
- Defined in v0.10/api/sandbox.ts:124

getRuntime

getRuntime(ref: string): Promise<AxiosResponse<{ status: boolean }, any>>
Get a runtime by ref (name/uuid).
Parameters
- ref: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:174

getSpark

getSpark(uuid: string): Promise<AxiosResponse<Spark, any>>
Get a spark by uuid.
Parameters
- uuid: string
Returns Promise<AxiosResponse<Spark, any>>
- Defined in v0.10/api/sandbox.ts:58

listRuntimes

listRuntimes(): Promise<AxiosResponse<Runtime[], any>>
List all runtimes for the current project.

Returns Promise<AxiosResponse<Runtime[], any>>
- Defined in v0.10/api/sandbox.ts:160

listSparks

listSparks(): Promise<AxiosResponse<Spark[], any>>
List all sparks for the current project.

Returns Promise<AxiosResponse<Spark[], any>>
- Defined in v0.10/api/sandbox.ts:79

releaseSpark

releaseSpark(
uuid: string,
version: string,
): Promise<AxiosResponse<{ status: boolean }, any>>
Release a deployed spark version to the live/public environment.
Parameters
- uuid: string
- version: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:109

restartRuntime

restartRuntime(ref: string): Promise<AxiosResponse<{ status: boolean }, any>>
Restart a running runtime.
Parameters
- ref: string
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:202

runtimeLogs

runtimeLogs(
ref: string,
params?: RuntimeLogsParams,
): Promise<AxiosResponse<any, any>>
Fetch logs for a runtime.
Parameters
- ref: string
- Optionalparams: RuntimeLogsParams
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/sandbox.ts:209

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

spark

spark(name: string, data: any): Promise<AxiosResponse<any, any>>
Call the sandbox service to execute a serverless function.

Kept for backwards compatibility — equivalent to execSpark(name, data).
Parameters
- name: string
- data: any
Returns Promise<AxiosResponse<any, any>>
Example
```
const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
```
- Defined in v0.10/api/sandbox.ts:41

sparkLogs

sparkLogs(
uuid: string,
params?: SparkLogsParams,
): Promise<AxiosResponse<any, any>>
Fetch logs for a spark.
Parameters
- uuid: string
- Optionalparams: SparkLogsParams
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/sandbox.ts:142

sparkTier

sparkTier(): Promise<AxiosResponse<SparkTier, any>>
Get the current project's spark tier (plan/quota).

Returns Promise<AxiosResponse<SparkTier, any>>
- Defined in v0.10/api/sandbox.ts:149

updateRuntime

updateRuntime(
ref: string,
payload: UpdateRuntimePayload,
): Promise<AxiosResponse<{ status: boolean }, any>>
Update a runtime's image/resources/env vars/tags.
Parameters
- ref: string
- payload: UpdateRuntimePayload
Returns Promise<AxiosResponse<{ status: boolean }, any>>
- Defined in v0.10/api/sandbox.ts:181

updateSpark

updateSpark(
uuid: string,
payload: UpdateSparkPayload,
): Promise<AxiosResponse<Spark, any>>
Update a spark's memory/settings/env vars.
Parameters
- uuid: string
- payload: UpdateSparkPayload
Returns Promise<AxiosResponse<Spark, any>>
- Defined in v0.10/api/sandbox.ts:65

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

cancelSpark

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

createRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

createSpark

Parameters

Returns Promise<AxiosResponse<Spark, any>>

Example

deleteRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

deleteSpark

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

deployRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

deploySpark

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

execSpark

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

getRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

getSpark

Parameters

Returns Promise<AxiosResponse<Spark, any>>

listRuntimes

Returns Promise<AxiosResponse<Runtime[], any>>

listSparks

Returns Promise<AxiosResponse<Spark[], any>>

releaseSpark

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

restartRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

runtimeLogs

Parameters

Returns Promise<AxiosResponse<any, any>>

setClient

Parameters

Returns default

spark

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

sparkLogs

Parameters

Returns Promise<AxiosResponse<any, any>>

sparkTier

Returns Promise<AxiosResponse<SparkTier, any>>

updateRuntime

Parameters

Returns Promise<AxiosResponse<{ status: boolean }, any>>

updateSpark

Parameters

Returns Promise<AxiosResponse<Spark, any>>

Settings

`Protected`env

`Protected`host

`Protected`token