Class: DatabricksSandboxClient
REST client for Databricks Sandboxes and registered SSH keys.
Responses are validated before they reach the runtime. Requests use the supplied AppKit workspace client and emit sanitized diagnostics without access tokens or request headers.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DatabricksSandboxClient(
client):DatabricksSandboxClient
Creates a client and derives its stable workspace assignment scope.
Parameters
Section titled “Parameters”client
Section titled “client”WorkspaceClient$1
Returns
Section titled “Returns”DatabricksSandboxClient
Methods
Section titled “Methods”create()
Section titled “create()”create(
name?,signal?):Promise<{[key:string]:unknown;createTime?:string;gatewayHost?:string;idleTimeout?:string;lastStartTime?:string;name?:string;noAutostop?:boolean;sandboxId:string;status:string; }>
Creates a Sandbox with an optional service-managed name.
Parameters
Section titled “Parameters”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{[key: string]: unknown; createTime?: string; gatewayHost?: string; idleTimeout?: string; lastStartTime?: string; name?: string; noAutostop?: boolean; sandboxId: string; status: string; }>
delete()
Section titled “delete()”delete(
id,signal?):Promise<void>
Permanently deletes one Sandbox.
Parameters
Section titled “Parameters”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
get(
id,signal?):Promise<{[key:string]:unknown;createTime?:string;gatewayHost?:string;idleTimeout?:string;lastStartTime?:string;name?:string;noAutostop?:boolean;sandboxId:string;status:string; }>
Returns one Sandbox by ID.
Parameters
Section titled “Parameters”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{[key: string]: unknown; createTime?: string; gatewayHost?: string; idleTimeout?: string; lastStartTime?: string; name?: string; noAutostop?: boolean; sandboxId: string; status: string; }>
list()
Section titled “list()”list(
signal?):Promise<object[]>
Lists every Sandbox visible to the workspace client, following pagination.
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<object[]>
listKeys()
Section titled “listKeys()”listKeys(
signal?):Promise<object[]>
Lists SSH public keys registered in the workspace.
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<object[]>
registerKey()
Section titled “registerKey()”registerKey(
publicKey,name,signal?):Promise<{[key:string]:unknown;gatewayHost?:string;keyHash:string;name?:string; }>
Registers an SSH public key and returns the Databricks key record.
Parameters
Section titled “Parameters”publicKey
Section titled “publicKey”string
string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{[key: string]: unknown; gatewayHost?: string; keyHash: string; name?: string; }>
start()
Section titled “start()”start(
id,signal?):Promise<{[key:string]:unknown;createTime?:string;gatewayHost?:string;idleTimeout?:string;lastStartTime?:string;name?:string;noAutostop?:boolean;sandboxId:string;status:string; }>
Starts one Sandbox and returns its updated record.
Parameters
Section titled “Parameters”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{[key: string]: unknown; createTime?: string; gatewayHost?: string; idleTimeout?: string; lastStartTime?: string; name?: string; noAutostop?: boolean; sandboxId: string; status: string; }>
stop()
Section titled “stop()”stop(
id,signal?):Promise<{[key:string]:unknown;createTime?:string;gatewayHost?:string;idleTimeout?:string;lastStartTime?:string;name?:string;noAutostop?:boolean;sandboxId:string;status:string; }>
Stops one Sandbox and returns its updated record.
Parameters
Section titled “Parameters”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<{[key: string]: unknown; createTime?: string; gatewayHost?: string; idleTimeout?: string; lastStartTime?: string; name?: string; noAutostop?: boolean; sandboxId: string; status: string; }>
workspaceScope()
Section titled “workspaceScope()”workspaceScope():
string
Returns the workspace identifier used to partition Lakebase assignments.
Returns
Section titled “Returns”string