Skip to content
dbx tools

Variable: sshProjectSchema

const sshProjectSchema: ZodObject<{ directory: ZodString; error: ZodOptional<ZodString>; id: ZodString; machineId: ZodString; name: ZodString; openUrl: ZodOptional<ZodString>; path: ZodString; port: ZodNumber; state: ZodEnum<{ error: "error"; ready: "ready"; starting: "starting"; stopped: "stopped"; }>; stripPrefix: ZodBoolean; }, $strict>

sshProject fields

Section titled “sshProject fields”

One persisted Sandbox project and its AppKit route.

  • id: Stable identifier for the Sandbox project.
  • name: Project display name.
  • machineId: Machine that hosts the project.
  • directory: Project directory below the Sandbox user’s home.
  • path: AppKit path that exposes the project server.
  • openUrl (optional): AppKit URL opened by project links, including any configured entry page.
  • port: Loopback HTTP port reserved for the project.
  • stripPrefix: Whether the registered AppKit path is removed before forwarding.
  • state: Current project route state.
  • error (optional): Latest forwarding failure.