Skip to content
dbx tools

Variable: sshMachinesResponseSchema

const sshMachinesResponseSchema: ZodObject<{ auto: ZodBoolean; machines: ZodArray<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>>; supported: ZodBoolean; }, $strict>

sshMachinesResponse fields

Section titled “sshMachinesResponse fields”

SSH machine discovery response.

  • auto: Whether operations may automatically start and register SSH access.
  • supported: Whether the workspace exposes the Databricks Sandbox REST API.
  • machines: Existing machines; this response never creates one.