Skip to main content

list_snapshots()
Private Preview

Addedv3.0.x

This operation lists all snapshot names. Optionally filter by collection name to list snapshots belonging to a specific collection.

Request Syntax​

list_snapshots(
    collection_name: str = "",
    timeout: Optional[float] = None,
    **kwargs
) -> List[str]

PARAMETERS:

  • collection_name (str) - An optional collection name to filter snapshots. If empty, all snapshots are listed.

  • timeout (Optional[float]) - An optional duration of time in seconds to allow for the RPC.

RETURN TYPE:

List[str]

A list of snapshot names.

EXCEPTIONS:

  • MilvusException

    If the operation fails.

Examples​

from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# List all snapshots for a specific collection
snapshots = client.list_snapshots(collection_name="my_collection")
print(snapshots)
# ['backup_20260401', 'backup_20260418']

# List all snapshots across all collections
all_snapshots = client.list_snapshots()