Class: SshClient

Browser client for the AppKit SSH plugin’s machine and project APIs.

Constructors

Constructor

new SshClient(basePath?): SshClient

Parameters

basePath?

string = "/api/databricks-sandbox"

Returns

SshClient

Properties

basePath

readonly basePath: string = "/api/databricks-sandbox"

Methods

addProject()

addProject(input): Promise<{ directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }>

Parameters

input

config?

Record<string, JSONType> = ...

machineId

string = ...

name?

string = ...

openPath?

string = ...

path?

string = ...

port?

number = ...

projectId?

string = ...

route?

boolean = ...

serviceDependencies?

("terminal" | "desktop" | "stats")[] = ...

stripPrefix?

boolean = ...

Returns

Promise<{ directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }>

---

create()

create(input?): Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>

Parameters

input?

desktop?

boolean = ...

Returns

Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>

---

delete()

delete(machineId): Promise<{ deleted: boolean; }>

Parameters

machineId

string

Returns

Promise<{ deleted: boolean; }>

---

listMachines()

listMachines(signal?): Promise<{ auto: boolean; machines: object[]; supported: boolean; }>

Parameters

signal?

AbortSignal

Returns

Promise<{ auto: boolean; machines: object[]; supported: boolean; }>

---

listProjects()

listProjects(signal?): Promise<{ pathPrefix: string; projects: object[]; }>

Parameters

signal?

AbortSignal

Returns

Promise<{ pathPrefix: string; projects: object[]; }>

---

openProjectTerminal()

openProjectTerminal(projectId): Promise<{ project: { directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }; service: { error?: string; kind: "terminal" | "desktop" | "stats"; openUrl: string; path: string; state: "error" | "starting" | "stopped" | "ready"; }; }>

Parameters

projectId

string

Returns

Promise<{ project: { directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }; service: { error?: string; kind: "terminal" | "desktop" | "stats"; openUrl: string; path: string; state: "error" | "starting" | "stopped" | "ready"; }; }>

---

removeProject()

removeProject(projectId): Promise<boolean>

Parameters

projectId

string

Returns

Promise<boolean>

---

resetProject()

resetProject(projectId): Promise<{ directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }>

Parameters

projectId

string

Returns

Promise<{ directory: string; error?: string; id: string; machineId: string; name: string; openUrl?: string; path: string; port: number; state: "error" | "starting" | "stopped" | "ready"; stripPrefix: boolean; }>

---

start()

start(machineId): Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>

Parameters

machineId

string

Returns

Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>

---

startService()

startService(machineId, service): Promise<{ error?: string; kind: "terminal" | "desktop" | "stats"; openUrl: string; path: string; state: "error" | "starting" | "stopped" | "ready"; }>

Parameters

machineId

string

service

"terminal" | "desktop" | "stats"

Returns

Promise<{ error?: string; kind: "terminal" | "desktop" | "stats"; openUrl: string; path: string; state: "error" | "starting" | "stopped" | "ready"; }>

---

stop()

stop(machineId): Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>

Parameters

machineId

string

Returns

Promise<{ autoStopSeconds?: number; canConnect: boolean; canStart: boolean; canStop: boolean; createdAt?: string; expiresAt: string; gatewayHost?: string; id: string; lastStartedAt?: string; name: string; projects: object[]; provider: "databricks-sandbox"; services: object[]; status: "error" | "unknown" | "starting" | "running" | "stopping" | "stopped"; }>