Skip to content
dbx tools

Variable: NewSandboxProjectRecordSchema

const NewSandboxProjectRecordSchema: ZodObject<{ config: ZodRecord<ZodString, ZodJSONSchema>; directory: ZodString; machineId: ZodString; name: ZodString; openPath: ZodOptional<ZodString>; path: ZodString; port: ZodNumber; projectId: ZodString; projectPath: ZodString; route: ZodDefault<ZodBoolean>; serviceDependencies: ZodDefault<ZodArray<ZodEnum<{ desktop: "desktop"; stats: "stats"; terminal: "terminal"; }>>>; stripPrefix: ZodBoolean; userId: ZodString; workspaceScope: ZodString; }, $strict>

NewSandboxProjectRecord fields

Section titled “NewSandboxProjectRecord fields”

Sandbox project configuration written to Lakebase.

  • workspaceScope: Workspace identity that contains the machine.
  • userId: AppKit user identity that owns the project.
  • projectId: Stable project identifier.
  • name: Project name and directory slug.
  • machineId: Databricks Sandbox that hosts the project.
  • directory: User-owned project directory on the Sandbox.
  • projectPath: Project path relative to the Sandbox projects root.
  • path: AppKit route path for the project.
  • openPath (optional): Optional project-relative entry URL.
  • port: Sandbox-side loopback port.
  • config: JSON representation of the project’s mise configuration.
  • route (optional): Whether AppKit exposes this project’s loopback server.
  • serviceDependencies (optional): Built-in machine services required by this project.
  • stripPrefix: Whether AppKit strips the project route prefix.