get_deployments
Retrieve and filter deployment lists from Prefect workflows using criteria like flow name, tags, schedule status, or work queue to manage and monitor automated processes.
Instructions
Get a list of deployments with optional filtering.
Args: limit: Maximum number of deployments to return offset: Number of deployments to skip flow_name: Filter by flow name name: Filter by deployment name tags: Filter by tags is_schedule_active: Filter by schedule active status work_queue_name: Filter by work queue name
Returns: A list of deployments with their details
Input Schema
Name | Required | Description | Default |
---|---|---|---|
flow_name | No | ||
is_schedule_active | No | ||
limit | No | ||
name | No | ||
offset | No | ||
tags | No | ||
work_queue_name | No |
Input Schema (JSON Schema)
{
"properties": {
"flow_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Flow Name"
},
"is_schedule_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Schedule Active"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Limit"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"offset": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Offset"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Work Queue Name"
}
},
"type": "object"
}