Paginate Deployments

curl --request POST \
  --url https://api.example.com/api/deployments/paginate \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "flows": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "deployment": {
      "operator": "and_",
      "is_null_": true
    },
    "name": {
      "any_": [
        "my-flow-1",
        "my-flow-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    }
  },
  "flow_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-flow-run-1",
        "my-flow-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "deployment_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "operator": "and_",
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [
          "SCHEDULED"
        ],
        "not_any_": [
          "SCHEDULED"
        ]
      },
      "name": {
        "any_": [
          "<string>"
        ],
        "not_any_": [
          "<string>"
        ]
      }
    },
    "flow_version": {
      "any_": [
        "<string>"
      ]
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "end_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "next_scheduled_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "parent_flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "parent_task_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "idempotency_key": {
      "any_": [
        "<string>"
      ],
      "not_any_": [
        "<string>"
      ]
    }
  },
  "task_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-task-run-1",
        "my-task-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [
          "SCHEDULED"
        ]
      },
      "name": {
        "any_": [
          "<string>"
        ]
      }
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "subflow_runs": {
      "exists_": true
    },
    "flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": false
    }
  },
  "deployments": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-deployment-1",
        "my-deployment-2"
      ],
      "like_": "marvin"
    },
    "flow_or_deployment_name": {
      "like_": "<string>"
    },
    "paused": {
      "eq_": true
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    },
    "concurrency_limit": {
      "ge_": 123,
      "le_": 123,
      "is_null_": true
    }
  },
  "work_pools": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "<string>"
      ]
    },
    "type": {
      "any_": [
        "<string>"
      ]
    }
  },
  "work_pool_queues": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "wq-1",
        "wq-2"
      ],
      "startswith_": [
        "marvin",
        "Marvin-robot"
      ]
    }
  },
  "sort": "NAME_ASC",
  "limit": 123
}
'

{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "<string>",
      "description": "<string>",
      "paused": false,
      "schedules": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z",
          "schedule": {
            "interval": 123,
            "anchor_date": "2023-11-07T05:31:56Z",
            "timezone": "America/New_York"
          },
          "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "active": true,
          "max_scheduled_runs": 1,
          "parameters": {},
          "slug": "<string>"
        }
      ],
      "concurrency_limit": 123,
      "global_concurrency_limit": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "limit": 123,
        "active_slots": 123,
        "active": true,
        "slot_decay_per_second": 2
      },
      "concurrency_options": {
        "collision_strategy": "ENQUEUE",
        "grace_period_seconds": 43230
      },
      "job_variables": {},
      "parameters": {},
      "tags": [
        "<string>"
      ],
      "labels": {},
      "work_queue_name": "<string>",
      "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_polled": "2023-11-07T05:31:56Z",
      "parameter_openapi_schema": {},
      "path": "<string>",
      "pull_steps": [
        {}
      ],
      "entrypoint": "<string>",
      "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "display_value": "<string>"
      },
      "updated_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "display_value": "<string>"
      },
      "work_pool_name": "<string>",
      "status": "NOT_READY",
      "enforce_parameter_schema": true
    }
  ],
  "count": 123,
  "limit": 123,
  "pages": 123,
  "page": 123
}

POST

api

deployments

paginate

Paginate Deployments

curl --request POST \
  --url https://api.example.com/api/deployments/paginate \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "flows": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "deployment": {
      "operator": "and_",
      "is_null_": true
    },
    "name": {
      "any_": [
        "my-flow-1",
        "my-flow-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    }
  },
  "flow_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-flow-run-1",
        "my-flow-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "deployment_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "operator": "and_",
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [
          "SCHEDULED"
        ],
        "not_any_": [
          "SCHEDULED"
        ]
      },
      "name": {
        "any_": [
          "<string>"
        ],
        "not_any_": [
          "<string>"
        ]
      }
    },
    "flow_version": {
      "any_": [
        "<string>"
      ]
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "end_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "next_scheduled_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "parent_flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "parent_task_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "idempotency_key": {
      "any_": [
        "<string>"
      ],
      "not_any_": [
        "<string>"
      ]
    }
  },
  "task_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-task-run-1",
        "my-task-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [
          "SCHEDULED"
        ]
      },
      "name": {
        "any_": [
          "<string>"
        ]
      }
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "subflow_runs": {
      "exists_": true
    },
    "flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": false
    }
  },
  "deployments": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-deployment-1",
        "my-deployment-2"
      ],
      "like_": "marvin"
    },
    "flow_or_deployment_name": {
      "like_": "<string>"
    },
    "paused": {
      "eq_": true
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    },
    "concurrency_limit": {
      "ge_": 123,
      "le_": 123,
      "is_null_": true
    }
  },
  "work_pools": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "<string>"
      ]
    },
    "type": {
      "any_": [
        "<string>"
      ]
    }
  },
  "work_pool_queues": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "wq-1",
        "wq-2"
      ],
      "startswith_": [
        "marvin",
        "Marvin-robot"
      ]
    }
  },
  "sort": "NAME_ASC",
  "limit": 123
}
'

{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "<string>",
      "description": "<string>",
      "paused": false,
      "schedules": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z",
          "schedule": {
            "interval": 123,
            "anchor_date": "2023-11-07T05:31:56Z",
            "timezone": "America/New_York"
          },
          "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "active": true,
          "max_scheduled_runs": 1,
          "parameters": {},
          "slug": "<string>"
        }
      ],
      "concurrency_limit": 123,
      "global_concurrency_limit": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "limit": 123,
        "active_slots": 123,
        "active": true,
        "slot_decay_per_second": 2
      },
      "concurrency_options": {
        "collision_strategy": "ENQUEUE",
        "grace_period_seconds": 43230
      },
      "job_variables": {},
      "parameters": {},
      "tags": [
        "<string>"
      ],
      "labels": {},
      "work_queue_name": "<string>",
      "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_polled": "2023-11-07T05:31:56Z",
      "parameter_openapi_schema": {},
      "path": "<string>",
      "pull_steps": [
        {}
      ],
      "entrypoint": "<string>",
      "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "display_value": "<string>"
      },
      "updated_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "display_value": "<string>"
      },
      "work_pool_name": "<string>",
      "status": "NOT_READY",
      "enforce_parameter_schema": true
    }
  ],
  "count": 123,
  "limit": 123,
  "pages": 123,
  "page": 123
}

Headers

x-prefect-api-version

string

Body

application/json

page

integer

default:1

Required range: x >= 1

flows

FlowFilter · object

Filter for flows. Only flows matching all criteria will be returned.

Show child attributes

flows.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.id

FlowFilterId · object

Filter criteria for Flow.id

Show child attributes

flows.id.any_

string<uuid>[] | null

A list of flow ids to include

flows.deployment

FlowFilterDeployment · object

Filter criteria for Flow deployments

Show child attributes

flows.deployment.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.deployment.is_null_

boolean | null

If true, only include flows without deployments

flows.name

FlowFilterName · object

Filter criteria for Flow.name

Show child attributes

flows.name.any_

string[] | null

A list of flow names to include

Example:

["my-flow-1", "my-flow-2"]

flows.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

Example:

"marvin"

flows.tags

FlowFilterTags · object

Filter criteria for Flow.tags

Show child attributes

flows.tags.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.tags.all_

string[] | null

A list of tags. Flows will be returned only if their tags are a superset of the list

Example:

["tag-1", "tag-2"]

flows.tags.is_null_

boolean | null

If true, only include flows without tags

flow_runs

FlowRunFilter · object

Filter flow runs. Only flow runs matching all criteria will be returned

Show child attributes

flow_runs.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.id

FlowRunFilterId · object

Filter criteria for FlowRun.id

Show child attributes

flow_runs.id.any_

string<uuid>[] | null

A list of flow run ids to include

flow_runs.id.not_any_

string<uuid>[] | null

A list of flow run ids to exclude

flow_runs.name

FlowRunFilterName · object

Filter criteria for FlowRun.name

Show child attributes

flow_runs.name.any_

string[] | null

A list of flow run names to include

Example:

["my-flow-run-1", "my-flow-run-2"]

flow_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

Example:

"marvin"

flow_runs.tags

FlowRunFilterTags · object

Filter criteria for FlowRun.tags

Show child attributes

flow_runs.tags.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.tags.all_

string[] | null

A list of tags. Flow runs will be returned only if their tags are a superset of the list

Example:

["tag-1", "tag-2"]

flow_runs.tags.any_

string[] | null

A list of tags to include

Example:

["tag-1", "tag-2"]

flow_runs.tags.is_null_

boolean | null

If true, only include flow runs without tags

flow_runs.deployment_id

FlowRunFilterDeploymentId · object

Filter criteria for FlowRun.deployment_id

Show child attributes

flow_runs.deployment_id.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.deployment_id.any_

string<uuid>[] | null

A list of flow run deployment ids to include

flow_runs.deployment_id.is_null_

boolean | null

If true, only include flow runs without deployment ids

flow_runs.work_queue_name

FlowRunFilterWorkQueueName · object

Filter criteria for `FlowRun.work_queue_name

Show child attributes

flow_runs.work_queue_name.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.work_queue_name.any_

string[] | null

A list of work queue names to include

Example:

["work_queue_1", "work_queue_2"]

flow_runs.work_queue_name.is_null_

boolean | null

If true, only include flow runs without work queue names

flow_runs.state

FlowRunFilterState · object

Filter criteria for FlowRun.state

Show child attributes

flow_runs.state.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.state.type

FlowRunFilterStateType · object

Filter criteria for FlowRun.state_type

Show child attributes

flow_runs.state.type.any_

enum<string>[] | null

A list of flow run state types to include

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.state.type.not_any_

enum<string>[] | null

A list of flow run state types to exclude

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.state.name

FlowRunFilterStateName · object

Filter criteria for FlowRun.state_name

Show child attributes

flow_runs.state.name.any_

string[] | null

A list of flow run state names to include

flow_runs.state.name.not_any_

string[] | null

A list of flow run state names to exclude

flow_runs.flow_version

FlowRunFilterFlowVersion · object

Filter criteria for FlowRun.flow_version

Show child attributes

flow_runs.flow_version.any_

string[] | null

A list of flow run flow_versions to include

flow_runs.start_time

FlowRunFilterStartTime · object

Filter criteria for FlowRun.start_time

Show child attributes

flow_runs.start_time.before_

string<date-time> | null

Only include flow runs starting at or before this time

flow_runs.start_time.after_

string<date-time> | null

Only include flow runs starting at or after this time

flow_runs.start_time.is_null_

boolean | null

If true, only return flow runs without a start time

flow_runs.end_time

FlowRunFilterEndTime · object

Filter criteria for FlowRun.end_time

Show child attributes

flow_runs.end_time.before_

string<date-time> | null

Only include flow runs ending at or before this time

flow_runs.end_time.after_

string<date-time> | null

Only include flow runs ending at or after this time

flow_runs.end_time.is_null_

boolean | null

If true, only return flow runs without an end time

flow_runs.expected_start_time

FlowRunFilterExpectedStartTime · object

Filter criteria for FlowRun.expected_start_time

Show child attributes

flow_runs.expected_start_time.before_

string<date-time> | null

Only include flow runs scheduled to start at or before this time

flow_runs.expected_start_time.after_

string<date-time> | null

Only include flow runs scheduled to start at or after this time

flow_runs.next_scheduled_start_time

FlowRunFilterNextScheduledStartTime · object

Filter criteria for FlowRun.next_scheduled_start_time

Show child attributes

flow_runs.next_scheduled_start_time.before_

string<date-time> | null

Only include flow runs with a next_scheduled_start_time or before this time

flow_runs.next_scheduled_start_time.after_

string<date-time> | null

Only include flow runs with a next_scheduled_start_time at or after this time

flow_runs.parent_flow_run_id

FlowRunFilterParentFlowRunId · object

Filter criteria for subflows of the given flow runs

Show child attributes

flow_runs.parent_flow_run_id.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_flow_run_id.any_

string<uuid>[] | null

A list of parent flow run ids to include

flow_runs.parent_task_run_id

FlowRunFilterParentTaskRunId · object

Filter criteria for FlowRun.parent_task_run_id

Show child attributes

flow_runs.parent_task_run_id.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_task_run_id.any_

string<uuid>[] | null

A list of flow run parent_task_run_ids to include

flow_runs.parent_task_run_id.is_null_

boolean | null

If true, only include flow runs without parent_task_run_id

flow_runs.idempotency_key

FlowRunFilterIdempotencyKey · object

Filter criteria for FlowRun.idempotency_key

Show child attributes

flow_runs.idempotency_key.any_

string[] | null

A list of flow run idempotency keys to include

flow_runs.idempotency_key.not_any_

string[] | null

A list of flow run idempotency keys to exclude

task_runs

TaskRunFilter · object

Filter task runs. Only task runs matching all criteria will be returned

Show child attributes

task_runs.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.id

TaskRunFilterId · object

Filter criteria for TaskRun.id

Show child attributes

task_runs.id.any_

string<uuid>[] | null

A list of task run ids to include

task_runs.name

TaskRunFilterName · object

Filter criteria for TaskRun.name

Show child attributes

task_runs.name.any_

string[] | null

A list of task run names to include

Example:

["my-task-run-1", "my-task-run-2"]

task_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

Example:

"marvin"

task_runs.tags

TaskRunFilterTags · object

Filter criteria for TaskRun.tags

Show child attributes

task_runs.tags.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.tags.all_

string[] | null

A list of tags. Task runs will be returned only if their tags are a superset of the list

Example:

["tag-1", "tag-2"]

task_runs.tags.is_null_

boolean | null

If true, only include task runs without tags

task_runs.state

TaskRunFilterState · object

Filter criteria for TaskRun.state

Show child attributes

task_runs.state.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.state.type

TaskRunFilterStateType · object

Filter criteria for TaskRun.state_type

Show child attributes

task_runs.state.type.any_

enum<string>[] | null

A list of task run state types to include

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

task_runs.state.name

TaskRunFilterStateName · object

Filter criteria for TaskRun.state_name

Show child attributes

task_runs.state.name.any_

string[] | null

A list of task run state names to include

task_runs.start_time

TaskRunFilterStartTime · object

Filter criteria for TaskRun.start_time

Show child attributes

task_runs.start_time.before_

string<date-time> | null

Only include task runs starting at or before this time

task_runs.start_time.after_

string<date-time> | null

Only include task runs starting at or after this time

task_runs.start_time.is_null_

boolean | null

If true, only return task runs without a start time

task_runs.expected_start_time

TaskRunFilterExpectedStartTime · object

Filter criteria for TaskRun.expected_start_time

Show child attributes

task_runs.expected_start_time.before_

string<date-time> | null

Only include task runs expected to start at or before this time

task_runs.expected_start_time.after_

string<date-time> | null

Only include task runs expected to start at or after this time

task_runs.subflow_runs

TaskRunFilterSubFlowRuns · object

Filter criteria for TaskRun.subflow_run

Show child attributes

task_runs.subflow_runs.exists_

boolean | null

If true, only include task runs that are subflow run parents; if false, exclude parent task runs

task_runs.flow_run_id

TaskRunFilterFlowRunId · object

Filter criteria for TaskRun.flow_run_id

Show child attributes

task_runs.flow_run_id.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.flow_run_id.any_

string<uuid>[] | null

A list of task run flow run ids to include

task_runs.flow_run_id.is_null_

boolean | null

default:false

Filter for task runs with None as their flow run id

deployments

DeploymentFilter · object

Filter for deployments. Only deployments matching all criteria will be returned.

Show child attributes

deployments.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.id

DeploymentFilterId · object

Filter criteria for Deployment.id

Show child attributes

deployments.id.any_

string<uuid>[] | null

A list of deployment ids to include

deployments.id.not_any_

string<uuid>[] | null

A list of deployment ids to exclude

deployments.name

DeploymentFilterName · object

Filter criteria for Deployment.name

Show child attributes

deployments.name.any_

string[] | null

A list of deployment names to include

Example:

["my-deployment-1", "my-deployment-2"]

deployments.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

Example:

"marvin"

deployments.flow_or_deployment_name

DeploymentOrFlowNameFilter · object

Filter criteria for Deployment.name or Flow.name

Show child attributes

deployments.flow_or_deployment_name.like_

string | null

A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.

deployments.paused

DeploymentFilterPaused · object

Filter criteria for Deployment.paused

Show child attributes

deployments.paused.eq_

boolean | null

Only returns where deployment is/is not paused

deployments.tags

DeploymentFilterTags · object

Filter criteria for Deployment.tags

Show child attributes

deployments.tags.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.tags.all_

string[] | null

A list of tags. Deployments will be returned only if their tags are a superset of the list

Example:

["tag-1", "tag-2"]

deployments.tags.any_

string[] | null

A list of tags to include

Example:

["tag-1", "tag-2"]

deployments.tags.is_null_

boolean | null

If true, only include deployments without tags

deployments.work_queue_name

DeploymentFilterWorkQueueName · object

Filter criteria for Deployment.work_queue_name

Show child attributes

deployments.work_queue_name.any_

string[] | null

A list of work queue names to include

Example:

["work_queue_1", "work_queue_2"]

deployments.concurrency_limit

DeploymentFilterConcurrencyLimit · object

deprecated

DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.

Show child attributes

deployments.concurrency_limit.ge_

integer | null

Only include deployments with a concurrency limit greater than or equal to this value

deployments.concurrency_limit.le_

integer | null

Only include deployments with a concurrency limit less than or equal to this value

deployments.concurrency_limit.is_null_

boolean | null

If true, only include deployments without a concurrency limit

work_pools

WorkPoolFilter · object

Filter work pools. Only work pools matching all criteria will be returned

Show child attributes

work_pools.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

work_pools.id

WorkPoolFilterId · object

Filter criteria for WorkPool.id

Show child attributes

work_pools.id.any_

string<uuid>[] | null

A list of work pool ids to include

work_pools.name

WorkPoolFilterName · object

Filter criteria for WorkPool.name

Show child attributes

work_pools.name.any_

string[] | null

A list of work pool names to include

work_pools.type

WorkPoolFilterType · object

Filter criteria for WorkPool.type

Show child attributes

work_pools.type.any_

string[] | null

A list of work pool types to include

work_pool_queues

WorkQueueFilter · object

Filter work queues. Only work queues matching all criteria will be returned

Show child attributes

work_pool_queues.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

work_pool_queues.id

WorkQueueFilterId · object

Filter criteria for WorkQueue.id

Show child attributes

work_pool_queues.id.any_

string<uuid>[] | null

A list of work queue ids to include

work_pool_queues.name

WorkQueueFilterName · object

Filter criteria for WorkQueue.name

Show child attributes

work_pool_queues.name.any_

string[] | null

A list of work queue names to include

Example:

["wq-1", "wq-2"]

work_pool_queues.name.startswith_

string[] | null

A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.

Example:

["marvin", "Marvin-robot"]

sort

enum<string>

default:NAME_ASC

Defines deployment sorting options.

Available options:

CREATED_DESC,

UPDATED_DESC,

NAME_ASC,

NAME_DESC

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

results

DeploymentResponse · object[]

required

Show child attributes

results.id

string<uuid>

required

results.created

string<date-time> | null

required

results.updated

string<date-time> | null

required

results.name

string

required

The name of the deployment.

results.flow_id

string<uuid>

required

The flow id associated with the deployment.

results.version

string | null

An optional version for the deployment.

results.description

string | null

A description for the deployment.

results.paused

boolean

default:false

Whether or not the deployment is paused.

results.schedules

DeploymentSchedule · object[]

A list of schedules for the deployment.

Show child attributes

results.schedules.id

string<uuid>

required

results.schedules.created

string<date-time> | null

required

results.schedules.updated

string<date-time> | null

required

results.schedules.schedule

IntervalSchedule · object

required

The schedule for the deployment.

IntervalSchedule
CronSchedule
RRuleSchedule

Show child attributes

results.schedules.schedule.interval

number

required

results.schedules.schedule.anchor_date

string<date-time>

results.schedules.schedule.timezone

string | null

Example:

"America/New_York"

results.schedules.deployment_id

string<uuid> | null

The deployment id associated with this schedule.

results.schedules.active

boolean

default:true

Whether or not the schedule is active.

results.schedules.max_scheduled_runs

integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

results.schedules.parameters

Parameters · object

A dictionary of parameter value overrides.

results.schedules.slug

string | null

A unique slug for the schedule.

results.concurrency_limit

integer | null

deprecated

DEPRECATED: Prefer global_concurrency_limit. Will always be None for backwards compatibility. Will be removed after December 2024.

results.global_concurrency_limit

GlobalConcurrencyLimitResponse · object

The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once.

Show child attributes

results.global_concurrency_limit.id

string<uuid>

required

results.global_concurrency_limit.created

string<date-time> | null

required

results.global_concurrency_limit.updated

string<date-time> | null

required

results.global_concurrency_limit.name

string

required

The name of the global concurrency limit.

results.global_concurrency_limit.limit

integer

required

The concurrency limit.

results.global_concurrency_limit.active_slots

integer

required

The number of active slots.

results.global_concurrency_limit.active

boolean

default:true

Whether the global concurrency limit is active.

results.global_concurrency_limit.slot_decay_per_second

number

default:2

The decay rate for active slots when used as a rate limit.

results.concurrency_options

ConcurrencyOptions · object

The concurrency options for the deployment.

Show child attributes

results.concurrency_options.collision_strategy

enum<string>

required

Enumeration of concurrency collision strategies.

Available options:

ENQUEUE,

CANCEL_NEW

results.concurrency_options.grace_period_seconds

integer | null

Grace period in seconds for infrastructure to start before concurrency slots are revoked. If not set, falls back to server setting.

Required range: 60 <= x <= 86400

results.job_variables

Job Variables · object

Overrides to apply to the base infrastructure block at runtime.

results.parameters

Parameters · object

Parameters for flow runs scheduled by the deployment.

results.tags

string[]

A list of tags for the deployment

results.labels

Labels · object

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

Show child attributes

results.labels.{key}

results.work_queue_name

string | null

The work queue for the deployment. If no work queue is set, work will not be scheduled.

results.work_queue_id

string<uuid> | null

The id of the work pool queue to which this deployment is assigned.

results.last_polled

string<date-time> | null

The last time the deployment was polled for status updates.

results.parameter_openapi_schema

Parameter Openapi Schema · object

The parameter schema of the flow, including defaults.

results.path

string | null

The path to the working directory for the workflow, relative to remote storage or an absolute path.

results.pull_steps

Pull Steps · object[] | null

Pull steps for cloning and running this deployment.

results.entrypoint

string | null

The path to the entrypoint for the workflow, relative to the path.

results.storage_document_id

string<uuid> | null

The block document defining storage used for this flow.

results.infrastructure_document_id

string<uuid> | null

The block document defining infrastructure to use for flow runs.

results.created_by

CreatedBy · object

Optional information about the creator of this deployment.

Show child attributes

results.created_by.id

string<uuid> | null

The id of the creator of the object.

results.created_by.type

string | null

The type of the creator of the object.

results.created_by.display_value

string | null

The display value for the creator.

results.updated_by

UpdatedBy · object

Optional information about the updater of this deployment.

Show child attributes

results.updated_by.id

string<uuid> | null

The id of the updater of the object.

results.updated_by.type

string | null

The type of the updater of the object.

results.updated_by.display_value

string | null

The display value for the updater.

results.work_pool_name

string | null

The name of the deployment's work pool.

results.status

enum<string> | null

default:NOT_READY

Whether the deployment is ready to run flows.

Available options:

READY,

NOT_READY

results.enforce_parameter_schema

boolean

default:true

Whether or not the deployment should enforce the parameter schema.

count

integer

required

limit

integer

required

pages

integer

required

page

integer

required

Read Deployments Get Scheduled Flow Runs For Deployments

⌘I

API Reference

Headers

Body

Response