prefect.server.api.deployments
Routes for interacting with Deployment objects.
count_deployments(flows=None, flow_runs=None, task_runs=None, deployments=None, work_pools=None, work_pool_queues=None, db=Depends(provide_database_interface))
async
Count deployments.
Source code in src/prefect/server/api/deployments.py
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
|
create_deployment(deployment, response, worker_lookups=Depends(WorkerLookups), created_by=Depends(dependencies.get_created_by), updated_by=Depends(dependencies.get_updated_by), db=Depends(provide_database_interface))
async
Gracefully creates a new deployment from the provided schema. If a deployment with the same name and flow_id already exists, the deployment is updated.
If the deployment has an active schedule, flow runs will be scheduled. When upserting, any scheduled runs from the existing deployment will be deleted.
Source code in src/prefect/server/api/deployments.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
create_flow_run_from_deployment(flow_run, deployment_id=Path(..., description='The deployment id', alias='id'), created_by=Depends(dependencies.get_created_by), db=Depends(provide_database_interface), worker_lookups=Depends(WorkerLookups), response=None)
async
Create a flow run from a deployment.
Any parameters not provided will be inferred from the deployment's parameters. If tags are not provided, the deployment's tags will be used.
If no state is provided, the flow run will be created in a SCHEDULED state.
Source code in src/prefect/server/api/deployments.py
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 |
|
delete_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), db=Depends(provide_database_interface))
async
Delete a deployment by id.
Source code in src/prefect/server/api/deployments.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 |
|
get_scheduled_flow_runs_for_deployments(background_tasks, deployment_ids=Body(default=..., description='The deployment IDs to get scheduled runs for'), scheduled_before=Body(None, description='The maximum time to look for scheduled flow runs'), limit=dependencies.LimitBody(), db=Depends(provide_database_interface))
async
Get scheduled runs for a set of deployments. Used by a runner to poll for work.
Source code in src/prefect/server/api/deployments.py
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
|
paginate_deployments(limit=dependencies.LimitBody(), page=Body(1, ge=1), flows=None, flow_runs=None, task_runs=None, deployments=None, work_pools=None, work_pool_queues=None, sort=Body(schemas.sorting.DeploymentSort.NAME_ASC), db=Depends(provide_database_interface))
async
Pagination query for flow runs.
Source code in src/prefect/server/api/deployments.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
|
pause_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), db=Depends(provide_database_interface))
async
Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled state will be deleted.
Source code in src/prefect/server/api/deployments.py
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 |
|
read_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), db=Depends(provide_database_interface))
async
Get a deployment by id.
Source code in src/prefect/server/api/deployments.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
|
read_deployment_by_name(flow_name=Path(..., description='The name of the flow'), deployment_name=Path(..., description='The name of the deployment'), db=Depends(provide_database_interface))
async
Get a deployment using the name of the flow and the deployment.
Source code in src/prefect/server/api/deployments.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
|
read_deployments(limit=dependencies.LimitBody(), offset=Body(0, ge=0), flows=None, flow_runs=None, task_runs=None, deployments=None, work_pools=None, work_pool_queues=None, sort=Body(schemas.sorting.DeploymentSort.NAME_ASC), db=Depends(provide_database_interface))
async
Query for deployments.
Source code in src/prefect/server/api/deployments.py
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
|
resume_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), db=Depends(provide_database_interface))
async
Set a deployment schedule to active. Runs will be scheduled immediately.
Source code in src/prefect/server/api/deployments.py
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 |
|
schedule_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), start_time=Body(None, description='The earliest date to schedule'), end_time=Body(None, description='The latest date to schedule'), min_time=Body(None, description='Runs will be scheduled until at least this long after the `start_time`', json_schema_extra={'format': 'time-delta'}), min_runs=Body(None, description='The minimum number of runs to schedule'), max_runs=Body(None, description='The maximum number of runs to schedule'), db=Depends(provide_database_interface))
async
Schedule runs for a deployment. For backfills, provide start/end times in the past.
This function will generate the minimum number of runs that satisfy the min and max times, and the min and max counts. Specifically, the following order will be respected.
- Runs will be generated starting on or after the `start_time`
- No more than `max_runs` runs will be generated
- No runs will be generated after `end_time` is reached
- At least `min_runs` runs will be generated
- Runs will be generated until at least `start_time + min_time` is reached
Source code in src/prefect/server/api/deployments.py
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
|
work_queue_check_for_deployment(deployment_id=Path(..., description='The deployment id', alias='id'), db=Depends(provide_database_interface))
async
Get list of work-queues that are able to pick up the specified deployment.
This endpoint is intended to be used by the UI to provide users warnings about deployments that are unable to be executed because there are no work queues that will pick up their runs, based on existing filter criteria. It may be deprecated in the future because there is not a strict relationship between work queues and deployments.
Source code in src/prefect/server/api/deployments.py
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 |
|