Skip to content
View as Markdown

Lightweight data-plane handle for one node in a multi-node Sandbox.

Properties:

  • cpu number
  • disk number
  • fabricAddress? string
  • fabricHealthy? boolean
  • fabricPrefixLength? number
  • fabricUnhealthySince? string
  • failure? GangNodeFailure
  • fs FileSystem
  • gpu number
  • id string
  • incarnation number
  • memory number
  • process Process
  • rank number
  • state SandboxState
  • warnings string[] = [] - Advisory RDMA warnings for this node.
new SandboxNode(
node: import("@daytona/api-client").SandboxNode,
toolboxProxyUrl: string,
clientConfig: Configuration,
sandboxApi: SandboxApi,
language?: string,
requestTimeoutMs?: number
): SandboxNode;

Parameters:

  • node API SandboxNode DTO - Rank, ID, state and resources returned by the API.
  • toolboxProxyUrl string
  • clientConfig Configuration
  • sandboxApi SandboxApi
  • language? string
  • requestTimeoutMs? number

Returns:

  • SandboxNode

Throws:

If the node ID is empty, ”.” or ”..”.

createSshAccess(expiresInMinutes?: number): Promise<SshAccessDto>;

Create an SSH access token for this node.

Parameters:

  • expiresInMinutes? number

Returns:

  • Promise<SshAccessDto>
getPreviewLink(port: number): Promise<PortPreviewUrl>;

Get a preview URL for a port on this node.

Parameters:

  • port number

Returns:

  • Promise<PortPreviewUrl>
revokeSshAccess(token: string): Promise<void>;

Revoke an SSH access token for this node.

Parameters:

  • token string

Returns:

  • Promise<void>
update(node: import("@daytona/api-client").SandboxNode): void;

Refresh resources, state, incarnation, failure details and fabric metadata.

Parameters:

  • node API SandboxNode DTO - Node data from the API response, not an SDK node handle.

Returns:

  • void

Throws:

If the node rank or id differs from this handle.