POST
/
api
/
deployments
/
paginate
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "version": "<string>",
      "description": "<string>",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paused": false,
      "schedules": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z",
          "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "schedule": {
            "interval": 123,
            "anchor_date": "2020-01-01T00:00:00Z",
            "timezone": "America/New_York"
          },
          "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",
        "active": true,
        "name": "<string>",
        "limit": 123,
        "active_slots": 123,
        "slot_decay_per_second": 2
      },
      "concurrency_options": {
        "collision_strategy": "ENQUEUE"
      },
      "job_variables": {},
      "parameters": {},
      "tags": [
        "tag-1",
        "tag-2"
      ],
      "labels": {
        "key": "value1",
        "key2": 42
      },
      "work_queue_name": "<string>",
      "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": "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
object | null

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

​
flow_runs
object | null

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

​
task_runs
object | null

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

​
deployments
object | null

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

​
work_pools
object | null

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

​
work_pool_queues
object | null

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

​
sort
enum<string>

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

200
application/json
Successful Response
​
results
object[]
required
​
count
integer
required
​
limit
integer
required
​
pages
integer
required
​
page
integer
required