list_snapshots
Retrieve and filter frozen pipeline configurations in ZenML workspaces to identify runnable or deployable snapshots with pagination support.
Instructions
List all snapshots in the ZenML workspace.
Snapshots are frozen pipeline configurations that replace the deprecated
Run Templates. Use `runnable=True` to find snapshots that can be triggered.
Returns JSON including pagination metadata (items, total, page, size).
Args:
sort_by: The field to sort the snapshots by
page: The page number to return
size: The number of snapshots to return
logical_operator: The logical operator to use for combining filters
created: Filter by creation date
updated: Filter by last update date
name: Filter by snapshot name
pipeline: Filter by pipeline name or ID
runnable: Filter to only runnable snapshots (can be triggered)
deployable: Filter to only deployable snapshots
deployed: Filter to only currently deployed snapshots
tag: Filter by tag
project: Optional project scope (defaults to active project)
named_only: Only return named snapshots (default True to avoid internal ones)Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | desc:created | |
| page | No | ||
| size | No | ||
| logical_operator | No | and | |
| created | No | ||
| updated | No | ||
| name | No | ||
| pipeline | No | ||
| runnable | No | ||
| deployable | No | ||
| deployed | No | ||
| tag | No | ||
| project | No | ||
| named_only | No |