Skip to main content
POST
Paginate Deployments

Headers

x-prefect-api-version
string

Body

application/json
page
integer
default:1
Required range: x >= 1
flows
FlowFilter · object | null

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

flow_runs
FlowRunFilter · object | null

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

task_runs
TaskRunFilter · object | null

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

deployments
DeploymentFilter · object | null

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

work_pools
WorkPoolFilter · object | null

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

work_pool_queues
WorkQueueFilter · object | null

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

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
count
integer
required
limit
integer
required
pages
integer
required
page
integer
required