Skip to main content
API reference for @coreweave/cwsandbox version 1.0.0. For installation and authentication, see the TypeScript client guide. Declarations, including parameter types, return types, overloads, and comments, come from the published package. An optional member has a ? suffix. Inherited members are defined on the linked parent type.

DeleteOptions

Published declaration.
Related types: RequestOptions.

DeleteSnapshotOptions

Published declaration.
Related types: RequestOptions.

EnvironmentVariables

Published declaration.

FileSystemSnapshotOptions

Published declaration.

FileSystemSnapshotResult

Published declaration.
Related types: FileSystemSnapshotState, FileSystemSnapshotTrigger.

FileSystemSnapshotState

Published declaration.

FileSystemSnapshotTrigger

Published declaration.

FromIdOptions

Published declaration.
Related types: DataPlaneOptions, RequestOptions.

GetSandboxResult

Published declaration.
Related types: SandboxMetadata, SandboxStatus.

ListSandboxesOptions

Published declaration.
Related types: RequestOptions, SandboxStatus, SandboxTag.

ListSandboxesResult

Published declaration.
Related types: SandboxInfo.

ListSnapshotsOptions

Published declaration.
Related types: FileSystemSnapshotState, RequestOptions.

ObjectStoragePermission

Published declaration.

Sandbox

Published declaration.
Related types: CommandInput, DeleteOptions, ExecOptions, FileSystemSnapshotResult, GetSandboxResult, HttpsEndpointStatus, ProcessResult, RequestOptions, SandboxCommands, SandboxExposedPort, SandboxFiles, SandboxId, SandboxLogs, SandboxResourceSpec, SandboxStatus, ServiceUrl, ShellOptions, StopOptions, TerminalSession, TlsPassthroughEndpointStatus, WaitOptions.

SandboxAnnotations

Published declaration.

SandboxExposedPort

Published declaration.
Related types: ServiceProtocol.

SandboxFileContents

Published declaration.

SandboxFileType

Published declaration.

SandboxId

Published declaration.

SandboxInfo

Published declaration.
Related types: SandboxMetadata, SandboxStatus.

SandboxListOptions

Published declaration.
Related types: DataPlaneOptions, ListSandboxesOptions.

SandboxMetadata

Published declaration.
Related types: HttpsEndpointStatus, SandboxExposedPort, SandboxId, SandboxResourceSpec, SandboxStatus, ServiceUrl, TlsPassthroughEndpointStatus.

SandboxObjectStorageAccess

Published declaration.
Related types: ObjectStoragePermission.

SandboxResourceSpec

Published declaration.
Related types: ResourceSpec.

SandboxRunFromFileOptions

Published declaration.
Related types: DataPlaneOptions, NetworkOptions, RequestOptions, ResourceOptions, SandboxAnnotations, SandboxFileType, SandboxObjectStorageAccess, SandboxTag, Seconds.

SandboxRunFromTemplateOptions

Published declaration.
Related types: CommandInput, DataPlaneOptions, EnvironmentVariables, FileSystemSnapshotOptions, MountedFiles, NetworkOptions, RequestOptions, ResourceOptions, SandboxAnnotations, SandboxTag, ScratchVolumeOptions, Seconds, Secrets, Service.

SandboxRunOptions

Published declaration.
Related types: DataPlaneOptions, EnvironmentVariables, FileSystemSnapshotOptions, MountedFiles, NetworkOptions, RequestOptions, ResourceOptions, SandboxAnnotations, SandboxObjectStorageAccess, SandboxTag, ScratchVolumeOptions, Seconds, Secrets, Service.

SandboxStatus

Published declaration.

SandboxTag

Published declaration.

ScratchVolumeOptions

Published declaration.

StartSandboxResult

Published declaration.
Related types: SandboxMetadata.

StopOptions

Published declaration.
Related types: RequestOptions, Seconds.

WaitOptions

Published declaration.
Related types: RequestOptions, WaitTargetStatus.

WaitTargetStatus

Published declaration.
Last modified on October 28, 2026