Skip to content

Variable: sshMachineSchema

const sshMachineSchema: ZodObject<{ autoStopSeconds: ZodOptional<ZodNumber>; canConnect: ZodBoolean; canStart: ZodBoolean; canStop: ZodBoolean; createdAt: ZodOptional<ZodString>; expiresAt: ZodString; gatewayHost: ZodOptional<ZodString>; id: ZodString; lastStartedAt: ZodOptional<ZodString>; name: ZodString; projects: ZodArray<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>>; provider: ZodLiteral<"databricks-sandbox">; services: ZodArray<ZodObject<{ error: ZodOptional<ZodString>; kind: ZodEnum<{ desktop: "desktop"; stats: "stats"; terminal: "terminal"; }>; openUrl: ZodString; path: ZodString; state: ZodEnum<{ error: "error"; ready: "ready"; starting: "starting"; stopped: "stopped"; }>; }, $strict>>; status: ZodEnum<{ error: "error"; running: "running"; starting: "starting"; stopped: "stopped"; stopping: "stopping"; unknown: "unknown"; }>; }, $strict>

Public, secret-free summary of a Databricks Sandbox.

  • id: Databricks Sandbox identifier used as the SSH username.
  • name: Human-readable Sandbox name.
  • provider: Machine provider.
  • status: Normalized machine lifecycle state.
  • gatewayHost (optional): Databricks Sandbox SSH gateway hostname.
  • createdAt (optional): ISO-8601 machine creation time.
  • expiresAt: ISO-8601 service-managed expiration time.
  • lastStartedAt (optional): ISO-8601 last start time.
  • autoStopSeconds (optional): Configured idle timeout.
  • projects: Projects persisted for the machine.
  • services: Built-in terminal and health services for the machine.
  • canStart: Whether the machine can be started.
  • canStop: Whether the machine can be stopped.
  • canConnect: Whether enough SSH metadata is available to connect.