Skip to content
dbx tools

Variable: sshProjectResponseSchema

const sshProjectResponseSchema: ZodObject<{ project: 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>; }, $strict>

sshProjectResponse fields

Section titled “sshProjectResponse fields”

Sandbox project response.

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