list_deployments
Retrieve and filter deployments in a ZenML workspace to monitor runtime status, serving pipelines, and provisioned resources with paginated results.
Instructions
List all deployments in the ZenML workspace.
Deployments show what's currently serving/provisioned with runtime status.
Returns JSON including pagination metadata (items, total, page, size).
Args:
sort_by: The field to sort the deployments by
page: The page number to return
size: The number of deployments 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 deployment name
status: Filter by deployment status (e.g., "running", "error")
url: Filter by deployment URL
pipeline: Filter by pipeline name or ID
snapshot_id: Filter by source snapshot ID
tag: Filter by tag
project: Optional project scope (defaults to active project)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 | ||
| status | No | ||
| url | No | ||
| pipeline | No | ||
| snapshot_id | No | ||
| tag | No | ||
| project | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |