Skip to main content
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.

​
flow_runs
FlowRunFilter · object

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

​
task_runs
TaskRunFilter · object

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

​
deployments
DeploymentFilter · object

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

​
work_pools
WorkPoolFilter · object

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

​
work_pool_queues
WorkQueueFilter · object

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