Skip to main content

commands.sandbox_snapshots

Runtime Snapshot commands for Datalayer CLI.

snapshots_callback

@app.callback()
def snapshots_callback(ctx: typer.Context) -> None

Runtime snapshots management commands.

list_snapshots

@app.command(name="ls")
def list_snapshots(token: Optional[str] = typer.Option(
None,
"--api-key",
help="API key (Bearer token for API requests).",
)) -> None

List all snapshots.

create_snapshot

@app.command(name="create")
def create_snapshot(
pod_name: Optional[str] = typer.Option(
None,
"--pod-name",
help="Pod name of the runtime to snapshot",
),
name: Optional[str] = typer.Option(
None,
"--name",
help="Name for the snapshot",
),
description: Optional[str] = typer.Option(
None,
"--description",
help="Description for the snapshot",
),
stop: bool = typer.Option(
True,
"--stop/--no-stop",
help="Whether to stop the runtime after creating snapshot",
),
token: Optional[str] = typer.Option(
None,
"--api-key",
help="API key (Bearer token for API requests).",
)) -> None

Create a snapshot from a running runtime.

delete_snapshot

@app.command(name="delete")
def delete_snapshot(uid: str = typer.Argument(
..., help="UID of the snapshot to delete"),
token: Optional[str] = typer.Option(
None,
"--api-key",
help="API key (Bearer token for API requests).",
)) -> None

Delete a snapshot.

snapshots_list

def snapshots_list(token: Optional[str] = typer.Option(
None,
"--api-key",
help="API key (Bearer token for API requests).",
)) -> None

List all snapshots (root command).

snapshots_ls

def snapshots_ls(token: Optional[str] = typer.Option(
None,
"--api-key",
help="API key (Bearer token for API requests).",
)) -> None

List all snapshots (root command alias).