bunnyshell.com/sdk@v0.16.0/api/openapi.yaml (about) 1 openapi: 3.0.3 2 info: 3 contact: 4 email: osi+support@bunnyshell.com 5 name: API Support 6 url: https://www.bunnyshell.com/ 7 description: Interact with Bunnyshell Platform 8 termsOfService: https://www.bunnyshell.com/bunnyshell-customer-agreement/ 9 title: API Bunnyshell Environments 10 version: 1.1.0 11 servers: 12 - description: "" 13 url: https://api.environments.bunnyshell.com 14 security: 15 - ApiKeyAuth: [] 16 - JWT: [] 17 tags: 18 - description: Component Resource 19 name: component 20 - description: ComponentEndpoint Resource 21 name: componentEndpoint 22 - description: ComponentGit Resource 23 name: componentGit 24 - description: Environment_variable Resource 25 name: environment_variable 26 - description: Environment Resource 27 name: environment 28 - description: Event Resource 29 name: event 30 - description: Kubernetes_integration Resource 31 name: kubernetes_integration 32 - description: Organization Resource 33 name: organization 34 - description: Pipeline Resource 35 name: pipeline 36 - description: Project_variable Resource 37 name: project_variable 38 - description: Project Resource 39 name: project 40 - description: Registry_integration Resource 41 name: registry_integration 42 - description: Secret Resource 43 name: secret 44 - description: Service_component_variable Resource 45 name: service_component_variable 46 - description: Template Resource 47 name: template 48 - description: Templates_repository Resource 49 name: templates_repository 50 - description: Workflow Resource 51 name: workflow 52 paths: 53 /v1/components: 54 get: 55 deprecated: false 56 description: List service components matching any selected filters 57 operationId: ComponentList 58 parameters: 59 - allowEmptyValue: true 60 allowReserved: false 61 deprecated: false 62 description: The collection page number 63 explode: false 64 in: query 65 name: page 66 required: false 67 schema: 68 default: 1 69 type: integer 70 style: form 71 - allowEmptyValue: false 72 allowReserved: false 73 deprecated: false 74 description: Filter by name 75 explode: false 76 in: query 77 name: name 78 required: false 79 schema: 80 type: string 81 style: form 82 - allowEmptyValue: false 83 allowReserved: false 84 deprecated: false 85 description: Filter by environment 86 explode: false 87 in: query 88 name: environment 89 required: false 90 schema: 91 type: string 92 style: form 93 - allowEmptyValue: false 94 allowReserved: false 95 deprecated: false 96 description: Filter by operationStatus 97 example: draft 98 explode: false 99 in: query 100 name: operationStatus 101 required: false 102 schema: 103 enum: 104 - draft 105 - queued 106 - building 107 - building_failed 108 - built 109 - deploying 110 - deployed 111 - deployment_failed 112 - updating 113 - updating_failed 114 - stopping 115 - stopping_failed 116 - stopped 117 - restarting 118 - restarting_failed 119 - running 120 - deleting 121 - deleting_failed 122 - deleted 123 - starting 124 - starting_failed 125 - aborted 126 - aborting 127 type: string 128 style: form 129 - allowEmptyValue: false 130 allowReserved: false 131 deprecated: false 132 description: Filter by clusterStatus 133 example: not_available 134 explode: false 135 in: query 136 name: clusterStatus 137 required: false 138 schema: 139 enum: 140 - not_available 141 - err 142 - scheduling 143 - waiting 144 - err_starting 145 - crashing 146 - running_ok 147 - exited 148 - completed 149 - replica_scheduling 150 - replica_waiting 151 - replica_running_ok 152 - replica_ko 153 - replica_completed 154 - replica_issues_scheduling 155 - replica_issues_waiting 156 - replica_issues_running 157 - replica_issues_count 158 type: string 159 style: form 160 - allowEmptyValue: false 161 allowReserved: false 162 deprecated: false 163 description: Filter by organization 164 explode: false 165 in: query 166 name: organization 167 required: false 168 schema: 169 type: string 170 style: form 171 - allowEmptyValue: false 172 allowReserved: false 173 deprecated: false 174 description: Filter by project 175 explode: false 176 in: query 177 name: project 178 required: false 179 schema: 180 type: string 181 style: form 182 responses: 183 "200": 184 content: 185 application/hal+json: 186 schema: 187 $ref: '#/components/schemas/paginated-component-collection' 188 description: component collection 189 "4XX": 190 content: 191 application/problem+json: 192 schema: 193 $ref: '#/components/schemas/problem.generic' 194 description: Request Error 195 summary: List service components matching any selected filters 196 tags: 197 - component 198 /v1/components/endpoint: 199 get: 200 deprecated: false 201 description: List endpoints for service components matching any selected filters 202 operationId: ComponentEndpointList 203 parameters: 204 - allowEmptyValue: true 205 allowReserved: false 206 deprecated: false 207 description: The collection page number 208 explode: false 209 in: query 210 name: page 211 required: false 212 schema: 213 default: 1 214 type: integer 215 style: form 216 - allowEmptyValue: false 217 allowReserved: false 218 deprecated: false 219 description: Filter by organization 220 explode: false 221 in: query 222 name: organization 223 required: false 224 schema: 225 type: string 226 style: form 227 - allowEmptyValue: false 228 allowReserved: false 229 deprecated: false 230 description: Filter by project 231 explode: false 232 in: query 233 name: project 234 required: false 235 schema: 236 type: string 237 style: form 238 - allowEmptyValue: false 239 allowReserved: false 240 deprecated: false 241 description: Filter by environment 242 explode: false 243 in: query 244 name: environment 245 required: false 246 schema: 247 type: string 248 style: form 249 - allowEmptyValue: false 250 allowReserved: false 251 deprecated: false 252 description: Filter by name 253 explode: false 254 in: query 255 name: name 256 required: false 257 schema: 258 type: string 259 style: form 260 responses: 261 "200": 262 content: 263 application/hal+json: 264 schema: 265 $ref: '#/components/schemas/paginated-componentEndpoint-collection' 266 description: componentEndpoint collection 267 "4XX": 268 content: 269 application/problem+json: 270 schema: 271 $ref: '#/components/schemas/problem.generic' 272 description: Request Error 273 summary: List endpoints for service components matching any selected filters 274 tags: 275 - componentEndpoint 276 /v1/components/gitinfo: 277 get: 278 deprecated: false 279 description: List git info for service components matching any selected filters 280 operationId: ComponentGitList 281 parameters: 282 - allowEmptyValue: true 283 allowReserved: false 284 deprecated: false 285 description: The collection page number 286 explode: false 287 in: query 288 name: page 289 required: false 290 schema: 291 default: 1 292 type: integer 293 style: form 294 - allowEmptyValue: false 295 allowReserved: false 296 deprecated: false 297 description: Filter by organization 298 explode: false 299 in: query 300 name: organization 301 required: false 302 schema: 303 type: string 304 style: form 305 - allowEmptyValue: false 306 allowReserved: false 307 deprecated: false 308 description: Filter by project 309 explode: false 310 in: query 311 name: project 312 required: false 313 schema: 314 type: string 315 style: form 316 - allowEmptyValue: false 317 allowReserved: false 318 deprecated: false 319 description: Filter by environment 320 explode: false 321 in: query 322 name: environment 323 required: false 324 schema: 325 type: string 326 style: form 327 - allowEmptyValue: false 328 allowReserved: false 329 deprecated: false 330 description: Filter by name 331 explode: false 332 in: query 333 name: name 334 required: false 335 schema: 336 type: string 337 style: form 338 - allowEmptyValue: false 339 allowReserved: false 340 deprecated: false 341 description: Filter by repository 342 explode: false 343 in: query 344 name: repository 345 required: false 346 schema: 347 type: string 348 style: form 349 - allowEmptyValue: false 350 allowReserved: false 351 deprecated: false 352 description: Filter by branch 353 explode: false 354 in: query 355 name: branch 356 required: false 357 schema: 358 type: string 359 style: form 360 responses: 361 "200": 362 content: 363 application/hal+json: 364 schema: 365 $ref: '#/components/schemas/paginated-componentGit-collection' 366 description: componentGit collection 367 "4XX": 368 content: 369 application/problem+json: 370 schema: 371 $ref: '#/components/schemas/problem.generic' 372 description: Request Error 373 summary: List git info for service components matching any selected filters 374 tags: 375 - componentGit 376 /v1/components/{id}: 377 get: 378 deprecated: false 379 description: View a specific service component 380 operationId: ComponentView 381 parameters: 382 - allowReserved: false 383 deprecated: false 384 description: Resource identifier 385 explode: false 386 in: path 387 name: id 388 required: true 389 schema: 390 type: string 391 style: simple 392 responses: 393 "200": 394 content: 395 application/hal+json: 396 schema: 397 $ref: '#/components/schemas/component-item' 398 description: component resource 399 "404": 400 description: Resource not found 401 "4XX": 402 content: 403 application/problem+json: 404 schema: 405 $ref: '#/components/schemas/problem.generic' 406 description: Request Error 407 summary: View a specific service component 408 tags: 409 - component 410 /v1/components/{id}/endpoint: 411 get: 412 deprecated: false 413 description: View endpoints for a specific service component 414 operationId: ComponentEndpointView 415 parameters: 416 - allowReserved: false 417 deprecated: false 418 description: Resource identifier 419 explode: false 420 in: path 421 name: id 422 required: true 423 schema: 424 type: string 425 style: simple 426 responses: 427 "200": 428 content: 429 application/hal+json: 430 schema: 431 $ref: '#/components/schemas/componentEndpoint-item' 432 description: componentEndpoint resource 433 "404": 434 description: Resource not found 435 "4XX": 436 content: 437 application/problem+json: 438 schema: 439 $ref: '#/components/schemas/problem.generic' 440 description: Request Error 441 summary: View endpoints for a specific service component 442 tags: 443 - componentEndpoint 444 /v1/components/{id}/gitinfo: 445 get: 446 deprecated: false 447 description: View git info for a specific service component 448 operationId: ComponentGitView 449 parameters: 450 - allowReserved: false 451 deprecated: false 452 description: Resource identifier 453 explode: false 454 in: path 455 name: id 456 required: true 457 schema: 458 type: string 459 style: simple 460 responses: 461 "200": 462 content: 463 application/hal+json: 464 schema: 465 $ref: '#/components/schemas/componentGit-item' 466 description: componentGit resource 467 "404": 468 description: Resource not found 469 "4XX": 470 content: 471 application/problem+json: 472 schema: 473 $ref: '#/components/schemas/problem.generic' 474 description: Request Error 475 summary: View git info for a specific service component 476 tags: 477 - componentGit 478 /v1/components/{id}/remotedev/config: 479 get: 480 deprecated: false 481 description: Get remote dev config 482 operationId: ComponentRemote_dev_config 483 parameters: 484 - allowReserved: false 485 deprecated: false 486 description: Resource identifier 487 explode: false 488 in: path 489 name: id 490 required: true 491 schema: 492 type: string 493 style: simple 494 responses: 495 "200": 496 content: 497 application/json: 498 schema: 499 $ref: '#/components/schemas/component.Config-item' 500 description: component resource 501 "404": 502 description: Resource not found 503 "4XX": 504 content: 505 application/problem+json: 506 schema: 507 $ref: '#/components/schemas/problem.generic' 508 description: Request Error 509 summary: Get remote dev config 510 tags: 511 - component 512 /v1/components/{id}/remotedev/profile: 513 post: 514 deprecated: false 515 description: "Parse, validate and interpolate the provided remoteDevProfile" 516 operationId: ComponentRemote_dev_profile 517 parameters: 518 - allowReserved: false 519 deprecated: false 520 description: Resource identifier 521 explode: false 522 in: path 523 name: id 524 required: true 525 schema: 526 type: string 527 style: simple 528 requestBody: 529 content: 530 application/x+yaml: 531 schema: {} 532 description: No Request Body 533 required: false 534 responses: 535 "200": 536 content: 537 application/json: 538 schema: 539 $ref: '#/components/schemas/component.Profile-item' 540 description: component resource created 541 "400": 542 description: Invalid input 543 "422": 544 description: Unprocessable entity 545 "404": 546 description: Resource not found 547 "4XX": 548 content: 549 application/problem+json: 550 schema: 551 $ref: '#/components/schemas/problem.generic' 552 description: Request Error 553 summary: "Parse, validate and interpolate the provided remoteDevProfile" 554 tags: 555 - component 556 /v1/components/{id}/resources: 557 get: 558 deprecated: false 559 description: Get kubernetes resources 560 operationId: ComponentResources 561 parameters: 562 - allowReserved: false 563 deprecated: false 564 description: Resource identifier 565 explode: false 566 in: path 567 name: id 568 required: true 569 schema: 570 type: string 571 style: simple 572 responses: 573 "200": 574 content: 575 application/json: 576 schema: 577 items: 578 $ref: '#/components/schemas/component.Resource-item' 579 type: array 580 description: component resource 581 "404": 582 description: Resource not found 583 "4XX": 584 content: 585 application/problem+json: 586 schema: 587 $ref: '#/components/schemas/problem.generic' 588 description: Request Error 589 summary: Get kubernetes resources 590 tags: 591 - component 592 /v1/environment_variables: 593 get: 594 deprecated: false 595 description: List environment variables matching any selected filters. 596 operationId: Environment_variableList 597 parameters: 598 - allowEmptyValue: true 599 allowReserved: false 600 deprecated: false 601 description: The collection page number 602 explode: false 603 in: query 604 name: page 605 required: false 606 schema: 607 default: 1 608 type: integer 609 style: form 610 - allowEmptyValue: false 611 allowReserved: false 612 deprecated: false 613 description: Filter by name 614 explode: false 615 in: query 616 name: name 617 required: false 618 schema: 619 type: string 620 style: form 621 - allowEmptyValue: false 622 allowReserved: false 623 deprecated: false 624 description: Filter by environment 625 explode: false 626 in: query 627 name: environment 628 required: false 629 schema: 630 type: string 631 style: form 632 - allowEmptyValue: false 633 allowReserved: false 634 deprecated: false 635 description: Filter by organization 636 explode: false 637 in: query 638 name: organization 639 required: false 640 schema: 641 type: string 642 style: form 643 responses: 644 "200": 645 content: 646 application/hal+json: 647 schema: 648 $ref: '#/components/schemas/paginated-environment_variable-collection' 649 description: environment_variable collection 650 "4XX": 651 content: 652 application/problem+json: 653 schema: 654 $ref: '#/components/schemas/problem.generic' 655 description: Request Error 656 summary: List environment variables matching any selected filters. 657 tags: 658 - environment_variable 659 post: 660 deprecated: false 661 description: Create a specific environment variable. 662 operationId: Environment_variableCreate 663 parameters: [] 664 requestBody: 665 content: 666 application/json: 667 schema: 668 $ref: '#/components/schemas/environment_variable.CreateAction' 669 description: The new environment_variable resource 670 required: true 671 responses: 672 "200": 673 content: 674 application/hal+json: 675 schema: 676 $ref: '#/components/schemas/environment_variable-item' 677 description: environment_variable resource created 678 "400": 679 description: Invalid input 680 "422": 681 description: Unprocessable entity 682 "4XX": 683 content: 684 application/problem+json: 685 schema: 686 $ref: '#/components/schemas/problem.generic' 687 description: Request Error 688 summary: Create a specific environment variable. 689 tags: 690 - environment_variable 691 /v1/environment_variables/{id}: 692 delete: 693 deprecated: false 694 description: Delete a specific environment variable. 695 operationId: Environment_variableDelete 696 parameters: 697 - allowReserved: false 698 deprecated: false 699 description: Resource identifier 700 explode: false 701 in: path 702 name: id 703 required: true 704 schema: 705 type: string 706 style: simple 707 requestBody: 708 content: 709 application/json: 710 schema: {} 711 description: No Request Body 712 required: false 713 responses: 714 "204": 715 description: environment_variable resource deleted 716 "404": 717 description: Resource not found 718 "4XX": 719 content: 720 application/problem+json: 721 schema: 722 $ref: '#/components/schemas/problem.generic' 723 description: Request Error 724 summary: Delete a specific environment variable. 725 tags: 726 - environment_variable 727 get: 728 deprecated: false 729 description: View a specific environment variable. 730 operationId: Environment_variableView 731 parameters: 732 - allowReserved: false 733 deprecated: false 734 description: Resource identifier 735 explode: false 736 in: path 737 name: id 738 required: true 739 schema: 740 type: string 741 style: simple 742 responses: 743 "200": 744 content: 745 application/hal+json: 746 schema: 747 $ref: '#/components/schemas/environment_variable-item' 748 description: environment_variable resource 749 "404": 750 description: Resource not found 751 "4XX": 752 content: 753 application/problem+json: 754 schema: 755 $ref: '#/components/schemas/problem.generic' 756 description: Request Error 757 summary: View a specific environment variable. 758 tags: 759 - environment_variable 760 patch: 761 deprecated: false 762 description: Edit a specific environment variable. 763 operationId: Environment_variableEdit 764 parameters: 765 - allowReserved: false 766 deprecated: false 767 description: Resource identifier 768 explode: false 769 in: path 770 name: id 771 required: true 772 schema: 773 type: string 774 style: simple 775 requestBody: 776 content: 777 application/json: 778 schema: 779 $ref: '#/components/schemas/environment_variable.EditAction' 780 description: The updated environment_variable resource 781 required: true 782 responses: 783 "200": 784 content: 785 application/hal+json: 786 schema: 787 $ref: '#/components/schemas/environment_variable-item' 788 description: environment_variable resource updated 789 "400": 790 description: Invalid input 791 "422": 792 description: Unprocessable entity 793 "404": 794 description: Resource not found 795 "4XX": 796 content: 797 application/problem+json: 798 schema: 799 $ref: '#/components/schemas/problem.generic' 800 description: Request Error 801 summary: Edit a specific environment variable. 802 tags: 803 - environment_variable 804 /v1/environments: 805 get: 806 deprecated: false 807 description: List environments matching any selected filters. 808 operationId: EnvironmentList 809 parameters: 810 - allowEmptyValue: true 811 allowReserved: false 812 deprecated: false 813 description: The collection page number 814 explode: false 815 in: query 816 name: page 817 required: false 818 schema: 819 default: 1 820 type: integer 821 style: form 822 - allowEmptyValue: false 823 allowReserved: false 824 deprecated: false 825 description: Filter by organization 826 explode: false 827 in: query 828 name: organization 829 required: false 830 schema: 831 type: string 832 style: form 833 - allowEmptyValue: false 834 allowReserved: false 835 deprecated: false 836 description: Filter by kubernetesIntegration 837 explode: false 838 in: query 839 name: kubernetesIntegration 840 required: false 841 schema: 842 type: string 843 style: form 844 - allowEmptyValue: false 845 allowReserved: false 846 deprecated: false 847 description: Filter by type 848 example: primary 849 explode: false 850 in: query 851 name: type 852 required: false 853 schema: 854 enum: 855 - primary 856 - ephemeral 857 type: string 858 style: form 859 - allowEmptyValue: false 860 allowReserved: false 861 deprecated: false 862 description: Filter by operationStatus 863 example: draft 864 explode: false 865 in: query 866 name: operationStatus 867 required: false 868 schema: 869 enum: 870 - draft 871 - queued 872 - building 873 - building_failed 874 - built 875 - deploying 876 - deployed 877 - deployment_failed 878 - updating 879 - updating_failed 880 - stopping 881 - stopping_failed 882 - stopped 883 - restarting 884 - restarting_failed 885 - running 886 - deleting 887 - deleting_failed 888 - deleted 889 - starting 890 - starting_failed 891 - aborted 892 - aborting 893 type: string 894 style: form 895 - allowEmptyValue: false 896 allowReserved: false 897 deprecated: false 898 description: Filter by clusterStatus 899 example: running_ok 900 explode: false 901 in: query 902 name: clusterStatus 903 required: false 904 schema: 905 enum: 906 - running_ok 907 - running_replica_issues 908 - running_issues 909 - completed 910 - ko 911 - not_available 912 - pending 913 - scheduling 914 - waiting 915 type: string 916 style: form 917 - allowEmptyValue: false 918 allowReserved: false 919 deprecated: false 920 description: Filter by search 921 explode: false 922 in: query 923 name: search 924 required: false 925 schema: 926 type: string 927 style: form 928 - allowEmptyValue: false 929 allowReserved: false 930 deprecated: false 931 description: Filter by project 932 explode: false 933 in: query 934 name: project 935 required: false 936 schema: 937 type: string 938 style: form 939 - allowEmptyValue: false 940 allowReserved: false 941 deprecated: false 942 description: Filter by label key-value pair. 943 explode: true 944 in: query 945 name: labels 946 required: false 947 schema: 948 additionalProperties: 949 type: string 950 type: object 951 style: deepObject 952 responses: 953 "200": 954 content: 955 application/hal+json: 956 schema: 957 $ref: '#/components/schemas/paginated-environment-collection' 958 description: environment collection 959 "4XX": 960 content: 961 application/problem+json: 962 schema: 963 $ref: '#/components/schemas/problem.generic' 964 description: Request Error 965 summary: List environments matching any selected filters. 966 tags: 967 - environment 968 post: 969 deprecated: false 970 description: Creates a new environment. 971 operationId: EnvironmentCreate 972 parameters: [] 973 requestBody: 974 content: 975 application/json: 976 schema: 977 $ref: '#/components/schemas/environment.CreateAction' 978 description: The new environment resource 979 required: true 980 responses: 981 "200": 982 content: 983 application/hal+json: 984 schema: 985 $ref: '#/components/schemas/environment-item' 986 description: environment resource created 987 "400": 988 description: Invalid input 989 "422": 990 description: Unprocessable entity 991 "4XX": 992 content: 993 application/problem+json: 994 schema: 995 $ref: '#/components/schemas/problem.generic' 996 description: Request Error 997 summary: Creates a new environment. 998 tags: 999 - environment 1000 /v1/environments/{id}: 1001 get: 1002 deprecated: false 1003 description: View a specific environment. 1004 operationId: EnvironmentView 1005 parameters: 1006 - allowReserved: false 1007 deprecated: false 1008 description: Resource identifier 1009 explode: false 1010 in: path 1011 name: id 1012 required: true 1013 schema: 1014 type: string 1015 style: simple 1016 responses: 1017 "200": 1018 content: 1019 application/hal+json: 1020 schema: 1021 $ref: '#/components/schemas/environment-item' 1022 description: environment resource 1023 "404": 1024 description: Resource not found 1025 "4XX": 1026 content: 1027 application/problem+json: 1028 schema: 1029 $ref: '#/components/schemas/problem.generic' 1030 description: Request Error 1031 summary: View a specific environment. 1032 tags: 1033 - environment 1034 /v1/environments/{id}/build-settings: 1035 patch: 1036 deprecated: false 1037 description: Edit the build settings of an environment. 1038 operationId: EnvironmentEdit_build_settings 1039 parameters: 1040 - allowReserved: false 1041 deprecated: false 1042 description: Resource identifier 1043 explode: false 1044 in: path 1045 name: id 1046 required: true 1047 schema: 1048 type: string 1049 style: simple 1050 requestBody: 1051 content: 1052 application/json: 1053 schema: 1054 $ref: '#/components/schemas/environment.EditBuildSettingsAction' 1055 description: The updated environment resource 1056 required: true 1057 responses: 1058 "200": 1059 content: 1060 application/hal+json: 1061 schema: 1062 $ref: '#/components/schemas/environment-item' 1063 description: environment resource updated 1064 "400": 1065 description: Invalid input 1066 "422": 1067 description: Unprocessable entity 1068 "404": 1069 description: Resource not found 1070 "4XX": 1071 content: 1072 application/problem+json: 1073 schema: 1074 $ref: '#/components/schemas/problem.generic' 1075 description: Request Error 1076 summary: Edit the build settings of an environment. 1077 tags: 1078 - environment 1079 /v1/environments/{id}/clone: 1080 post: 1081 deprecated: false 1082 description: Clone an environment. 1083 operationId: EnvironmentClone 1084 parameters: 1085 - allowReserved: false 1086 deprecated: false 1087 description: Resource identifier 1088 explode: false 1089 in: path 1090 name: id 1091 required: true 1092 schema: 1093 type: string 1094 style: simple 1095 requestBody: 1096 content: 1097 application/json: 1098 schema: 1099 $ref: '#/components/schemas/environment.CloneAction' 1100 description: The new environment resource 1101 required: true 1102 responses: 1103 "200": 1104 content: 1105 application/hal+json: 1106 schema: 1107 $ref: '#/components/schemas/environment-item' 1108 description: environment resource created 1109 "400": 1110 description: Invalid input 1111 "422": 1112 description: Unprocessable entity 1113 "404": 1114 description: Resource not found 1115 "4XX": 1116 content: 1117 application/problem+json: 1118 schema: 1119 $ref: '#/components/schemas/problem.generic' 1120 description: Request Error 1121 summary: Clone an environment. 1122 tags: 1123 - environment 1124 /v1/environments/{id}/components: 1125 put: 1126 deprecated: false 1127 description: Edit the components of an environment. 1128 operationId: EnvironmentEdit_components 1129 parameters: 1130 - allowReserved: false 1131 deprecated: false 1132 description: Resource identifier 1133 explode: false 1134 in: path 1135 name: id 1136 required: true 1137 schema: 1138 type: string 1139 style: simple 1140 requestBody: 1141 content: 1142 application/json: 1143 schema: 1144 $ref: '#/components/schemas/environment.EditComponentsAction' 1145 description: The updated environment resource 1146 required: true 1147 responses: 1148 "200": 1149 content: 1150 application/hal+json: 1151 schema: 1152 $ref: '#/components/schemas/environment-item' 1153 description: environment resource updated 1154 "400": 1155 description: Invalid input 1156 "422": 1157 description: Unprocessable entity 1158 "404": 1159 description: Resource not found 1160 "4XX": 1161 content: 1162 application/problem+json: 1163 schema: 1164 $ref: '#/components/schemas/problem.generic' 1165 description: Request Error 1166 summary: Edit the components of an environment. 1167 tags: 1168 - environment 1169 /v1/environments/{id}/configuration: 1170 put: 1171 deprecated: false 1172 description: Edit an environment. 1173 operationId: EnvironmentEdit_configuration 1174 parameters: 1175 - allowReserved: false 1176 deprecated: false 1177 description: Resource identifier 1178 explode: false 1179 in: path 1180 name: id 1181 required: true 1182 schema: 1183 type: string 1184 style: simple 1185 requestBody: 1186 content: 1187 application/json: 1188 schema: 1189 $ref: '#/components/schemas/environment.EditConfiguration' 1190 description: The updated environment resource 1191 required: true 1192 responses: 1193 "200": 1194 content: 1195 application/hal+json: 1196 schema: 1197 $ref: '#/components/schemas/environment-item' 1198 description: environment resource updated 1199 "400": 1200 description: Invalid input 1201 "422": 1202 description: Unprocessable entity 1203 "404": 1204 description: Resource not found 1205 "4XX": 1206 content: 1207 application/problem+json: 1208 schema: 1209 $ref: '#/components/schemas/problem.generic' 1210 description: Request Error 1211 summary: Edit an environment. 1212 tags: 1213 - environment 1214 /v1/environments/{id}/definition: 1215 get: 1216 deprecated: false 1217 description: View the bunnyshell manifest for the environment 1218 operationId: EnvironmentDefinition 1219 parameters: 1220 - allowReserved: false 1221 deprecated: false 1222 description: Resource identifier 1223 explode: false 1224 in: path 1225 name: id 1226 required: true 1227 schema: 1228 type: string 1229 style: simple 1230 responses: 1231 "200": 1232 content: 1233 application/x+yaml: 1234 schema: 1235 $ref: '#/components/schemas/environment.GenericObject' 1236 description: environment resource 1237 "404": 1238 description: Resource not found 1239 "4XX": 1240 content: 1241 application/problem+json: 1242 schema: 1243 $ref: '#/components/schemas/problem.generic' 1244 description: Request Error 1245 summary: View the bunnyshell manifest for the environment 1246 tags: 1247 - environment 1248 /v1/environments/{id}/delete: 1249 post: 1250 deprecated: false 1251 description: Delete a specific environment. 1252 operationId: EnvironmentDelete 1253 parameters: 1254 - allowReserved: false 1255 deprecated: false 1256 description: Resource identifier 1257 explode: false 1258 in: path 1259 name: id 1260 required: true 1261 schema: 1262 type: string 1263 style: simple 1264 requestBody: 1265 content: 1266 application/json: 1267 schema: {} 1268 description: No Request Body 1269 required: false 1270 responses: 1271 "200": 1272 content: 1273 application/hal+json: 1274 schema: 1275 $ref: '#/components/schemas/event-item' 1276 description: environment resource created 1277 "400": 1278 description: Invalid input 1279 "422": 1280 description: Unprocessable entity 1281 "404": 1282 description: Resource not found 1283 "4XX": 1284 content: 1285 application/problem+json: 1286 schema: 1287 $ref: '#/components/schemas/problem.generic' 1288 description: Request Error 1289 summary: Delete a specific environment. 1290 tags: 1291 - environment 1292 /v1/environments/{id}/deploy: 1293 post: 1294 deprecated: false 1295 description: Deploy an environment. 1296 operationId: EnvironmentDeploy 1297 parameters: 1298 - allowReserved: false 1299 deprecated: false 1300 description: Resource identifier 1301 explode: false 1302 in: path 1303 name: id 1304 required: true 1305 schema: 1306 type: string 1307 style: simple 1308 requestBody: 1309 content: 1310 application/json: 1311 schema: 1312 $ref: '#/components/schemas/environment.PartialDeployAction' 1313 description: The new environment resource 1314 required: true 1315 responses: 1316 "200": 1317 content: 1318 application/hal+json: 1319 schema: 1320 $ref: '#/components/schemas/event-item' 1321 description: environment resource created 1322 "400": 1323 description: Invalid input 1324 "422": 1325 description: Unprocessable entity 1326 "404": 1327 description: Resource not found 1328 "4XX": 1329 content: 1330 application/problem+json: 1331 schema: 1332 $ref: '#/components/schemas/problem.generic' 1333 description: Request Error 1334 summary: Deploy an environment. 1335 tags: 1336 - environment 1337 /v1/environments/{id}/kube-config: 1338 get: 1339 deprecated: false 1340 description: Download Kubernetes Config File 1341 operationId: EnvironmentKube_config 1342 parameters: 1343 - allowReserved: false 1344 deprecated: false 1345 description: Resource identifier 1346 explode: false 1347 in: path 1348 name: id 1349 required: true 1350 schema: 1351 type: string 1352 style: simple 1353 responses: 1354 "200": 1355 content: 1356 application/x+yaml: 1357 schema: 1358 $ref: '#/components/schemas/environment.KubeConfig-kube-config.read' 1359 description: environment resource 1360 "404": 1361 description: Resource not found 1362 "4XX": 1363 content: 1364 application/problem+json: 1365 schema: 1366 $ref: '#/components/schemas/problem.generic' 1367 description: Request Error 1368 summary: Download Kubernetes Config File 1369 tags: 1370 - environment 1371 /v1/environments/{id}/settings: 1372 put: 1373 deprecated: false 1374 description: Edit an environment. 1375 operationId: EnvironmentEdit_settings 1376 parameters: 1377 - allowReserved: false 1378 deprecated: false 1379 description: Resource identifier 1380 explode: false 1381 in: path 1382 name: id 1383 required: true 1384 schema: 1385 type: string 1386 style: simple 1387 requestBody: 1388 content: 1389 application/json: 1390 schema: 1391 $ref: '#/components/schemas/environment.EditSettings' 1392 description: The updated environment resource 1393 required: true 1394 responses: 1395 "200": 1396 content: 1397 application/hal+json: 1398 schema: 1399 $ref: '#/components/schemas/environment-item' 1400 description: environment resource updated 1401 "400": 1402 description: Invalid input 1403 "422": 1404 description: Unprocessable entity 1405 "404": 1406 description: Resource not found 1407 "4XX": 1408 content: 1409 application/problem+json: 1410 schema: 1411 $ref: '#/components/schemas/problem.generic' 1412 description: Request Error 1413 summary: Edit an environment. 1414 tags: 1415 - environment 1416 /v1/environments/{id}/start: 1417 post: 1418 deprecated: false 1419 description: Start an environment. 1420 operationId: EnvironmentStart 1421 parameters: 1422 - allowReserved: false 1423 deprecated: false 1424 description: Resource identifier 1425 explode: false 1426 in: path 1427 name: id 1428 required: true 1429 schema: 1430 type: string 1431 style: simple 1432 requestBody: 1433 content: 1434 application/json: 1435 schema: 1436 $ref: '#/components/schemas/environment.PartialStartAction' 1437 description: The new environment resource 1438 required: true 1439 responses: 1440 "200": 1441 content: 1442 application/hal+json: 1443 schema: 1444 $ref: '#/components/schemas/event-item' 1445 description: environment resource created 1446 "400": 1447 description: Invalid input 1448 "422": 1449 description: Unprocessable entity 1450 "404": 1451 description: Resource not found 1452 "4XX": 1453 content: 1454 application/problem+json: 1455 schema: 1456 $ref: '#/components/schemas/problem.generic' 1457 description: Request Error 1458 summary: Start an environment. 1459 tags: 1460 - environment 1461 /v1/environments/{id}/stop: 1462 post: 1463 deprecated: false 1464 description: Stop an environment. 1465 operationId: EnvironmentStop 1466 parameters: 1467 - allowReserved: false 1468 deprecated: false 1469 description: Resource identifier 1470 explode: false 1471 in: path 1472 name: id 1473 required: true 1474 schema: 1475 type: string 1476 style: simple 1477 requestBody: 1478 content: 1479 application/json: 1480 schema: 1481 $ref: '#/components/schemas/environment.PartialAction' 1482 description: The new environment resource 1483 required: true 1484 responses: 1485 "200": 1486 content: 1487 application/hal+json: 1488 schema: 1489 $ref: '#/components/schemas/event-item' 1490 description: environment resource created 1491 "400": 1492 description: Invalid input 1493 "422": 1494 description: Unprocessable entity 1495 "404": 1496 description: Resource not found 1497 "4XX": 1498 content: 1499 application/problem+json: 1500 schema: 1501 $ref: '#/components/schemas/problem.generic' 1502 description: Request Error 1503 summary: Stop an environment. 1504 tags: 1505 - environment 1506 /v1/events: 1507 get: 1508 deprecated: false 1509 description: List events matching any selected filters. 1510 operationId: EventList 1511 parameters: 1512 - allowEmptyValue: true 1513 allowReserved: false 1514 deprecated: false 1515 description: The collection page number 1516 explode: false 1517 in: query 1518 name: page 1519 required: false 1520 schema: 1521 default: 1 1522 type: integer 1523 style: form 1524 - allowEmptyValue: false 1525 allowReserved: false 1526 deprecated: false 1527 description: Filter by type 1528 example: env_create 1529 explode: false 1530 in: query 1531 name: type 1532 required: false 1533 schema: 1534 enum: 1535 - env_create 1536 - env_create_ephemeral 1537 - env_clone 1538 - env_deploy 1539 - env_delete 1540 - env_delete_ephemeral 1541 - env_start_manual 1542 - env_start_auto 1543 - env_stop_manual 1544 - env_stop_auto 1545 - env_stop_expired 1546 - env_abort_manual 1547 - env_conv_eph_to_primary 1548 - build_settings_validated 1549 - kubernetes_apply_configuration 1550 type: string 1551 style: form 1552 - allowEmptyValue: false 1553 allowReserved: false 1554 deprecated: false 1555 description: Filter by status 1556 example: new 1557 explode: false 1558 in: query 1559 name: status 1560 required: false 1561 schema: 1562 enum: 1563 - new 1564 - in_progress 1565 - success 1566 - fail 1567 type: string 1568 style: form 1569 - allowEmptyValue: false 1570 allowReserved: false 1571 deprecated: false 1572 description: Filter by environment 1573 explode: false 1574 in: query 1575 name: environment 1576 required: false 1577 schema: 1578 type: string 1579 style: form 1580 - allowEmptyValue: false 1581 allowReserved: false 1582 deprecated: false 1583 description: Filter by organization 1584 explode: false 1585 in: query 1586 name: organization 1587 required: false 1588 schema: 1589 type: string 1590 style: form 1591 responses: 1592 "200": 1593 content: 1594 application/hal+json: 1595 schema: 1596 $ref: '#/components/schemas/paginated-event-collection' 1597 description: event collection 1598 "4XX": 1599 content: 1600 application/problem+json: 1601 schema: 1602 $ref: '#/components/schemas/problem.generic' 1603 description: Request Error 1604 summary: List events matching any selected filters. 1605 tags: 1606 - event 1607 /v1/events/{id}: 1608 get: 1609 deprecated: false 1610 description: View a specific event. 1611 operationId: EventView 1612 parameters: 1613 - allowReserved: false 1614 deprecated: false 1615 description: Resource identifier 1616 explode: false 1617 in: path 1618 name: id 1619 required: true 1620 schema: 1621 type: string 1622 style: simple 1623 responses: 1624 "200": 1625 content: 1626 application/hal+json: 1627 schema: 1628 $ref: '#/components/schemas/event-item' 1629 description: event resource 1630 "404": 1631 description: Resource not found 1632 "4XX": 1633 content: 1634 application/problem+json: 1635 schema: 1636 $ref: '#/components/schemas/problem.generic' 1637 description: Request Error 1638 summary: View a specific event. 1639 tags: 1640 - event 1641 /v1/kubernetes_integrations: 1642 get: 1643 deprecated: false 1644 description: List Kubernetes integrations matching any selected filters. 1645 operationId: Kubernetes_integrationList 1646 parameters: 1647 - allowEmptyValue: true 1648 allowReserved: false 1649 deprecated: false 1650 description: The collection page number 1651 explode: false 1652 in: query 1653 name: page 1654 required: false 1655 schema: 1656 default: 1 1657 type: integer 1658 style: form 1659 - allowEmptyValue: false 1660 allowReserved: false 1661 deprecated: false 1662 description: Filter by organization 1663 explode: false 1664 in: query 1665 name: organization 1666 required: false 1667 schema: 1668 type: string 1669 style: form 1670 - allowEmptyValue: false 1671 allowReserved: false 1672 deprecated: false 1673 description: Filter by environment 1674 explode: false 1675 in: query 1676 name: environment 1677 required: false 1678 schema: 1679 type: string 1680 style: form 1681 - allowEmptyValue: false 1682 allowReserved: false 1683 deprecated: false 1684 description: Filter by status 1685 example: new 1686 explode: false 1687 in: query 1688 name: status 1689 required: false 1690 schema: 1691 enum: 1692 - new 1693 - connected 1694 - disconnected 1695 - detached 1696 type: string 1697 style: form 1698 - allowEmptyValue: false 1699 allowReserved: false 1700 deprecated: false 1701 description: Filter by cloudProvider 1702 explode: false 1703 in: query 1704 name: cloudProvider 1705 required: false 1706 schema: 1707 type: string 1708 style: form 1709 responses: 1710 "200": 1711 content: 1712 application/hal+json: 1713 schema: 1714 $ref: '#/components/schemas/paginated-kubernetes_integration-collection' 1715 description: kubernetes_integration collection 1716 "4XX": 1717 content: 1718 application/problem+json: 1719 schema: 1720 $ref: '#/components/schemas/problem.generic' 1721 description: Request Error 1722 summary: List Kubernetes integrations matching any selected filters. 1723 tags: 1724 - kubernetes_integration 1725 /v1/kubernetes_integrations/{id}: 1726 get: 1727 deprecated: false 1728 description: View a specific Kubernetes integration. 1729 operationId: Kubernetes_integrationView 1730 parameters: 1731 - allowReserved: false 1732 deprecated: false 1733 description: Resource identifier 1734 explode: false 1735 in: path 1736 name: id 1737 required: true 1738 schema: 1739 type: string 1740 style: simple 1741 responses: 1742 "200": 1743 content: 1744 application/hal+json: 1745 schema: 1746 $ref: '#/components/schemas/kubernetes_integration-item' 1747 description: kubernetes_integration resource 1748 "404": 1749 description: Resource not found 1750 "4XX": 1751 content: 1752 application/problem+json: 1753 schema: 1754 $ref: '#/components/schemas/problem.generic' 1755 description: Request Error 1756 summary: View a specific Kubernetes integration. 1757 tags: 1758 - kubernetes_integration 1759 /v1/organizations: 1760 get: 1761 deprecated: false 1762 description: List organization matching any selected filters. 1763 operationId: OrganizationList 1764 parameters: 1765 - allowEmptyValue: true 1766 allowReserved: false 1767 deprecated: false 1768 description: The collection page number 1769 explode: false 1770 in: query 1771 name: page 1772 required: false 1773 schema: 1774 default: 1 1775 type: integer 1776 style: form 1777 - allowEmptyValue: false 1778 allowReserved: false 1779 deprecated: false 1780 description: Filter by search 1781 explode: false 1782 in: query 1783 name: search 1784 required: false 1785 schema: 1786 type: string 1787 style: form 1788 responses: 1789 "200": 1790 content: 1791 application/hal+json: 1792 schema: 1793 $ref: '#/components/schemas/paginated-organization-collection' 1794 description: organization collection 1795 "4XX": 1796 content: 1797 application/problem+json: 1798 schema: 1799 $ref: '#/components/schemas/problem.generic' 1800 description: Request Error 1801 summary: List organization matching any selected filters. 1802 tags: 1803 - organization 1804 /v1/organizations/{id}: 1805 get: 1806 deprecated: false 1807 description: View a specific organization. 1808 operationId: OrganizationView 1809 parameters: 1810 - allowReserved: false 1811 deprecated: false 1812 description: Resource identifier 1813 explode: false 1814 in: path 1815 name: id 1816 required: true 1817 schema: 1818 type: string 1819 style: simple 1820 responses: 1821 "200": 1822 content: 1823 application/hal+json: 1824 schema: 1825 $ref: '#/components/schemas/organization-item' 1826 description: organization resource 1827 "404": 1828 description: Resource not found 1829 "4XX": 1830 content: 1831 application/problem+json: 1832 schema: 1833 $ref: '#/components/schemas/problem.generic' 1834 description: Request Error 1835 summary: View a specific organization. 1836 tags: 1837 - organization 1838 /v1/pipelines: 1839 get: 1840 deprecated: true 1841 description: List pipelines matching any selected filters. 1842 operationId: PipelineList 1843 parameters: 1844 - allowEmptyValue: true 1845 allowReserved: false 1846 deprecated: false 1847 description: The collection page number 1848 explode: false 1849 in: query 1850 name: page 1851 required: false 1852 schema: 1853 default: 1 1854 type: integer 1855 style: form 1856 - allowEmptyValue: false 1857 allowReserved: false 1858 deprecated: false 1859 description: Filter by event 1860 explode: false 1861 in: query 1862 name: event 1863 required: false 1864 schema: 1865 type: string 1866 style: form 1867 - allowEmptyValue: false 1868 allowReserved: false 1869 deprecated: false 1870 description: Filter by environment 1871 explode: false 1872 in: query 1873 name: environment 1874 required: false 1875 schema: 1876 type: string 1877 style: form 1878 - allowEmptyValue: false 1879 allowReserved: false 1880 deprecated: false 1881 description: Filter by organization 1882 explode: false 1883 in: query 1884 name: organization 1885 required: false 1886 schema: 1887 type: string 1888 style: form 1889 - allowEmptyValue: false 1890 allowReserved: false 1891 deprecated: false 1892 description: Filter by status 1893 example: queued 1894 explode: false 1895 in: query 1896 name: status 1897 required: false 1898 schema: 1899 enum: 1900 - queued 1901 - in_progress 1902 - success 1903 - failing 1904 - failed 1905 - aborting 1906 - aborted 1907 type: string 1908 style: form 1909 responses: 1910 "200": 1911 content: 1912 application/hal+json: 1913 schema: 1914 $ref: '#/components/schemas/paginated-pipeline-collection' 1915 description: pipeline collection 1916 "4XX": 1917 content: 1918 application/problem+json: 1919 schema: 1920 $ref: '#/components/schemas/problem.generic' 1921 description: Request Error 1922 summary: List pipelines matching any selected filters. 1923 tags: 1924 - pipeline 1925 /v1/pipelines/{id}: 1926 get: 1927 deprecated: true 1928 description: View a specific Pipeline. 1929 operationId: PipelineView 1930 parameters: 1931 - allowReserved: false 1932 deprecated: false 1933 description: Resource identifier 1934 explode: false 1935 in: path 1936 name: id 1937 required: true 1938 schema: 1939 type: string 1940 style: simple 1941 responses: 1942 "200": 1943 content: 1944 application/hal+json: 1945 schema: 1946 $ref: '#/components/schemas/pipeline-item' 1947 description: pipeline resource 1948 "404": 1949 description: Resource not found 1950 "4XX": 1951 content: 1952 application/problem+json: 1953 schema: 1954 $ref: '#/components/schemas/problem.generic' 1955 description: Request Error 1956 summary: View a specific Pipeline. 1957 tags: 1958 - pipeline 1959 /v1/project_variables: 1960 get: 1961 deprecated: false 1962 description: List project variables matching any selected filters. 1963 operationId: Project_variableList 1964 parameters: 1965 - allowEmptyValue: true 1966 allowReserved: false 1967 deprecated: false 1968 description: The collection page number 1969 explode: false 1970 in: query 1971 name: page 1972 required: false 1973 schema: 1974 default: 1 1975 type: integer 1976 style: form 1977 - allowEmptyValue: false 1978 allowReserved: false 1979 deprecated: false 1980 description: Filter by name 1981 explode: false 1982 in: query 1983 name: name 1984 required: false 1985 schema: 1986 type: string 1987 style: form 1988 - allowEmptyValue: false 1989 allowReserved: false 1990 deprecated: false 1991 description: Filter by project 1992 explode: false 1993 in: query 1994 name: project 1995 required: false 1996 schema: 1997 type: string 1998 style: form 1999 - allowEmptyValue: false 2000 allowReserved: false 2001 deprecated: false 2002 description: Filter by organization 2003 explode: false 2004 in: query 2005 name: organization 2006 required: false 2007 schema: 2008 type: string 2009 style: form 2010 responses: 2011 "200": 2012 content: 2013 application/hal+json: 2014 schema: 2015 $ref: '#/components/schemas/paginated-project_variable-collection' 2016 description: project_variable collection 2017 "4XX": 2018 content: 2019 application/problem+json: 2020 schema: 2021 $ref: '#/components/schemas/problem.generic' 2022 description: Request Error 2023 summary: List project variables matching any selected filters. 2024 tags: 2025 - project_variable 2026 post: 2027 deprecated: false 2028 description: Create a specific project variable. 2029 operationId: Project_variableCreate 2030 parameters: [] 2031 requestBody: 2032 content: 2033 application/json: 2034 schema: 2035 $ref: '#/components/schemas/project_variable.CreateAction' 2036 description: The new project_variable resource 2037 required: true 2038 responses: 2039 "200": 2040 content: 2041 application/hal+json: 2042 schema: 2043 $ref: '#/components/schemas/project_variable-item' 2044 description: project_variable resource created 2045 "400": 2046 description: Invalid input 2047 "422": 2048 description: Unprocessable entity 2049 "4XX": 2050 content: 2051 application/problem+json: 2052 schema: 2053 $ref: '#/components/schemas/problem.generic' 2054 description: Request Error 2055 summary: Create a specific project variable. 2056 tags: 2057 - project_variable 2058 /v1/project_variables/{id}: 2059 delete: 2060 deprecated: false 2061 description: Delete a specific project variable. 2062 operationId: Project_variableDelete 2063 parameters: 2064 - allowReserved: false 2065 deprecated: false 2066 description: Resource identifier 2067 explode: false 2068 in: path 2069 name: id 2070 required: true 2071 schema: 2072 type: string 2073 style: simple 2074 requestBody: 2075 content: 2076 application/json: 2077 schema: {} 2078 description: No Request Body 2079 required: false 2080 responses: 2081 "204": 2082 description: project_variable resource deleted 2083 "404": 2084 description: Resource not found 2085 "4XX": 2086 content: 2087 application/problem+json: 2088 schema: 2089 $ref: '#/components/schemas/problem.generic' 2090 description: Request Error 2091 summary: Delete a specific project variable. 2092 tags: 2093 - project_variable 2094 get: 2095 deprecated: false 2096 description: View a specific project variable. 2097 operationId: Project_variableView 2098 parameters: 2099 - allowReserved: false 2100 deprecated: false 2101 description: Resource identifier 2102 explode: false 2103 in: path 2104 name: id 2105 required: true 2106 schema: 2107 type: string 2108 style: simple 2109 responses: 2110 "200": 2111 content: 2112 application/hal+json: 2113 schema: 2114 $ref: '#/components/schemas/project_variable-item' 2115 description: project_variable resource 2116 "404": 2117 description: Resource not found 2118 "4XX": 2119 content: 2120 application/problem+json: 2121 schema: 2122 $ref: '#/components/schemas/problem.generic' 2123 description: Request Error 2124 summary: View a specific project variable. 2125 tags: 2126 - project_variable 2127 patch: 2128 deprecated: false 2129 description: Edit a specific project variable. 2130 operationId: Project_variableEdit 2131 parameters: 2132 - allowReserved: false 2133 deprecated: false 2134 description: Resource identifier 2135 explode: false 2136 in: path 2137 name: id 2138 required: true 2139 schema: 2140 type: string 2141 style: simple 2142 requestBody: 2143 content: 2144 application/json: 2145 schema: 2146 $ref: '#/components/schemas/project_variable.EditAction' 2147 description: The updated project_variable resource 2148 required: true 2149 responses: 2150 "200": 2151 content: 2152 application/hal+json: 2153 schema: 2154 $ref: '#/components/schemas/project_variable-item' 2155 description: project_variable resource updated 2156 "400": 2157 description: Invalid input 2158 "422": 2159 description: Unprocessable entity 2160 "404": 2161 description: Resource not found 2162 "4XX": 2163 content: 2164 application/problem+json: 2165 schema: 2166 $ref: '#/components/schemas/problem.generic' 2167 description: Request Error 2168 summary: Edit a specific project variable. 2169 tags: 2170 - project_variable 2171 /v1/projects: 2172 get: 2173 deprecated: false 2174 description: List projects matching any selected filters. 2175 operationId: ProjectList 2176 parameters: 2177 - allowEmptyValue: true 2178 allowReserved: false 2179 deprecated: false 2180 description: The collection page number 2181 explode: false 2182 in: query 2183 name: page 2184 required: false 2185 schema: 2186 default: 1 2187 type: integer 2188 style: form 2189 - allowEmptyValue: false 2190 allowReserved: false 2191 deprecated: false 2192 description: Filter by organization 2193 explode: false 2194 in: query 2195 name: organization 2196 required: false 2197 schema: 2198 type: string 2199 style: form 2200 - allowEmptyValue: false 2201 allowReserved: false 2202 deprecated: false 2203 description: Filter by search 2204 explode: false 2205 in: query 2206 name: search 2207 required: false 2208 schema: 2209 type: string 2210 style: form 2211 - allowEmptyValue: false 2212 allowReserved: false 2213 deprecated: false 2214 description: Filter by label key-value pair. 2215 explode: true 2216 in: query 2217 name: labels 2218 required: false 2219 schema: 2220 additionalProperties: 2221 type: string 2222 type: object 2223 style: deepObject 2224 responses: 2225 "200": 2226 content: 2227 application/hal+json: 2228 schema: 2229 $ref: '#/components/schemas/paginated-project-collection' 2230 description: project collection 2231 "4XX": 2232 content: 2233 application/problem+json: 2234 schema: 2235 $ref: '#/components/schemas/problem.generic' 2236 description: Request Error 2237 summary: List projects matching any selected filters. 2238 tags: 2239 - project 2240 post: 2241 deprecated: false 2242 description: Creates new project. 2243 operationId: ProjectCreate 2244 parameters: [] 2245 requestBody: 2246 content: 2247 application/json: 2248 schema: 2249 $ref: '#/components/schemas/project.CreateAction' 2250 description: The new project resource 2251 required: true 2252 responses: 2253 "200": 2254 content: 2255 application/hal+json: 2256 schema: 2257 $ref: '#/components/schemas/project-item' 2258 description: project resource created 2259 "400": 2260 description: Invalid input 2261 "422": 2262 description: Unprocessable entity 2263 "4XX": 2264 content: 2265 application/problem+json: 2266 schema: 2267 $ref: '#/components/schemas/problem.generic' 2268 description: Request Error 2269 summary: Creates new project. 2270 tags: 2271 - project 2272 /v1/projects/{id}: 2273 delete: 2274 deprecated: false 2275 description: Delete a specific project. 2276 operationId: ProjectDelete 2277 parameters: 2278 - allowReserved: false 2279 deprecated: false 2280 description: Resource identifier 2281 explode: false 2282 in: path 2283 name: id 2284 required: true 2285 schema: 2286 type: string 2287 style: simple 2288 requestBody: 2289 content: 2290 application/json: 2291 schema: {} 2292 description: No Request Body 2293 required: false 2294 responses: 2295 "204": 2296 description: project resource deleted 2297 "404": 2298 description: Resource not found 2299 "4XX": 2300 content: 2301 application/problem+json: 2302 schema: 2303 $ref: '#/components/schemas/problem.generic' 2304 description: Request Error 2305 summary: Delete a specific project. 2306 tags: 2307 - project 2308 get: 2309 deprecated: false 2310 description: View a specific project. 2311 operationId: ProjectView 2312 parameters: 2313 - allowReserved: false 2314 deprecated: false 2315 description: Resource identifier 2316 explode: false 2317 in: path 2318 name: id 2319 required: true 2320 schema: 2321 type: string 2322 style: simple 2323 responses: 2324 "200": 2325 content: 2326 application/hal+json: 2327 schema: 2328 $ref: '#/components/schemas/project-item' 2329 description: project resource 2330 "404": 2331 description: Resource not found 2332 "4XX": 2333 content: 2334 application/problem+json: 2335 schema: 2336 $ref: '#/components/schemas/problem.generic' 2337 description: Request Error 2338 summary: View a specific project. 2339 tags: 2340 - project 2341 /v1/projects/{id}/build-settings: 2342 patch: 2343 deprecated: false 2344 description: Edit the build settings of a project. 2345 operationId: ProjectEdit_build_settings 2346 parameters: 2347 - allowReserved: false 2348 deprecated: false 2349 description: Resource identifier 2350 explode: false 2351 in: path 2352 name: id 2353 required: true 2354 schema: 2355 type: string 2356 style: simple 2357 requestBody: 2358 content: 2359 application/json: 2360 schema: 2361 $ref: '#/components/schemas/project.EditBuildSettingsAction' 2362 description: The updated project resource 2363 required: true 2364 responses: 2365 "200": 2366 content: 2367 application/hal+json: 2368 schema: 2369 $ref: '#/components/schemas/project-item' 2370 description: project resource updated 2371 "400": 2372 description: Invalid input 2373 "422": 2374 description: Unprocessable entity 2375 "404": 2376 description: Resource not found 2377 "4XX": 2378 content: 2379 application/problem+json: 2380 schema: 2381 $ref: '#/components/schemas/problem.generic' 2382 description: Request Error 2383 summary: Edit the build settings of a project. 2384 tags: 2385 - project 2386 /v1/projects/{id}/settings: 2387 patch: 2388 deprecated: false 2389 description: Edit a project. 2390 operationId: ProjectEdit_settings 2391 parameters: 2392 - allowReserved: false 2393 deprecated: false 2394 description: Resource identifier 2395 explode: false 2396 in: path 2397 name: id 2398 required: true 2399 schema: 2400 type: string 2401 style: simple 2402 requestBody: 2403 content: 2404 application/json: 2405 schema: 2406 $ref: '#/components/schemas/project.EditSettingsAction' 2407 description: The updated project resource 2408 required: true 2409 responses: 2410 "200": 2411 content: 2412 application/hal+json: 2413 schema: 2414 $ref: '#/components/schemas/project-item' 2415 description: project resource updated 2416 "400": 2417 description: Invalid input 2418 "422": 2419 description: Unprocessable entity 2420 "404": 2421 description: Resource not found 2422 "4XX": 2423 content: 2424 application/problem+json: 2425 schema: 2426 $ref: '#/components/schemas/problem.generic' 2427 description: Request Error 2428 summary: Edit a project. 2429 tags: 2430 - project 2431 /v1/registry_integrations: 2432 get: 2433 deprecated: false 2434 description: List Registry integrations matching any selected filters. 2435 operationId: Registry_integrationList 2436 parameters: 2437 - allowEmptyValue: true 2438 allowReserved: false 2439 deprecated: false 2440 description: The collection page number 2441 explode: false 2442 in: query 2443 name: page 2444 required: false 2445 schema: 2446 default: 1 2447 type: integer 2448 style: form 2449 - allowEmptyValue: false 2450 allowReserved: false 2451 deprecated: false 2452 description: Filter by organization 2453 explode: false 2454 in: query 2455 name: organization 2456 required: false 2457 schema: 2458 type: string 2459 style: form 2460 responses: 2461 "200": 2462 content: 2463 application/hal+json: 2464 schema: 2465 $ref: '#/components/schemas/paginated-registry_integration-collection' 2466 description: registry_integration collection 2467 "4XX": 2468 content: 2469 application/problem+json: 2470 schema: 2471 $ref: '#/components/schemas/problem.generic' 2472 description: Request Error 2473 summary: List Registry integrations matching any selected filters. 2474 tags: 2475 - registry_integration 2476 /v1/registry_integrations/{id}: 2477 get: 2478 deprecated: false 2479 description: View a specific Registry integration. 2480 operationId: Registry_integrationView 2481 parameters: 2482 - allowReserved: false 2483 deprecated: false 2484 description: Resource identifier 2485 explode: false 2486 in: path 2487 name: id 2488 required: true 2489 schema: 2490 type: string 2491 style: simple 2492 responses: 2493 "200": 2494 content: 2495 application/hal+json: 2496 schema: 2497 $ref: '#/components/schemas/registry_integration-item' 2498 description: registry_integration resource 2499 "404": 2500 description: Resource not found 2501 "4XX": 2502 content: 2503 application/problem+json: 2504 schema: 2505 $ref: '#/components/schemas/problem.generic' 2506 description: Request Error 2507 summary: View a specific Registry integration. 2508 tags: 2509 - registry_integration 2510 /v1/secrets/decrypt: 2511 post: 2512 deprecated: false 2513 description: Decrypt a cipher text. 2514 operationId: SecretDecrypt 2515 parameters: [] 2516 requestBody: 2517 content: 2518 application/json: 2519 schema: 2520 $ref: '#/components/schemas/secret.DecryptAction' 2521 description: The new secret resource 2522 required: true 2523 responses: 2524 "200": 2525 content: 2526 application/hal+json: 2527 schema: 2528 $ref: '#/components/schemas/secret.Decrypted-item' 2529 description: secret resource created 2530 "400": 2531 description: Invalid input 2532 "422": 2533 description: Unprocessable entity 2534 "4XX": 2535 content: 2536 application/problem+json: 2537 schema: 2538 $ref: '#/components/schemas/problem.generic' 2539 description: Request Error 2540 summary: Decrypt a cipher text. 2541 tags: 2542 - secret 2543 /v1/secrets/encrypt: 2544 post: 2545 deprecated: false 2546 description: Encrypt a plain text. 2547 operationId: SecretEncrypt 2548 parameters: [] 2549 requestBody: 2550 content: 2551 application/json: 2552 schema: 2553 $ref: '#/components/schemas/secret.EncryptAction' 2554 description: The new secret resource 2555 required: true 2556 responses: 2557 "200": 2558 content: 2559 application/hal+json: 2560 schema: 2561 $ref: '#/components/schemas/secret.Encrypted-item' 2562 description: secret resource created 2563 "400": 2564 description: Invalid input 2565 "422": 2566 description: Unprocessable entity 2567 "4XX": 2568 content: 2569 application/problem+json: 2570 schema: 2571 $ref: '#/components/schemas/problem.generic' 2572 description: Request Error 2573 summary: Encrypt a plain text. 2574 tags: 2575 - secret 2576 /v1/secrets/transcrypt-configuration: 2577 post: 2578 deprecated: false 2579 description: Encrypt or decrypt secrets from an environment configuration. 2580 operationId: SecretTranscrypt-configuration 2581 parameters: [] 2582 requestBody: 2583 content: 2584 application/json: 2585 schema: 2586 $ref: '#/components/schemas/secret.TranscryptConfigurationAction' 2587 description: The new secret resource 2588 required: true 2589 responses: 2590 "200": 2591 content: 2592 application/x+yaml: 2593 schema: 2594 $ref: '#/components/schemas/secret.GenericObject' 2595 description: secret resource created 2596 "400": 2597 description: Invalid input 2598 "422": 2599 description: Unprocessable entity 2600 "4XX": 2601 content: 2602 application/problem+json: 2603 schema: 2604 $ref: '#/components/schemas/problem.generic' 2605 description: Request Error 2606 summary: Encrypt or decrypt secrets from an environment configuration. 2607 tags: 2608 - secret 2609 /v1/service_component_variables: 2610 get: 2611 deprecated: false 2612 description: List component variables matching any selected filters. 2613 operationId: Service_component_variableList 2614 parameters: 2615 - allowEmptyValue: true 2616 allowReserved: false 2617 deprecated: false 2618 description: The collection page number 2619 explode: false 2620 in: query 2621 name: page 2622 required: false 2623 schema: 2624 default: 1 2625 type: integer 2626 style: form 2627 - allowEmptyValue: false 2628 allowReserved: false 2629 deprecated: false 2630 description: Filter by name 2631 explode: false 2632 in: query 2633 name: name 2634 required: false 2635 schema: 2636 type: string 2637 style: form 2638 - allowEmptyValue: false 2639 allowReserved: false 2640 deprecated: false 2641 description: Filter by serviceComponent 2642 explode: false 2643 in: query 2644 name: serviceComponent 2645 required: false 2646 schema: 2647 type: string 2648 style: form 2649 - allowEmptyValue: false 2650 allowReserved: false 2651 deprecated: false 2652 description: Filter by serviceComponentName 2653 explode: false 2654 in: query 2655 name: serviceComponentName 2656 required: false 2657 schema: 2658 type: string 2659 style: form 2660 - allowEmptyValue: false 2661 allowReserved: false 2662 deprecated: false 2663 description: Filter by environment 2664 explode: false 2665 in: query 2666 name: environment 2667 required: false 2668 schema: 2669 type: string 2670 style: form 2671 - allowEmptyValue: false 2672 allowReserved: false 2673 deprecated: false 2674 description: Filter by project 2675 explode: false 2676 in: query 2677 name: project 2678 required: false 2679 schema: 2680 type: string 2681 style: form 2682 - allowEmptyValue: false 2683 allowReserved: false 2684 deprecated: false 2685 description: Filter by organization 2686 explode: false 2687 in: query 2688 name: organization 2689 required: false 2690 schema: 2691 type: string 2692 style: form 2693 responses: 2694 "200": 2695 content: 2696 application/hal+json: 2697 schema: 2698 $ref: '#/components/schemas/paginated-service_component_variable-collection' 2699 description: service_component_variable collection 2700 "4XX": 2701 content: 2702 application/problem+json: 2703 schema: 2704 $ref: '#/components/schemas/problem.generic' 2705 description: Request Error 2706 summary: List component variables matching any selected filters. 2707 tags: 2708 - service_component_variable 2709 post: 2710 deprecated: false 2711 description: Create a specific component variable. 2712 operationId: Service_component_variableCreate 2713 parameters: [] 2714 requestBody: 2715 content: 2716 application/json: 2717 schema: 2718 $ref: '#/components/schemas/service_component_variable.CreateAction' 2719 description: The new service_component_variable resource 2720 required: true 2721 responses: 2722 "200": 2723 content: 2724 application/hal+json: 2725 schema: 2726 $ref: '#/components/schemas/service_component_variable-item' 2727 description: service_component_variable resource created 2728 "400": 2729 description: Invalid input 2730 "422": 2731 description: Unprocessable entity 2732 "4XX": 2733 content: 2734 application/problem+json: 2735 schema: 2736 $ref: '#/components/schemas/problem.generic' 2737 description: Request Error 2738 summary: Create a specific component variable. 2739 tags: 2740 - service_component_variable 2741 /v1/service_component_variables/{id}: 2742 delete: 2743 deprecated: false 2744 description: Delete a specific component variable. 2745 operationId: Service_component_variableDelete 2746 parameters: 2747 - allowReserved: false 2748 deprecated: false 2749 description: Resource identifier 2750 explode: false 2751 in: path 2752 name: id 2753 required: true 2754 schema: 2755 type: string 2756 style: simple 2757 requestBody: 2758 content: 2759 application/json: 2760 schema: {} 2761 description: No Request Body 2762 required: false 2763 responses: 2764 "204": 2765 description: service_component_variable resource deleted 2766 "404": 2767 description: Resource not found 2768 "4XX": 2769 content: 2770 application/problem+json: 2771 schema: 2772 $ref: '#/components/schemas/problem.generic' 2773 description: Request Error 2774 summary: Delete a specific component variable. 2775 tags: 2776 - service_component_variable 2777 get: 2778 deprecated: false 2779 description: View a specific component variable. 2780 operationId: Service_component_variableView 2781 parameters: 2782 - allowReserved: false 2783 deprecated: false 2784 description: Resource identifier 2785 explode: false 2786 in: path 2787 name: id 2788 required: true 2789 schema: 2790 type: string 2791 style: simple 2792 responses: 2793 "200": 2794 content: 2795 application/hal+json: 2796 schema: 2797 $ref: '#/components/schemas/service_component_variable-item' 2798 description: service_component_variable resource 2799 "404": 2800 description: Resource not found 2801 "4XX": 2802 content: 2803 application/problem+json: 2804 schema: 2805 $ref: '#/components/schemas/problem.generic' 2806 description: Request Error 2807 summary: View a specific component variable. 2808 tags: 2809 - service_component_variable 2810 patch: 2811 deprecated: false 2812 description: Edit a specific component variable. 2813 operationId: Service_component_variableEdit 2814 parameters: 2815 - allowReserved: false 2816 deprecated: false 2817 description: Resource identifier 2818 explode: false 2819 in: path 2820 name: id 2821 required: true 2822 schema: 2823 type: string 2824 style: simple 2825 requestBody: 2826 content: 2827 application/json: 2828 schema: 2829 $ref: '#/components/schemas/service_component_variable.EditAction' 2830 description: The updated service_component_variable resource 2831 required: true 2832 responses: 2833 "200": 2834 content: 2835 application/hal+json: 2836 schema: 2837 $ref: '#/components/schemas/service_component_variable-item' 2838 description: service_component_variable resource updated 2839 "400": 2840 description: Invalid input 2841 "422": 2842 description: Unprocessable entity 2843 "404": 2844 description: Resource not found 2845 "4XX": 2846 content: 2847 application/problem+json: 2848 schema: 2849 $ref: '#/components/schemas/problem.generic' 2850 description: Request Error 2851 summary: Edit a specific component variable. 2852 tags: 2853 - service_component_variable 2854 /v1/templates: 2855 get: 2856 deprecated: false 2857 description: List templates matching any selected filters. 2858 operationId: TemplateList 2859 parameters: 2860 - allowEmptyValue: true 2861 allowReserved: false 2862 deprecated: false 2863 description: The collection page number 2864 explode: false 2865 in: query 2866 name: page 2867 required: false 2868 schema: 2869 default: 1 2870 type: integer 2871 style: form 2872 - allowEmptyValue: false 2873 allowReserved: false 2874 deprecated: false 2875 description: Filter by organization 2876 explode: false 2877 in: query 2878 name: organization 2879 required: false 2880 schema: 2881 type: string 2882 style: form 2883 - allowEmptyValue: false 2884 allowReserved: false 2885 deprecated: false 2886 description: Filter by templatesRepository 2887 explode: false 2888 in: query 2889 name: templatesRepository 2890 required: false 2891 schema: 2892 type: string 2893 style: form 2894 - allowEmptyValue: false 2895 allowReserved: false 2896 deprecated: false 2897 description: |- 2898 Filter used to fetch templates by source. 2899 * `public` - contains Bunnyshell curated templates 2900 * `private` - contains your organizations templates 2901 * `all` - contains templates for every source 2902 example: all 2903 explode: false 2904 in: query 2905 name: source 2906 required: false 2907 schema: 2908 enum: 2909 - all 2910 - public 2911 - private 2912 type: string 2913 style: form 2914 - allowEmptyValue: false 2915 allowReserved: false 2916 deprecated: false 2917 description: Filter by search 2918 explode: false 2919 in: query 2920 name: search 2921 required: false 2922 schema: 2923 type: string 2924 style: form 2925 responses: 2926 "200": 2927 content: 2928 application/hal+json: 2929 schema: 2930 $ref: '#/components/schemas/paginated-template-collection' 2931 description: template collection 2932 "4XX": 2933 content: 2934 application/problem+json: 2935 schema: 2936 $ref: '#/components/schemas/problem.generic' 2937 description: Request Error 2938 summary: List templates matching any selected filters. 2939 tags: 2940 - template 2941 /v1/templates/validate: 2942 post: 2943 deprecated: false 2944 description: Validates a given template from an external source. 2945 operationId: TemplateValidate 2946 parameters: [] 2947 requestBody: 2948 content: 2949 application/json: 2950 schema: 2951 $ref: '#/components/schemas/template.ValidateAction' 2952 description: The new template resource 2953 required: true 2954 responses: 2955 "204": 2956 content: 2957 application/hal+json: 2958 schema: 2959 $ref: '#/components/schemas/template-collection' 2960 description: template resource created 2961 "400": 2962 description: Invalid input 2963 "422": 2964 description: Unprocessable entity 2965 "4XX": 2966 content: 2967 application/problem+json: 2968 schema: 2969 $ref: '#/components/schemas/problem.generic' 2970 description: Request Error 2971 summary: Validates a given template from an external source. 2972 tags: 2973 - template 2974 /v1/templates/{id}: 2975 get: 2976 deprecated: false 2977 description: View a specific template. 2978 operationId: TemplateView 2979 parameters: 2980 - allowReserved: false 2981 deprecated: false 2982 description: Resource identifier 2983 explode: false 2984 in: path 2985 name: id 2986 required: true 2987 schema: 2988 type: string 2989 style: simple 2990 responses: 2991 "200": 2992 content: 2993 application/hal+json: 2994 schema: 2995 $ref: '#/components/schemas/template-item' 2996 description: template resource 2997 "404": 2998 description: Resource not found 2999 "4XX": 3000 content: 3001 application/problem+json: 3002 schema: 3003 $ref: '#/components/schemas/problem.generic' 3004 description: Request Error 3005 summary: View a specific template. 3006 tags: 3007 - template 3008 /v1/templates/{id}/definition: 3009 get: 3010 deprecated: false 3011 description: View the environment definition. 3012 operationId: TemplateDefinition 3013 parameters: 3014 - allowReserved: false 3015 deprecated: false 3016 description: Resource identifier 3017 explode: false 3018 in: path 3019 name: id 3020 required: true 3021 schema: 3022 type: string 3023 style: simple 3024 responses: 3025 "200": 3026 content: 3027 application/x+yaml: 3028 schema: 3029 $ref: '#/components/schemas/template.GenericObject' 3030 description: template resource 3031 "404": 3032 description: Resource not found 3033 "4XX": 3034 content: 3035 application/problem+json: 3036 schema: 3037 $ref: '#/components/schemas/problem.generic' 3038 description: Request Error 3039 summary: View the environment definition. 3040 tags: 3041 - template 3042 /v1/templates_repositories: 3043 get: 3044 deprecated: false 3045 description: List templates repositories matching any selected filters. 3046 operationId: Templates_repositoryList 3047 parameters: 3048 - allowEmptyValue: true 3049 allowReserved: false 3050 deprecated: false 3051 description: The collection page number 3052 explode: false 3053 in: query 3054 name: page 3055 required: false 3056 schema: 3057 default: 1 3058 type: integer 3059 style: form 3060 - allowEmptyValue: false 3061 allowReserved: false 3062 deprecated: false 3063 description: Filter by organization 3064 explode: false 3065 in: query 3066 name: organization 3067 required: false 3068 schema: 3069 type: string 3070 style: form 3071 responses: 3072 "200": 3073 content: 3074 application/hal+json: 3075 schema: 3076 $ref: '#/components/schemas/paginated-templates_repository-collection' 3077 description: templates_repository collection 3078 "4XX": 3079 content: 3080 application/problem+json: 3081 schema: 3082 $ref: '#/components/schemas/problem.generic' 3083 description: Request Error 3084 summary: List templates repositories matching any selected filters. 3085 tags: 3086 - templates_repository 3087 /v1/templates_repositories/{id}: 3088 get: 3089 deprecated: false 3090 description: View a specific templates repository. 3091 operationId: Templates_repositoryView 3092 parameters: 3093 - allowReserved: false 3094 deprecated: false 3095 description: Resource identifier 3096 explode: false 3097 in: path 3098 name: id 3099 required: true 3100 schema: 3101 type: string 3102 style: simple 3103 responses: 3104 "200": 3105 content: 3106 application/hal+json: 3107 schema: 3108 $ref: '#/components/schemas/templates_repository-item' 3109 description: templates_repository resource 3110 "404": 3111 description: Resource not found 3112 "4XX": 3113 content: 3114 application/problem+json: 3115 schema: 3116 $ref: '#/components/schemas/problem.generic' 3117 description: Request Error 3118 summary: View a specific templates repository. 3119 tags: 3120 - templates_repository 3121 /v1/workflows: 3122 get: 3123 deprecated: false 3124 description: List workflows matching any selected filters. 3125 operationId: WorkflowList 3126 parameters: 3127 - allowEmptyValue: true 3128 allowReserved: false 3129 deprecated: false 3130 description: The collection page number 3131 explode: false 3132 in: query 3133 name: page 3134 required: false 3135 schema: 3136 default: 1 3137 type: integer 3138 style: form 3139 - allowEmptyValue: false 3140 allowReserved: false 3141 deprecated: false 3142 description: Filter by event 3143 explode: false 3144 in: query 3145 name: event 3146 required: false 3147 schema: 3148 type: string 3149 style: form 3150 - allowEmptyValue: false 3151 allowReserved: false 3152 deprecated: false 3153 description: Filter by environment 3154 explode: false 3155 in: query 3156 name: environment 3157 required: false 3158 schema: 3159 type: string 3160 style: form 3161 - allowEmptyValue: false 3162 allowReserved: false 3163 deprecated: false 3164 description: Filter by organization 3165 explode: false 3166 in: query 3167 name: organization 3168 required: false 3169 schema: 3170 type: string 3171 style: form 3172 - allowEmptyValue: false 3173 allowReserved: false 3174 deprecated: false 3175 description: Filter by status 3176 example: queued 3177 explode: false 3178 in: query 3179 name: status 3180 required: false 3181 schema: 3182 enum: 3183 - queued 3184 - in_progress 3185 - success 3186 - failing 3187 - failed 3188 - aborting 3189 - aborted 3190 type: string 3191 style: form 3192 responses: 3193 "200": 3194 content: 3195 application/hal+json: 3196 schema: 3197 $ref: '#/components/schemas/paginated-workflow-collection' 3198 description: workflow collection 3199 "4XX": 3200 content: 3201 application/problem+json: 3202 schema: 3203 $ref: '#/components/schemas/problem.generic' 3204 description: Request Error 3205 summary: List workflows matching any selected filters. 3206 tags: 3207 - workflow 3208 /v1/workflows/{id}: 3209 get: 3210 deprecated: false 3211 description: View a specific Workflow. 3212 operationId: WorkflowView 3213 parameters: 3214 - allowReserved: false 3215 deprecated: false 3216 description: Resource identifier 3217 explode: false 3218 in: path 3219 name: id 3220 required: true 3221 schema: 3222 type: string 3223 style: simple 3224 responses: 3225 "200": 3226 content: 3227 application/hal+json: 3228 schema: 3229 $ref: '#/components/schemas/workflow-item' 3230 description: workflow resource 3231 "404": 3232 description: Resource not found 3233 "4XX": 3234 content: 3235 application/problem+json: 3236 schema: 3237 $ref: '#/components/schemas/problem.generic' 3238 description: Request Error 3239 summary: View a specific Workflow. 3240 tags: 3241 - workflow 3242 components: 3243 examples: {} 3244 headers: {} 3245 parameters: {} 3246 requestBodies: {} 3247 responses: {} 3248 schemas: 3249 ArrayObject-kube-config.read: 3250 type: object 3251 BooleanType-item: 3252 properties: 3253 defaultValue: 3254 $ref: '#/components/schemas/BooleanValue-item' 3255 name: 3256 description: A variable used within the template. 3257 type: string 3258 description: 3259 description: The variable description 3260 type: string 3261 type: 3262 readOnly: true 3263 type: string 3264 type: object 3265 BooleanValue-item: 3266 properties: 3267 value: 3268 type: boolean 3269 type: 3270 readOnly: true 3271 type: string 3272 type: object 3273 BuildSettings-item: 3274 properties: 3275 useManagedRegistry: 3276 description: Use the managed container registry. 3277 type: boolean 3278 registryIntegration: 3279 description: The Container Registry used for the built images. 3280 nullable: true 3281 type: string 3282 useManagedCluster: 3283 description: Use the managed builds Cluster. 3284 type: boolean 3285 kubernetesIntegration: 3286 description: The Kubernetes integration cluster used for the image builds. 3287 nullable: true 3288 type: string 3289 cpu: 3290 description: The CPU allocated for the build runner. 3291 nullable: true 3292 type: string 3293 memory: 3294 description: The memory allocated for the build runner. 3295 nullable: true 3296 type: integer 3297 lastStatus: 3298 description: The latest status of the build settings. 3299 nullable: true 3300 type: string 3301 lastError: 3302 description: The latest status of the build settings. 3303 nullable: true 3304 type: string 3305 type: object 3306 Cluster-kube-config.read: 3307 properties: 3308 certificate-authority-data: 3309 type: string 3310 server: 3311 type: string 3312 required: 3313 - certificate-authority-data 3314 - server 3315 type: object 3316 ClusterWrapper-kube-config.read: 3317 properties: 3318 name: 3319 type: string 3320 cluster: 3321 $ref: '#/components/schemas/Cluster-kube-config.read' 3322 required: 3323 - cluster 3324 - name 3325 type: object 3326 ContainerConfig-item: 3327 properties: 3328 profile: 3329 $ref: '#/components/schemas/ContainerConfig_item_profile' 3330 type: object 3331 Context-kube-config.read: 3332 properties: 3333 cluster: 3334 type: string 3335 namespace: 3336 type: string 3337 user: 3338 type: string 3339 required: 3340 - cluster 3341 - user 3342 type: object 3343 ContextWrapper-kube-config.read: 3344 properties: 3345 name: 3346 type: string 3347 context: 3348 $ref: '#/components/schemas/Context-kube-config.read' 3349 required: 3350 - name 3351 type: object 3352 Edit: 3353 properties: 3354 values: 3355 additionalProperties: 3356 type: string 3357 type: object 3358 strategy: 3359 default: merge 3360 enum: 3361 - merge 3362 - replace 3363 example: merge 3364 type: string 3365 type: object 3366 EnumType-item: 3367 properties: 3368 defaultValue: 3369 $ref: '#/components/schemas/EnumType_item_defaultValue' 3370 values: 3371 description: The available values for the enum. 3372 items: 3373 $ref: '#/components/schemas/EnumType_item_values_inner' 3374 type: array 3375 name: 3376 description: A variable used within the template. 3377 type: string 3378 description: 3379 description: The variable description 3380 type: string 3381 type: 3382 readOnly: true 3383 type: string 3384 type: object 3385 Ephemeral: 3386 properties: 3387 type: 3388 default: ephemeral 3389 example: ephemeral 3390 type: string 3391 type: object 3392 ExtendedResourceConfig-item: 3393 properties: 3394 extended: 3395 readOnly: true 3396 type: boolean 3397 namespace: 3398 description: The resource namespace. 3399 readOnly: true 3400 type: string 3401 kind: 3402 description: The resource kind. 3403 readOnly: true 3404 type: string 3405 name: 3406 description: The resource name. 3407 readOnly: true 3408 type: string 3409 containers: 3410 additionalProperties: 3411 $ref: '#/components/schemas/ContainerConfig-item' 3412 description: A list of container configs. 3413 readOnly: true 3414 type: object 3415 type: object 3416 FilterGit: 3417 properties: 3418 type: 3419 default: git 3420 example: git 3421 type: string 3422 repository: 3423 nullable: true 3424 type: string 3425 branch: 3426 nullable: true 3427 type: string 3428 type: object 3429 FilterName: 3430 properties: 3431 type: 3432 default: name 3433 example: name 3434 type: string 3435 name: 3436 nullable: true 3437 type: string 3438 type: object 3439 FloatType-item: 3440 properties: 3441 defaultValue: 3442 $ref: '#/components/schemas/FloatValue-item' 3443 name: 3444 description: A variable used within the template. 3445 type: string 3446 description: 3447 description: The variable description 3448 type: string 3449 type: 3450 readOnly: true 3451 type: string 3452 type: object 3453 FloatValue-item: 3454 properties: 3455 value: 3456 type: number 3457 type: 3458 readOnly: true 3459 type: string 3460 type: object 3461 FromGit: 3462 properties: 3463 type: 3464 default: git 3465 example: git 3466 type: string 3467 url: 3468 type: string 3469 branch: 3470 type: string 3471 yamlPath: 3472 type: string 3473 type: object 3474 FromGitSpec: 3475 properties: 3476 type: 3477 default: git-spec 3478 example: git-spec 3479 type: string 3480 spec: 3481 type: string 3482 type: object 3483 FromString: 3484 properties: 3485 type: 3486 default: string 3487 example: string 3488 type: string 3489 yaml: 3490 type: string 3491 type: object 3492 FromTemplate: 3493 properties: 3494 type: 3495 default: template 3496 example: template 3497 type: string 3498 variables: 3499 additionalProperties: 3500 $ref: '#/components/schemas/FromTemplate_variables_value' 3501 type: object 3502 template: 3503 type: string 3504 type: object 3505 GitInfo: 3506 properties: 3507 repository: 3508 nullable: true 3509 type: string 3510 branch: 3511 nullable: true 3512 type: string 3513 type: object 3514 IntegerType-item: 3515 properties: 3516 defaultValue: 3517 $ref: '#/components/schemas/IntegerValue-item' 3518 name: 3519 description: A variable used within the template. 3520 type: string 3521 description: 3522 description: The variable description 3523 type: string 3524 type: 3525 readOnly: true 3526 type: string 3527 type: object 3528 IntegerValue-item: 3529 properties: 3530 value: 3531 type: integer 3532 type: 3533 readOnly: true 3534 type: string 3535 type: object 3536 Primary: 3537 properties: 3538 type: 3539 default: primary 3540 example: primary 3541 type: string 3542 autoDeployEphemeral: 3543 nullable: true 3544 type: boolean 3545 createEphemeralOnPrCreate: 3546 nullable: true 3547 type: boolean 3548 destroyEphemeralOnPrClose: 3549 nullable: true 3550 type: boolean 3551 ephemeralKubernetesIntegration: 3552 nullable: true 3553 type: string 3554 required: 3555 - ephemeralKubernetesIntegration 3556 type: object 3557 Profile-item: 3558 properties: 3559 command: 3560 description: The command to be run when starting the container. 3561 items: 3562 type: string 3563 readOnly: true 3564 type: array 3565 portMapping: 3566 description: The port mapping for the container. 3567 items: 3568 type: string 3569 readOnly: true 3570 type: array 3571 environ: 3572 additionalProperties: 3573 type: string 3574 description: The environ for the container. 3575 readOnly: true 3576 type: object 3577 syncPaths: 3578 description: The sync paths for the container. 3579 items: 3580 $ref: '#/components/schemas/SyncPath-item' 3581 readOnly: true 3582 type: array 3583 requirements: 3584 $ref: '#/components/schemas/ResourceRequirement-item' 3585 type: object 3586 ResourceList-item: 3587 example: 3588 memory: memory 3589 cpu: cpu 3590 properties: 3591 cpu: 3592 description: The CPU resources for the container. 3593 nullable: true 3594 readOnly: true 3595 type: string 3596 memory: 3597 description: The Memory resources for the container. 3598 nullable: true 3599 readOnly: true 3600 type: string 3601 type: object 3602 ResourceRequirement-item: 3603 example: 3604 requests: 3605 memory: memory 3606 cpu: cpu 3607 limits: 3608 memory: memory 3609 cpu: cpu 3610 properties: 3611 requests: 3612 $ref: '#/components/schemas/ResourceList-item' 3613 limits: 3614 $ref: '#/components/schemas/ResourceList-item' 3615 type: object 3616 SimpleResourceConfig-item: 3617 properties: 3618 simple: 3619 readOnly: true 3620 type: boolean 3621 containers: 3622 additionalProperties: 3623 $ref: '#/components/schemas/ContainerConfig-item' 3624 description: A list of container configs. 3625 readOnly: true 3626 type: object 3627 type: object 3628 Stage-item: 3629 properties: 3630 id: 3631 description: Stage identifier. 3632 readOnly: true 3633 type: string 3634 name: 3635 description: Stage name. 3636 readOnly: true 3637 type: string 3638 status: 3639 description: Stage status. 3640 readOnly: true 3641 type: string 3642 duration: 3643 description: Stage duration. 3644 nullable: true 3645 readOnly: true 3646 type: integer 3647 jobsCount: 3648 description: Stage total jobs. 3649 readOnly: true 3650 type: integer 3651 completedJobsCount: 3652 description: Stage completed jobs. 3653 readOnly: true 3654 type: integer 3655 pipeline: 3656 description: Event identifier. 3657 readOnly: true 3658 type: string 3659 type: object 3660 StringType-item: 3661 properties: 3662 defaultValue: 3663 $ref: '#/components/schemas/StringValue-item' 3664 name: 3665 description: A variable used within the template. 3666 type: string 3667 description: 3668 description: The variable description 3669 type: string 3670 type: 3671 readOnly: true 3672 type: string 3673 type: object 3674 StringValue-item: 3675 properties: 3676 value: 3677 type: string 3678 type: 3679 readOnly: true 3680 type: string 3681 type: object 3682 SyncPath-item: 3683 example: 3684 remotePath: remotePath 3685 localPath: localPath 3686 properties: 3687 localPath: 3688 description: The local path on the host os to sync from. 3689 nullable: true 3690 readOnly: true 3691 type: string 3692 remotePath: 3693 description: The remote path on the container to sync to. 3694 readOnly: true 3695 type: string 3696 type: object 3697 User-kube-config.read: 3698 properties: 3699 token: 3700 type: string 3701 client-certificate-data: 3702 type: string 3703 client-key-data: 3704 type: string 3705 type: object 3706 UserWrapper-kube-config.read: 3707 properties: 3708 name: 3709 type: string 3710 user: 3711 $ref: '#/components/schemas/User-kube-config.read' 3712 required: 3713 - name 3714 - user 3715 type: object 3716 ValidateSourceGit: 3717 properties: 3718 type: 3719 default: git 3720 example: git 3721 type: string 3722 url: 3723 externalDocs: 3724 url: http://schema.org/url 3725 maxLength: 255 3726 type: string 3727 ref: 3728 maxLength: 255 3729 type: string 3730 dirPath: 3731 maxLength: 255 3732 type: string 3733 organizationId: 3734 type: string 3735 validateComponents: 3736 type: boolean 3737 required: 3738 - dirPath 3739 - organizationId 3740 - ref 3741 - url 3742 type: object 3743 ValidateSourceString: 3744 properties: 3745 type: 3746 default: string 3747 example: string 3748 type: string 3749 bunnyshellYaml: 3750 type: string 3751 templateYaml: 3752 type: string 3753 validateComponents: 3754 type: boolean 3755 validateForOrganizationId: 3756 nullable: true 3757 type: string 3758 required: 3759 - bunnyshellYaml 3760 - templateYaml 3761 type: object 3762 component-collection: 3763 description: A service component represents either an application or a group 3764 of applications as a single unit 3765 properties: 3766 id: 3767 description: Service component identifier 3768 readOnly: true 3769 type: string 3770 name: 3771 description: Service component name 3772 readOnly: true 3773 type: string 3774 clusterStatus: 3775 description: Service component cluster status 3776 readOnly: true 3777 type: string 3778 operationStatus: 3779 description: Service component operation status 3780 readOnly: true 3781 type: string 3782 environment: 3783 description: Environment identifier. 3784 readOnly: true 3785 type: string 3786 type: object 3787 component-item: 3788 description: A service component represents either an application or a group 3789 of applications as a single unit 3790 properties: 3791 id: 3792 description: Service component identifier 3793 readOnly: true 3794 type: string 3795 name: 3796 description: Service component name 3797 readOnly: true 3798 type: string 3799 clusterStatus: 3800 description: Service component cluster status 3801 readOnly: true 3802 type: string 3803 operationStatus: 3804 description: Service component operation status 3805 readOnly: true 3806 type: string 3807 publicURLs: 3808 description: Service component URLs 3809 items: 3810 type: string 3811 readOnly: true 3812 type: array 3813 environment: 3814 description: Environment identifier. 3815 readOnly: true 3816 type: string 3817 type: object 3818 component.Config-item: 3819 description: A service component represents either an application or a group 3820 of applications as a single unit 3821 example: 3822 config: null 3823 properties: 3824 config: 3825 $ref: '#/components/schemas/component_Config_item_config' 3826 type: object 3827 component.Profile-item: 3828 description: A service component represents either an application or a group 3829 of applications as a single unit 3830 example: 3831 portMapping: 3832 - portMapping 3833 - portMapping 3834 requirements: 3835 requests: 3836 memory: memory 3837 cpu: cpu 3838 limits: 3839 memory: memory 3840 cpu: cpu 3841 syncPaths: 3842 - remotePath: remotePath 3843 localPath: localPath 3844 - remotePath: remotePath 3845 localPath: localPath 3846 command: 3847 - command 3848 - command 3849 environ: 3850 key: environ 3851 properties: 3852 command: 3853 description: The command to be run when starting the container. 3854 items: 3855 type: string 3856 readOnly: true 3857 type: array 3858 portMapping: 3859 description: The port mapping for the container. 3860 items: 3861 type: string 3862 readOnly: true 3863 type: array 3864 environ: 3865 additionalProperties: 3866 type: string 3867 description: The environ for the container. 3868 readOnly: true 3869 type: object 3870 syncPaths: 3871 description: The sync paths for the container. 3872 items: 3873 $ref: '#/components/schemas/SyncPath-item' 3874 readOnly: true 3875 type: array 3876 requirements: 3877 $ref: '#/components/schemas/ResourceRequirement-item' 3878 type: object 3879 component.Resource-item: 3880 description: A service component represents either an application or a group 3881 of applications as a single unit 3882 example: 3883 kind: kind 3884 name: name 3885 namespace: namespace 3886 properties: 3887 kind: 3888 description: Kubernetes resource kind. 3889 type: string 3890 name: 3891 description: Kubernetes resource name. 3892 type: string 3893 namespace: 3894 description: Kubernetes resource namespace. 3895 nullable: true 3896 type: string 3897 type: object 3898 componentEndpoint-collection: 3899 description: Endpoint 3900 properties: 3901 id: 3902 description: Service component identifier 3903 readOnly: true 3904 type: string 3905 name: 3906 description: Service component name 3907 readOnly: true 3908 type: string 3909 endpoints: 3910 description: Service component URLs 3911 items: 3912 type: string 3913 readOnly: true 3914 type: array 3915 environment: 3916 description: Environment identifier. 3917 readOnly: true 3918 type: string 3919 type: object 3920 componentEndpoint-item: 3921 description: Endpoint 3922 properties: 3923 id: 3924 description: Service component identifier 3925 readOnly: true 3926 type: string 3927 name: 3928 description: Service component name 3929 readOnly: true 3930 type: string 3931 endpoints: 3932 description: Service component URLs 3933 items: 3934 type: string 3935 readOnly: true 3936 type: array 3937 environment: 3938 description: Environment identifier. 3939 readOnly: true 3940 type: string 3941 type: object 3942 componentGit-collection: 3943 description: Git info 3944 properties: 3945 id: 3946 description: Service component identifier 3947 readOnly: true 3948 type: string 3949 name: 3950 description: Service component name 3951 readOnly: true 3952 type: string 3953 repository: 3954 description: Git repository 3955 readOnly: true 3956 type: string 3957 refName: 3958 description: Git ref name 3959 readOnly: true 3960 type: string 3961 path: 3962 description: Git application path 3963 nullable: true 3964 readOnly: true 3965 type: string 3966 refSha: 3967 description: Git ref sha 3968 nullable: true 3969 readOnly: true 3970 type: string 3971 deployedSha: 3972 description: Git deployed sha 3973 nullable: true 3974 readOnly: true 3975 type: string 3976 environment: 3977 description: Environment identifier. 3978 readOnly: true 3979 type: string 3980 type: object 3981 componentGit-item: 3982 description: Git info 3983 properties: 3984 id: 3985 description: Service component identifier 3986 readOnly: true 3987 type: string 3988 name: 3989 description: Service component name 3990 readOnly: true 3991 type: string 3992 repository: 3993 description: Git repository 3994 readOnly: true 3995 type: string 3996 refName: 3997 description: Git ref name 3998 readOnly: true 3999 type: string 4000 path: 4001 description: Git application path 4002 nullable: true 4003 readOnly: true 4004 type: string 4005 refSha: 4006 description: Git ref sha 4007 nullable: true 4008 readOnly: true 4009 type: string 4010 deployedSha: 4011 description: Git deployed sha 4012 nullable: true 4013 readOnly: true 4014 type: string 4015 environment: 4016 description: Environment identifier. 4017 readOnly: true 4018 type: string 4019 type: object 4020 environment-collection: 4021 description: An environment holds a collection of buildable and deployable components. 4022 properties: 4023 id: 4024 description: Environment identifier. 4025 readOnly: true 4026 type: string 4027 type: 4028 description: "Environment type: primary or ephemeral." 4029 readOnly: true 4030 type: string 4031 name: 4032 description: Environment name. 4033 readOnly: true 4034 type: string 4035 namespace: 4036 description: Environment k8s namespace. 4037 readOnly: true 4038 type: string 4039 operationStatus: 4040 description: Environment operation status. 4041 readOnly: true 4042 type: string 4043 clusterStatus: 4044 description: Environment cluster status. 4045 readOnly: true 4046 type: string 4047 project: 4048 description: Project identifier. 4049 readOnly: true 4050 type: string 4051 kubernetesIntegration: 4052 description: Kubernetes integration identifier. 4053 nullable: true 4054 readOnly: true 4055 type: string 4056 ephemeralKubernetesIntegration: 4057 description: Kubernetes integration identifier for the ephemeral auto deploy 4058 cluster. 4059 nullable: true 4060 readOnly: true 4061 type: string 4062 hasEphemeralAutoDeploy: 4063 description: Environment ephemeral auto deploy status. 4064 readOnly: true 4065 type: boolean 4066 hasEphemeralCreateOnPr: 4067 description: Environment ephemeral create-on-PR status. 4068 readOnly: true 4069 type: boolean 4070 hasEphemeralDestroyOnPrClose: 4071 description: Environment ephemeral destroy-on-PR close status. 4072 readOnly: true 4073 type: boolean 4074 type: object 4075 environment-item: 4076 description: An environment holds a collection of buildable and deployable components. 4077 properties: 4078 id: 4079 description: Environment identifier. 4080 readOnly: true 4081 type: string 4082 labels: 4083 additionalProperties: 4084 type: string 4085 description: Environment labels. 4086 readOnly: true 4087 type: object 4088 type: 4089 description: "Environment type: primary or ephemeral." 4090 readOnly: true 4091 type: string 4092 name: 4093 description: Environment name. 4094 readOnly: true 4095 type: string 4096 namespace: 4097 description: Environment k8s namespace. 4098 readOnly: true 4099 type: string 4100 totalComponents: 4101 description: Service component identifier 4102 readOnly: true 4103 type: integer 4104 operationStatus: 4105 description: Environment operation status. 4106 readOnly: true 4107 type: string 4108 clusterStatus: 4109 description: Environment cluster status. 4110 readOnly: true 4111 type: string 4112 buildSettings: 4113 $ref: '#/components/schemas/BuildSettings-item' 4114 project: 4115 description: Project identifier. 4116 readOnly: true 4117 type: string 4118 kubernetesIntegration: 4119 description: Kubernetes integration identifier. 4120 nullable: true 4121 readOnly: true 4122 type: string 4123 ephemeralKubernetesIntegration: 4124 description: Kubernetes integration identifier for the ephemeral auto deploy 4125 cluster. 4126 nullable: true 4127 readOnly: true 4128 type: string 4129 hasEphemeralAutoDeploy: 4130 description: Environment ephemeral auto deploy status. 4131 readOnly: true 4132 type: boolean 4133 hasEphemeralCreateOnPr: 4134 description: Environment ephemeral create-on-PR status. 4135 readOnly: true 4136 type: boolean 4137 hasEphemeralDestroyOnPrClose: 4138 description: Environment ephemeral destroy-on-PR close status. 4139 readOnly: true 4140 type: boolean 4141 type: object 4142 environment.CloneAction: 4143 description: An environment holds a collection of buildable and deployable components. 4144 properties: 4145 name: 4146 maxLength: 255 4147 type: string 4148 required: 4149 - name 4150 type: object 4151 environment.CreateAction: 4152 description: An environment holds a collection of buildable and deployable components. 4153 properties: 4154 name: 4155 maxLength: 255 4156 type: string 4157 project: 4158 type: string 4159 genesis: 4160 $ref: '#/components/schemas/environment_CreateAction_genesis' 4161 type: 4162 type: string 4163 remoteDevelopmentAllowed: 4164 type: boolean 4165 autoUpdate: 4166 type: boolean 4167 createEphemeralOnPrCreate: 4168 type: boolean 4169 destroyEphemeralOnPrClose: 4170 type: boolean 4171 autoDeployEphemeral: 4172 type: boolean 4173 kubernetesIntegration: 4174 nullable: true 4175 type: string 4176 ephemeralKubernetesIntegration: 4177 nullable: true 4178 type: string 4179 labels: 4180 additionalProperties: 4181 type: string 4182 type: object 4183 required: 4184 - name 4185 - project 4186 type: object 4187 environment.EditBuildSettingsAction: 4188 description: An environment holds a collection of buildable and deployable components. 4189 properties: 4190 useManagedRegistry: 4191 nullable: true 4192 type: boolean 4193 registryIntegration: 4194 nullable: true 4195 type: string 4196 useManagedCluster: 4197 nullable: true 4198 type: boolean 4199 kubernetesIntegration: 4200 nullable: true 4201 type: string 4202 cpu: 4203 description: K8s supports decimal values with step 0.001 That's why we are 4204 using decimal. 4205 nullable: true 4206 type: string 4207 memory: 4208 description: expressed in Mi 4209 nullable: true 4210 type: integer 4211 timeoutSeconds: 4212 nullable: true 4213 type: integer 4214 required: 4215 - cpu 4216 - kubernetesIntegration 4217 - memory 4218 - registryIntegration 4219 - timeoutSeconds 4220 type: object 4221 environment.EditComponentsAction: 4222 description: An environment holds a collection of buildable and deployable components. 4223 properties: 4224 filter: 4225 $ref: '#/components/schemas/environment_EditComponentsAction_filter' 4226 target: 4227 $ref: '#/components/schemas/GitInfo' 4228 required: 4229 - filter 4230 - target 4231 type: object 4232 environment.EditConfiguration: 4233 description: An environment holds a collection of buildable and deployable components. 4234 properties: 4235 configuration: 4236 $ref: '#/components/schemas/environment_EditConfiguration_configuration' 4237 type: object 4238 environment.EditSettings: 4239 description: An environment holds a collection of buildable and deployable components. 4240 properties: 4241 name: 4242 maxLength: 255 4243 nullable: true 4244 type: string 4245 remoteDevelopmentAllowed: 4246 nullable: true 4247 type: boolean 4248 autoUpdate: 4249 nullable: true 4250 type: boolean 4251 kubernetesIntegration: 4252 nullable: true 4253 type: string 4254 edit: 4255 $ref: '#/components/schemas/environment_EditSettings_edit' 4256 labels: 4257 $ref: '#/components/schemas/Edit' 4258 type: object 4259 environment.GenericObject: 4260 description: An environment holds a collection of buildable and deployable components. 4261 type: object 4262 environment.KubeConfig-kube-config.read: 4263 description: An environment holds a collection of buildable and deployable components. 4264 properties: 4265 apiVersion: 4266 default: v1 4267 example: v1 4268 type: string 4269 kind: 4270 default: Config 4271 example: Config 4272 type: string 4273 preferences: 4274 type: object 4275 clusters: 4276 items: 4277 $ref: '#/components/schemas/ClusterWrapper-kube-config.read' 4278 type: array 4279 users: 4280 items: 4281 $ref: '#/components/schemas/UserWrapper-kube-config.read' 4282 type: array 4283 contexts: 4284 items: 4285 $ref: '#/components/schemas/ContextWrapper-kube-config.read' 4286 type: array 4287 current-context: 4288 type: string 4289 required: 4290 - clusters 4291 - users 4292 type: object 4293 environment.PartialAction: 4294 description: An environment holds a collection of buildable and deployable components. 4295 properties: 4296 isPartial: 4297 type: boolean 4298 components: 4299 items: 4300 type: string 4301 type: array 4302 type: object 4303 environment.PartialDeployAction: 4304 description: An environment holds a collection of buildable and deployable components. 4305 properties: 4306 includedDependencies: 4307 default: none 4308 example: none 4309 type: string 4310 isPartial: 4311 type: boolean 4312 components: 4313 items: 4314 type: string 4315 type: array 4316 type: object 4317 environment.PartialStartAction: 4318 description: An environment holds a collection of buildable and deployable components. 4319 properties: 4320 withDependencies: 4321 type: boolean 4322 isPartial: 4323 type: boolean 4324 components: 4325 items: 4326 type: string 4327 type: array 4328 type: object 4329 environment_variable-collection: 4330 description: An environment variable used during Bunnyshell workflows. 4331 properties: 4332 id: 4333 description: Environment variable identifier. 4334 readOnly: true 4335 type: string 4336 name: 4337 description: Environment variable name. 4338 readOnly: true 4339 type: string 4340 value: 4341 description: Environment variable value. 4342 nullable: true 4343 readOnly: true 4344 type: string 4345 secret: 4346 description: Environment variable marked as secret. 4347 readOnly: true 4348 type: boolean 4349 environment: 4350 description: Environment identifier. 4351 readOnly: true 4352 type: string 4353 organization: 4354 description: Organization identifier. 4355 readOnly: true 4356 type: string 4357 type: object 4358 environment_variable-item: 4359 description: An environment variable used during Bunnyshell workflows. 4360 properties: 4361 id: 4362 description: Environment variable identifier. 4363 readOnly: true 4364 type: string 4365 name: 4366 description: Environment variable name. 4367 readOnly: true 4368 type: string 4369 value: 4370 description: Environment variable value. 4371 nullable: true 4372 readOnly: true 4373 type: string 4374 secret: 4375 description: Environment variable marked as secret. 4376 readOnly: true 4377 type: boolean 4378 environment: 4379 description: Environment identifier. 4380 readOnly: true 4381 type: string 4382 organization: 4383 description: Organization identifier. 4384 readOnly: true 4385 type: string 4386 type: object 4387 environment_variable.CreateAction: 4388 description: An environment variable used during Bunnyshell workflows. 4389 properties: 4390 name: 4391 type: string 4392 value: 4393 type: string 4394 isSecret: 4395 nullable: true 4396 type: boolean 4397 environment: 4398 type: string 4399 required: 4400 - environment 4401 - name 4402 - value 4403 type: object 4404 environment_variable.EditAction: 4405 description: An environment variable used during Bunnyshell workflows. 4406 properties: 4407 value: 4408 nullable: true 4409 type: string 4410 isSecret: 4411 nullable: true 4412 type: boolean 4413 required: 4414 - value 4415 type: object 4416 event-collection: 4417 description: "An event represents an operation on an environment, integration\ 4418 \ or settings" 4419 properties: 4420 id: 4421 description: Event identifier. 4422 readOnly: true 4423 type: string 4424 type: 4425 description: Event type. 4426 readOnly: true 4427 type: string 4428 status: 4429 description: Event operation status. 4430 readOnly: true 4431 type: string 4432 environment: 4433 description: Environment identifier. 4434 nullable: true 4435 readOnly: true 4436 type: string 4437 organization: 4438 description: Organization identifier. 4439 readOnly: true 4440 type: string 4441 type: object 4442 event-item: 4443 description: "An event represents an operation on an environment, integration\ 4444 \ or settings" 4445 properties: 4446 id: 4447 description: Event identifier. 4448 readOnly: true 4449 type: string 4450 type: 4451 description: Event type. 4452 readOnly: true 4453 type: string 4454 status: 4455 description: Event operation status. 4456 readOnly: true 4457 type: string 4458 environment: 4459 description: Environment identifier. 4460 nullable: true 4461 readOnly: true 4462 type: string 4463 organization: 4464 description: Organization identifier. 4465 readOnly: true 4466 type: string 4467 createdAt: 4468 description: Event creation time. 4469 format: date-time 4470 readOnly: true 4471 type: string 4472 updatedAt: 4473 description: Event last update time. 4474 format: date-time 4475 readOnly: true 4476 type: string 4477 delegated: 4478 description: Event identifier. 4479 nullable: true 4480 readOnly: true 4481 type: string 4482 type: object 4483 kubernetes_integration-collection: 4484 description: A Kubernetes integration stores connection information for a Kubernetes 4485 cluster. 4486 properties: 4487 id: 4488 description: Kubernetes integration identifier. 4489 readOnly: true 4490 type: string 4491 clusterName: 4492 description: Kubernetes integration cluster name. 4493 readOnly: true 4494 type: string 4495 cloudName: 4496 description: Kubernetes integration cloud name. 4497 readOnly: true 4498 type: string 4499 cloudProvider: 4500 description: Kubernetes integration cluster provider. 4501 readOnly: true 4502 type: string 4503 status: 4504 description: Kubernetes integration status. 4505 readOnly: true 4506 type: string 4507 organization: 4508 description: Organization identifier. 4509 nullable: true 4510 readOnly: true 4511 type: string 4512 type: object 4513 kubernetes_integration-item: 4514 description: A Kubernetes integration stores connection information for a Kubernetes 4515 cluster. 4516 properties: 4517 id: 4518 description: Kubernetes integration identifier. 4519 readOnly: true 4520 type: string 4521 clusterName: 4522 description: Kubernetes integration cluster name. 4523 readOnly: true 4524 type: string 4525 cloudName: 4526 description: Kubernetes integration cloud name. 4527 readOnly: true 4528 type: string 4529 cloudProvider: 4530 description: Kubernetes integration cluster provider. 4531 readOnly: true 4532 type: string 4533 status: 4534 description: Kubernetes integration status. 4535 readOnly: true 4536 type: string 4537 organization: 4538 description: Organization identifier. 4539 nullable: true 4540 readOnly: true 4541 type: string 4542 type: object 4543 organization-collection: 4544 description: An organization holds multiple projects and all the integrations 4545 used by environments 4546 properties: 4547 id: 4548 description: Organization identifier. 4549 readOnly: true 4550 type: string 4551 name: 4552 description: Organization name as defined in Bunnyshell UI. 4553 readOnly: true 4554 type: string 4555 timezone: 4556 description: Organization timezone as defined in Bunnyshell UI. 4557 readOnly: true 4558 type: string 4559 type: object 4560 organization-item: 4561 description: An organization holds multiple projects and all the integrations 4562 used by environments 4563 properties: 4564 id: 4565 description: Organization identifier. 4566 readOnly: true 4567 type: string 4568 name: 4569 description: Organization name as defined in Bunnyshell UI. 4570 readOnly: true 4571 type: string 4572 timezone: 4573 description: Organization timezone as defined in Bunnyshell UI. 4574 readOnly: true 4575 type: string 4576 totalUsers: 4577 description: Organization total users. 4578 readOnly: true 4579 type: integer 4580 totalProjects: 4581 description: Organization total projects. 4582 readOnly: true 4583 type: integer 4584 availableRegistries: 4585 description: Organization total available registry integrations. 4586 readOnly: true 4587 type: integer 4588 availableClusters: 4589 description: Organization total available cluster integrations. 4590 readOnly: true 4591 type: integer 4592 availableGitIntegration: 4593 description: Organization total available git integrations. 4594 readOnly: true 4595 type: integer 4596 type: object 4597 paginated-component-collection: 4598 description: Paginated result 4599 properties: 4600 _links: 4601 $ref: '#/components/schemas/paginated_links' 4602 totalItems: 4603 format: int32 4604 type: integer 4605 page: 4606 format: int32 4607 type: integer 4608 itemsPerPage: 4609 format: int32 4610 type: integer 4611 _embedded: 4612 $ref: '#/components/schemas/embedded_component_collection' 4613 type: object 4614 paginated-componentEndpoint-collection: 4615 description: Paginated result 4616 properties: 4617 _links: 4618 $ref: '#/components/schemas/paginated_links' 4619 totalItems: 4620 format: int32 4621 type: integer 4622 page: 4623 format: int32 4624 type: integer 4625 itemsPerPage: 4626 format: int32 4627 type: integer 4628 _embedded: 4629 $ref: '#/components/schemas/embedded_componentEndpoint_collection' 4630 type: object 4631 paginated-componentGit-collection: 4632 description: Paginated result 4633 properties: 4634 _links: 4635 $ref: '#/components/schemas/paginated_links' 4636 totalItems: 4637 format: int32 4638 type: integer 4639 page: 4640 format: int32 4641 type: integer 4642 itemsPerPage: 4643 format: int32 4644 type: integer 4645 _embedded: 4646 $ref: '#/components/schemas/embedded_componentGit_collection' 4647 type: object 4648 paginated-environment-collection: 4649 description: Paginated result 4650 properties: 4651 _links: 4652 $ref: '#/components/schemas/paginated_links' 4653 totalItems: 4654 format: int32 4655 type: integer 4656 page: 4657 format: int32 4658 type: integer 4659 itemsPerPage: 4660 format: int32 4661 type: integer 4662 _embedded: 4663 $ref: '#/components/schemas/embedded_environment_collection' 4664 type: object 4665 paginated-environment_variable-collection: 4666 description: Paginated result 4667 properties: 4668 _links: 4669 $ref: '#/components/schemas/paginated_links' 4670 totalItems: 4671 format: int32 4672 type: integer 4673 page: 4674 format: int32 4675 type: integer 4676 itemsPerPage: 4677 format: int32 4678 type: integer 4679 _embedded: 4680 $ref: '#/components/schemas/embedded_environment_variable_collection' 4681 type: object 4682 paginated-event-collection: 4683 description: Paginated result 4684 properties: 4685 _links: 4686 $ref: '#/components/schemas/paginated_links' 4687 totalItems: 4688 format: int32 4689 type: integer 4690 page: 4691 format: int32 4692 type: integer 4693 itemsPerPage: 4694 format: int32 4695 type: integer 4696 _embedded: 4697 $ref: '#/components/schemas/embedded_event_collection' 4698 type: object 4699 paginated-kubernetes_integration-collection: 4700 description: Paginated result 4701 properties: 4702 _links: 4703 $ref: '#/components/schemas/paginated_links' 4704 totalItems: 4705 format: int32 4706 type: integer 4707 page: 4708 format: int32 4709 type: integer 4710 itemsPerPage: 4711 format: int32 4712 type: integer 4713 _embedded: 4714 $ref: '#/components/schemas/embedded_kubernetes_integration_collection' 4715 type: object 4716 paginated-organization-collection: 4717 description: Paginated result 4718 properties: 4719 _links: 4720 $ref: '#/components/schemas/paginated_links' 4721 totalItems: 4722 format: int32 4723 type: integer 4724 page: 4725 format: int32 4726 type: integer 4727 itemsPerPage: 4728 format: int32 4729 type: integer 4730 _embedded: 4731 $ref: '#/components/schemas/embedded_organization_collection' 4732 type: object 4733 paginated-pipeline-collection: 4734 description: Paginated result 4735 properties: 4736 _links: 4737 $ref: '#/components/schemas/paginated_links' 4738 totalItems: 4739 format: int32 4740 type: integer 4741 page: 4742 format: int32 4743 type: integer 4744 itemsPerPage: 4745 format: int32 4746 type: integer 4747 _embedded: 4748 $ref: '#/components/schemas/embedded_pipeline_collection' 4749 type: object 4750 paginated-project-collection: 4751 description: Paginated result 4752 properties: 4753 _links: 4754 $ref: '#/components/schemas/paginated_links' 4755 totalItems: 4756 format: int32 4757 type: integer 4758 page: 4759 format: int32 4760 type: integer 4761 itemsPerPage: 4762 format: int32 4763 type: integer 4764 _embedded: 4765 $ref: '#/components/schemas/embedded_project_collection' 4766 type: object 4767 paginated-project_variable-collection: 4768 description: Paginated result 4769 properties: 4770 _links: 4771 $ref: '#/components/schemas/paginated_links' 4772 totalItems: 4773 format: int32 4774 type: integer 4775 page: 4776 format: int32 4777 type: integer 4778 itemsPerPage: 4779 format: int32 4780 type: integer 4781 _embedded: 4782 $ref: '#/components/schemas/embedded_project_variable_collection' 4783 type: object 4784 paginated-registry_integration-collection: 4785 description: Paginated result 4786 properties: 4787 _links: 4788 $ref: '#/components/schemas/paginated_links' 4789 totalItems: 4790 format: int32 4791 type: integer 4792 page: 4793 format: int32 4794 type: integer 4795 itemsPerPage: 4796 format: int32 4797 type: integer 4798 _embedded: 4799 $ref: '#/components/schemas/embedded_registry_integration_collection' 4800 type: object 4801 paginated-service_component_variable-collection: 4802 description: Paginated result 4803 properties: 4804 _links: 4805 $ref: '#/components/schemas/paginated_links' 4806 totalItems: 4807 format: int32 4808 type: integer 4809 page: 4810 format: int32 4811 type: integer 4812 itemsPerPage: 4813 format: int32 4814 type: integer 4815 _embedded: 4816 $ref: '#/components/schemas/embedded_service_component_variable_collection' 4817 type: object 4818 paginated-template-collection: 4819 description: Paginated result 4820 properties: 4821 _links: 4822 $ref: '#/components/schemas/paginated_links' 4823 totalItems: 4824 format: int32 4825 type: integer 4826 page: 4827 format: int32 4828 type: integer 4829 itemsPerPage: 4830 format: int32 4831 type: integer 4832 _embedded: 4833 $ref: '#/components/schemas/embedded_template_collection' 4834 type: object 4835 paginated-templates_repository-collection: 4836 description: Paginated result 4837 properties: 4838 _links: 4839 $ref: '#/components/schemas/paginated_links' 4840 totalItems: 4841 format: int32 4842 type: integer 4843 page: 4844 format: int32 4845 type: integer 4846 itemsPerPage: 4847 format: int32 4848 type: integer 4849 _embedded: 4850 $ref: '#/components/schemas/embedded_templates_repository_collection' 4851 type: object 4852 paginated-workflow-collection: 4853 description: Paginated result 4854 properties: 4855 _links: 4856 $ref: '#/components/schemas/paginated_links' 4857 totalItems: 4858 format: int32 4859 type: integer 4860 page: 4861 format: int32 4862 type: integer 4863 itemsPerPage: 4864 format: int32 4865 type: integer 4866 _embedded: 4867 $ref: '#/components/schemas/embedded_workflow_collection' 4868 type: object 4869 paginated_itemsPerPage: 4870 format: int32 4871 type: integer 4872 paginated_link: 4873 properties: 4874 href: 4875 type: string 4876 type: object 4877 paginated_links: 4878 properties: 4879 self: 4880 $ref: '#/components/schemas/paginated_link' 4881 first: 4882 $ref: '#/components/schemas/paginated_link' 4883 prev: 4884 $ref: '#/components/schemas/paginated_link' 4885 next: 4886 $ref: '#/components/schemas/paginated_link' 4887 last: 4888 $ref: '#/components/schemas/paginated_link' 4889 item: 4890 items: 4891 $ref: '#/components/schemas/paginated_link' 4892 type: array 4893 type: object 4894 paginated_page: 4895 format: int32 4896 type: integer 4897 paginated_total: 4898 format: int32 4899 type: integer 4900 pipeline-collection: 4901 deprecated: true 4902 description: A pipeline. 4903 properties: 4904 id: 4905 description: Pipeline identifier. 4906 readOnly: true 4907 type: string 4908 description: 4909 description: Pipeline description. 4910 readOnly: true 4911 type: string 4912 status: 4913 description: Pipeline status. 4914 readOnly: true 4915 type: string 4916 environment: 4917 description: Environment identifier. 4918 nullable: true 4919 readOnly: true 4920 type: string 4921 event: 4922 description: Event identifier. 4923 readOnly: true 4924 type: string 4925 webUrl: 4926 description: Pipeline web URL. 4927 readOnly: true 4928 type: string 4929 organization: 4930 description: Organization identifier. 4931 readOnly: true 4932 type: string 4933 type: object 4934 pipeline-item: 4935 deprecated: true 4936 description: A pipeline. 4937 properties: 4938 id: 4939 description: Pipeline identifier. 4940 readOnly: true 4941 type: string 4942 description: 4943 description: Pipeline description. 4944 readOnly: true 4945 type: string 4946 status: 4947 description: Pipeline status. 4948 readOnly: true 4949 type: string 4950 stages: 4951 description: Stage identifier. 4952 items: 4953 $ref: '#/components/schemas/Stage-item' 4954 readOnly: true 4955 type: array 4956 environment: 4957 description: Environment identifier. 4958 nullable: true 4959 readOnly: true 4960 type: string 4961 event: 4962 description: Event identifier. 4963 readOnly: true 4964 type: string 4965 webUrl: 4966 description: Pipeline web URL. 4967 readOnly: true 4968 type: string 4969 organization: 4970 description: Organization identifier. 4971 readOnly: true 4972 type: string 4973 type: object 4974 problem.generic: 4975 description: Generic Error 4976 properties: 4977 title: 4978 type: string 4979 detail: 4980 type: string 4981 violations: 4982 items: 4983 $ref: '#/components/schemas/problem.violation' 4984 nullable: true 4985 type: array 4986 type: object 4987 problem.violation: 4988 description: A validation error 4989 properties: 4990 propertyPath: 4991 type: string 4992 message: 4993 type: string 4994 type: object 4995 project-collection: 4996 description: A project holds multiple environments and shared secrets and settings. 4997 properties: 4998 id: 4999 description: Project identifier. 5000 readOnly: true 5001 type: string 5002 name: 5003 description: Project name. 5004 readOnly: true 5005 type: string 5006 totalEnvironments: 5007 description: Environment identifier. 5008 readOnly: true 5009 type: integer 5010 organization: 5011 description: Organization identifier. 5012 readOnly: true 5013 type: string 5014 type: object 5015 project-item: 5016 description: A project holds multiple environments and shared secrets and settings. 5017 properties: 5018 id: 5019 description: Project identifier. 5020 readOnly: true 5021 type: string 5022 labels: 5023 additionalProperties: 5024 type: string 5025 description: Environment labels. 5026 readOnly: true 5027 type: object 5028 name: 5029 description: Project name. 5030 readOnly: true 5031 type: string 5032 totalEnvironments: 5033 description: Environment identifier. 5034 readOnly: true 5035 type: integer 5036 buildSettings: 5037 $ref: '#/components/schemas/BuildSettings-item' 5038 organization: 5039 description: Organization identifier. 5040 readOnly: true 5041 type: string 5042 type: object 5043 project.CreateAction: 5044 description: A project holds multiple environments and shared secrets and settings. 5045 properties: 5046 name: 5047 maxLength: 255 5048 type: string 5049 organization: 5050 type: string 5051 labels: 5052 additionalProperties: 5053 type: string 5054 type: object 5055 required: 5056 - name 5057 - organization 5058 type: object 5059 project.EditBuildSettingsAction: 5060 description: A project holds multiple environments and shared secrets and settings. 5061 properties: 5062 useManagedRegistry: 5063 nullable: true 5064 type: boolean 5065 registryIntegration: 5066 nullable: true 5067 type: string 5068 useManagedCluster: 5069 nullable: true 5070 type: boolean 5071 kubernetesIntegration: 5072 nullable: true 5073 type: string 5074 cpu: 5075 description: K8s supports decimal values with step 0.001 That's why we are 5076 using decimal. 5077 nullable: true 5078 type: string 5079 memory: 5080 description: expressed in Mi 5081 nullable: true 5082 type: integer 5083 timeoutSeconds: 5084 nullable: true 5085 type: integer 5086 required: 5087 - cpu 5088 - kubernetesIntegration 5089 - memory 5090 - registryIntegration 5091 - timeoutSeconds 5092 type: object 5093 project.EditSettingsAction: 5094 description: A project holds multiple environments and shared secrets and settings. 5095 properties: 5096 name: 5097 maxLength: 255 5098 nullable: true 5099 type: string 5100 labels: 5101 $ref: '#/components/schemas/Edit' 5102 required: 5103 - name 5104 type: object 5105 project_variable-collection: 5106 description: A project variable used during Bunnyshell workflows. 5107 properties: 5108 id: 5109 description: Project variable identifier. 5110 readOnly: true 5111 type: string 5112 name: 5113 description: Project variable name. 5114 readOnly: true 5115 type: string 5116 value: 5117 description: Project variable value. 5118 nullable: true 5119 readOnly: true 5120 type: string 5121 secret: 5122 description: Project variable marked as secret. 5123 readOnly: true 5124 type: boolean 5125 project: 5126 description: Project identifier. 5127 readOnly: true 5128 type: string 5129 organization: 5130 description: Organization identifier. 5131 readOnly: true 5132 type: string 5133 type: object 5134 project_variable-item: 5135 description: A project variable used during Bunnyshell workflows. 5136 properties: 5137 id: 5138 description: Project variable identifier. 5139 readOnly: true 5140 type: string 5141 name: 5142 description: Project variable name. 5143 readOnly: true 5144 type: string 5145 value: 5146 description: Project variable value. 5147 nullable: true 5148 readOnly: true 5149 type: string 5150 secret: 5151 description: Project variable marked as secret. 5152 readOnly: true 5153 type: boolean 5154 project: 5155 description: Project identifier. 5156 readOnly: true 5157 type: string 5158 organization: 5159 description: Organization identifier. 5160 readOnly: true 5161 type: string 5162 type: object 5163 project_variable.CreateAction: 5164 description: A project variable used during Bunnyshell workflows. 5165 properties: 5166 name: 5167 type: string 5168 value: 5169 type: string 5170 isSecret: 5171 nullable: true 5172 type: boolean 5173 project: 5174 type: string 5175 required: 5176 - name 5177 - project 5178 - value 5179 type: object 5180 project_variable.EditAction: 5181 description: A project variable used during Bunnyshell workflows. 5182 properties: 5183 value: 5184 nullable: true 5185 type: string 5186 isSecret: 5187 nullable: true 5188 type: boolean 5189 required: 5190 - value 5191 type: object 5192 registry_integration-collection: 5193 description: A Registry integration stores connection information for a Container 5194 registry. 5195 properties: 5196 id: 5197 description: Registry integration identifier. 5198 readOnly: true 5199 type: string 5200 name: 5201 description: Registry integration name. 5202 readOnly: true 5203 type: string 5204 providerName: 5205 description: Registry integration provider. 5206 readOnly: true 5207 type: string 5208 status: 5209 description: Registry integration status. 5210 readOnly: true 5211 type: string 5212 organization: 5213 description: Organization identifier. 5214 readOnly: true 5215 type: string 5216 type: object 5217 registry_integration-item: 5218 description: A Registry integration stores connection information for a Container 5219 registry. 5220 properties: 5221 id: 5222 description: Registry integration identifier. 5223 readOnly: true 5224 type: string 5225 name: 5226 description: Registry integration name. 5227 readOnly: true 5228 type: string 5229 providerName: 5230 description: Registry integration provider. 5231 readOnly: true 5232 type: string 5233 status: 5234 description: Registry integration status. 5235 readOnly: true 5236 type: string 5237 organization: 5238 description: Organization identifier. 5239 readOnly: true 5240 type: string 5241 type: object 5242 secret.DecryptAction: 5243 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5244 properties: 5245 expression: 5246 type: string 5247 organization: 5248 type: string 5249 required: 5250 - expression 5251 - organization 5252 type: object 5253 secret.Decrypted-item: 5254 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5255 properties: 5256 plainText: 5257 description: Plain text. 5258 type: string 5259 organization: 5260 description: Organization identifier. 5261 type: string 5262 type: object 5263 secret.EncryptAction: 5264 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5265 properties: 5266 plainText: 5267 type: string 5268 organization: 5269 type: string 5270 required: 5271 - organization 5272 - plainText 5273 type: object 5274 secret.Encrypted-item: 5275 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5276 properties: 5277 expression: 5278 description: Encrypted expression. 5279 type: string 5280 organization: 5281 description: Organization identifier. 5282 type: string 5283 type: object 5284 secret.GenericObject: 5285 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5286 type: object 5287 secret.TranscryptConfigurationAction: 5288 description: A secret is used to encrypt plain texts and decrypt cipher texts. 5289 properties: 5290 yaml: 5291 type: string 5292 mode: 5293 enum: 5294 - obfuscated 5295 - exposed 5296 - resolved 5297 type: string 5298 organization: 5299 type: string 5300 required: 5301 - mode 5302 - organization 5303 - yaml 5304 type: object 5305 service_component_variable-collection: 5306 description: A component variable used during Bunnyshell workflows. 5307 properties: 5308 id: 5309 description: Component variable identifier. 5310 readOnly: true 5311 type: string 5312 name: 5313 description: Component variable name. 5314 readOnly: true 5315 type: string 5316 value: 5317 description: Component variable value. 5318 nullable: true 5319 readOnly: true 5320 type: string 5321 secret: 5322 description: Component variable marked as secret. 5323 readOnly: true 5324 type: boolean 5325 serviceComponent: 5326 description: Service component identifier 5327 readOnly: true 5328 type: string 5329 project: 5330 description: Project identifier. 5331 readOnly: true 5332 type: string 5333 environment: 5334 description: Environment identifier. 5335 readOnly: true 5336 type: string 5337 organization: 5338 description: Organization identifier. 5339 readOnly: true 5340 type: string 5341 type: object 5342 service_component_variable-item: 5343 description: A component variable used during Bunnyshell workflows. 5344 properties: 5345 id: 5346 description: Component variable identifier. 5347 readOnly: true 5348 type: string 5349 name: 5350 description: Component variable name. 5351 readOnly: true 5352 type: string 5353 value: 5354 description: Component variable value. 5355 nullable: true 5356 readOnly: true 5357 type: string 5358 secret: 5359 description: Component variable marked as secret. 5360 readOnly: true 5361 type: boolean 5362 serviceComponent: 5363 description: Service component identifier 5364 readOnly: true 5365 type: string 5366 project: 5367 description: Project identifier. 5368 readOnly: true 5369 type: string 5370 environment: 5371 description: Environment identifier. 5372 readOnly: true 5373 type: string 5374 organization: 5375 description: Organization identifier. 5376 readOnly: true 5377 type: string 5378 type: object 5379 service_component_variable.CreateAction: 5380 description: A component variable used during Bunnyshell workflows. 5381 properties: 5382 name: 5383 type: string 5384 value: 5385 type: string 5386 isSecret: 5387 nullable: true 5388 type: boolean 5389 serviceComponent: 5390 type: string 5391 required: 5392 - name 5393 - serviceComponent 5394 - value 5395 type: object 5396 service_component_variable.EditAction: 5397 description: A component variable used during Bunnyshell workflows. 5398 properties: 5399 value: 5400 nullable: true 5401 type: string 5402 isSecret: 5403 nullable: true 5404 type: boolean 5405 required: 5406 - value 5407 type: object 5408 template-collection: 5409 description: A template holds information for generating an environment. 5410 properties: 5411 id: 5412 description: Template identifier. 5413 readOnly: true 5414 type: string 5415 key: 5416 description: Template key. 5417 readOnly: true 5418 type: string 5419 name: 5420 description: Template name. 5421 readOnly: true 5422 type: string 5423 gitSha: 5424 description: Template git repository SHA. 5425 readOnly: true 5426 type: string 5427 shortDescription: 5428 description: Template short description. 5429 nullable: true 5430 readOnly: true 5431 type: string 5432 tags: 5433 description: Template tags. 5434 items: 5435 type: string 5436 readOnly: true 5437 type: array 5438 organization: 5439 description: Organization identifier. 5440 nullable: true 5441 readOnly: true 5442 type: string 5443 templatesRepository: 5444 description: Templates repository identifier. 5445 nullable: true 5446 readOnly: true 5447 type: string 5448 type: object 5449 template-item: 5450 description: A template holds information for generating an environment. 5451 properties: 5452 id: 5453 description: Template identifier. 5454 readOnly: true 5455 type: string 5456 key: 5457 description: Template key. 5458 readOnly: true 5459 type: string 5460 name: 5461 description: Template name. 5462 readOnly: true 5463 type: string 5464 gitSha: 5465 description: Template git repository SHA. 5466 readOnly: true 5467 type: string 5468 shortDescription: 5469 description: Template short description. 5470 nullable: true 5471 readOnly: true 5472 type: string 5473 tags: 5474 description: Template tags. 5475 items: 5476 type: string 5477 readOnly: true 5478 type: array 5479 variablesSchema: 5480 description: Template variables. 5481 items: 5482 $ref: '#/components/schemas/template_item_variablesSchema_inner' 5483 readOnly: true 5484 type: array 5485 organization: 5486 description: Organization identifier. 5487 nullable: true 5488 readOnly: true 5489 type: string 5490 templatesRepository: 5491 description: Templates repository identifier. 5492 nullable: true 5493 readOnly: true 5494 type: string 5495 type: object 5496 template.GenericObject: 5497 description: A template holds information for generating an environment. 5498 type: object 5499 template.ValidateAction: 5500 description: A template holds information for generating an environment. 5501 properties: 5502 source: 5503 $ref: '#/components/schemas/template_ValidateAction_source' 5504 type: object 5505 templates_repository-collection: 5506 description: A templates repository holds multiple templates. 5507 properties: 5508 id: 5509 description: Templates repository identifier. 5510 readOnly: true 5511 type: string 5512 name: 5513 description: Templates repository name. 5514 readOnly: true 5515 type: string 5516 gitRepositoryUrl: 5517 description: Templates repository git repository URL. 5518 readOnly: true 5519 type: string 5520 gitRef: 5521 description: Templates repository git repository reference. 5522 readOnly: true 5523 type: string 5524 lastSyncSha: 5525 description: Templates repository last synced git repository SHA. 5526 nullable: true 5527 readOnly: true 5528 type: string 5529 organization: 5530 description: Organization identifier. 5531 nullable: true 5532 readOnly: true 5533 type: string 5534 type: object 5535 templates_repository-item: 5536 description: A templates repository holds multiple templates. 5537 properties: 5538 id: 5539 description: Templates repository identifier. 5540 readOnly: true 5541 type: string 5542 name: 5543 description: Templates repository name. 5544 readOnly: true 5545 type: string 5546 gitRepositoryUrl: 5547 description: Templates repository git repository URL. 5548 readOnly: true 5549 type: string 5550 gitRef: 5551 description: Templates repository git repository reference. 5552 readOnly: true 5553 type: string 5554 lastSyncSha: 5555 description: Templates repository last synced git repository SHA. 5556 nullable: true 5557 readOnly: true 5558 type: string 5559 organization: 5560 description: Organization identifier. 5561 nullable: true 5562 readOnly: true 5563 type: string 5564 type: object 5565 workflow-collection: 5566 description: A workflow. 5567 properties: 5568 id: 5569 description: Workflow identifier. 5570 readOnly: true 5571 type: string 5572 description: 5573 description: Workflow description. 5574 readOnly: true 5575 type: string 5576 status: 5577 description: Workflow status. 5578 readOnly: true 5579 type: string 5580 environment: 5581 description: Environment identifier. 5582 nullable: true 5583 readOnly: true 5584 type: string 5585 event: 5586 description: Event identifier. 5587 readOnly: true 5588 type: string 5589 organization: 5590 description: Organization identifier. 5591 readOnly: true 5592 type: string 5593 duration: 5594 description: Workflow duration in seconds. 5595 nullable: true 5596 readOnly: true 5597 type: integer 5598 jobsCount: 5599 description: Number of jobs. 5600 readOnly: true 5601 type: integer 5602 completedJobsCount: 5603 description: Number of completed jobs. 5604 readOnly: true 5605 type: integer 5606 webUrl: 5607 description: Workflow web URL. 5608 readOnly: true 5609 type: string 5610 type: object 5611 workflow-item: 5612 description: A workflow. 5613 properties: 5614 id: 5615 description: Workflow identifier. 5616 readOnly: true 5617 type: string 5618 description: 5619 description: Workflow description. 5620 readOnly: true 5621 type: string 5622 status: 5623 description: Workflow status. 5624 readOnly: true 5625 type: string 5626 environment: 5627 description: Environment identifier. 5628 nullable: true 5629 readOnly: true 5630 type: string 5631 event: 5632 description: Event identifier. 5633 readOnly: true 5634 type: string 5635 organization: 5636 description: Organization identifier. 5637 readOnly: true 5638 type: string 5639 duration: 5640 description: Workflow duration in seconds. 5641 nullable: true 5642 readOnly: true 5643 type: integer 5644 jobsCount: 5645 description: Number of jobs. 5646 readOnly: true 5647 type: integer 5648 completedJobsCount: 5649 description: Number of completed jobs. 5650 readOnly: true 5651 type: integer 5652 webUrl: 5653 description: Workflow web URL. 5654 readOnly: true 5655 type: string 5656 type: object 5657 ContainerConfig_item_profile: 5658 description: A profile config or a profile name for local usage with rdev.yaml 5659 oneOf: 5660 - $ref: '#/components/schemas/Profile-item' 5661 - type: string 5662 readOnly: true 5663 EnumType_item_defaultValue: 5664 description: The default value used if none is provided. 5665 discriminator: 5666 mapping: 5667 bool: '#/components/schemas/BooleanValue-item' 5668 int: '#/components/schemas/IntegerValue-item' 5669 float: '#/components/schemas/FloatValue-item' 5670 string: '#/components/schemas/StringValue-item' 5671 propertyName: type 5672 oneOf: 5673 - $ref: '#/components/schemas/BooleanValue-item' 5674 - $ref: '#/components/schemas/IntegerValue-item' 5675 - $ref: '#/components/schemas/FloatValue-item' 5676 - $ref: '#/components/schemas/StringValue-item' 5677 properties: 5678 type: 5679 description: Discriminator property 5680 type: string 5681 required: 5682 - type 5683 EnumType_item_values_inner: 5684 discriminator: 5685 mapping: 5686 bool: '#/components/schemas/BooleanValue-item' 5687 int: '#/components/schemas/IntegerValue-item' 5688 float: '#/components/schemas/FloatValue-item' 5689 string: '#/components/schemas/StringValue-item' 5690 propertyName: type 5691 oneOf: 5692 - $ref: '#/components/schemas/BooleanValue-item' 5693 - $ref: '#/components/schemas/IntegerValue-item' 5694 - $ref: '#/components/schemas/FloatValue-item' 5695 - $ref: '#/components/schemas/StringValue-item' 5696 properties: 5697 type: 5698 description: Discriminator property 5699 type: string 5700 required: 5701 - type 5702 FromTemplate_variables_value: 5703 oneOf: 5704 - type: boolean 5705 - type: integer 5706 - type: number 5707 - type: string 5708 component_Config_item_config: 5709 description: A list of container configs. 5710 oneOf: 5711 - items: 5712 $ref: '#/components/schemas/SimpleResourceConfig-item' 5713 nullable: true 5714 type: array 5715 - items: 5716 $ref: '#/components/schemas/ExtendedResourceConfig-item' 5717 nullable: true 5718 type: array 5719 readOnly: true 5720 environment_CreateAction_genesis: 5721 description: The environment creation method 5722 oneOf: 5723 - $ref: '#/components/schemas/FromGit' 5724 - $ref: '#/components/schemas/FromGitSpec' 5725 - $ref: '#/components/schemas/FromString' 5726 - $ref: '#/components/schemas/FromTemplate' 5727 environment_EditComponentsAction_filter: 5728 oneOf: 5729 - $ref: '#/components/schemas/FilterGit' 5730 - $ref: '#/components/schemas/FilterName' 5731 environment_EditConfiguration_configuration: 5732 description: The environment update source 5733 oneOf: 5734 - $ref: '#/components/schemas/FromGit' 5735 - $ref: '#/components/schemas/FromGitSpec' 5736 - $ref: '#/components/schemas/FromString' 5737 - $ref: '#/components/schemas/FromTemplate' 5738 environment_EditSettings_edit: 5739 description: Environment edit by type 5740 oneOf: 5741 - $ref: '#/components/schemas/Primary' 5742 - $ref: '#/components/schemas/Ephemeral' 5743 embedded_component_collection: 5744 properties: 5745 item: 5746 items: 5747 $ref: '#/components/schemas/component-collection' 5748 type: array 5749 title: embedded-component-collection 5750 type: object 5751 embedded_componentEndpoint_collection: 5752 properties: 5753 item: 5754 items: 5755 $ref: '#/components/schemas/componentEndpoint-collection' 5756 type: array 5757 title: embedded-componentEndpoint-collection 5758 type: object 5759 embedded_componentGit_collection: 5760 properties: 5761 item: 5762 items: 5763 $ref: '#/components/schemas/componentGit-collection' 5764 type: array 5765 title: embedded-componentGit-collection 5766 type: object 5767 embedded_environment_collection: 5768 properties: 5769 item: 5770 items: 5771 $ref: '#/components/schemas/environment-collection' 5772 type: array 5773 title: embedded-environment-collection 5774 type: object 5775 embedded_environment_variable_collection: 5776 properties: 5777 item: 5778 items: 5779 $ref: '#/components/schemas/environment_variable-collection' 5780 type: array 5781 title: embedded-environment_variable-collection 5782 type: object 5783 embedded_event_collection: 5784 properties: 5785 item: 5786 items: 5787 $ref: '#/components/schemas/event-collection' 5788 type: array 5789 title: embedded-event-collection 5790 type: object 5791 embedded_kubernetes_integration_collection: 5792 properties: 5793 item: 5794 items: 5795 $ref: '#/components/schemas/kubernetes_integration-collection' 5796 type: array 5797 title: embedded-kubernetes_integration-collection 5798 type: object 5799 embedded_organization_collection: 5800 properties: 5801 item: 5802 items: 5803 $ref: '#/components/schemas/organization-collection' 5804 type: array 5805 title: embedded-organization-collection 5806 type: object 5807 embedded_pipeline_collection: 5808 properties: 5809 item: 5810 items: 5811 $ref: '#/components/schemas/pipeline-collection' 5812 type: array 5813 title: embedded-pipeline-collection 5814 type: object 5815 embedded_project_collection: 5816 properties: 5817 item: 5818 items: 5819 $ref: '#/components/schemas/project-collection' 5820 type: array 5821 title: embedded-project-collection 5822 type: object 5823 embedded_project_variable_collection: 5824 properties: 5825 item: 5826 items: 5827 $ref: '#/components/schemas/project_variable-collection' 5828 type: array 5829 title: embedded-project_variable-collection 5830 type: object 5831 embedded_registry_integration_collection: 5832 properties: 5833 item: 5834 items: 5835 $ref: '#/components/schemas/registry_integration-collection' 5836 type: array 5837 title: embedded-registry_integration-collection 5838 type: object 5839 embedded_service_component_variable_collection: 5840 properties: 5841 item: 5842 items: 5843 $ref: '#/components/schemas/service_component_variable-collection' 5844 type: array 5845 title: embedded-service_component_variable-collection 5846 type: object 5847 embedded_template_collection: 5848 properties: 5849 item: 5850 items: 5851 $ref: '#/components/schemas/template-collection' 5852 type: array 5853 title: embedded-template-collection 5854 type: object 5855 embedded_templates_repository_collection: 5856 properties: 5857 item: 5858 items: 5859 $ref: '#/components/schemas/templates_repository-collection' 5860 type: array 5861 title: embedded-templates_repository-collection 5862 type: object 5863 embedded_workflow_collection: 5864 properties: 5865 item: 5866 items: 5867 $ref: '#/components/schemas/workflow-collection' 5868 type: array 5869 title: embedded-workflow-collection 5870 type: object 5871 template_item_variablesSchema_inner: 5872 discriminator: 5873 mapping: 5874 bool: '#/components/schemas/BooleanType-item' 5875 int: '#/components/schemas/IntegerType-item' 5876 float: '#/components/schemas/FloatType-item' 5877 string: '#/components/schemas/StringType-item' 5878 enum: '#/components/schemas/EnumType-item' 5879 propertyName: type 5880 oneOf: 5881 - $ref: '#/components/schemas/BooleanType-item' 5882 - $ref: '#/components/schemas/IntegerType-item' 5883 - $ref: '#/components/schemas/FloatType-item' 5884 - $ref: '#/components/schemas/StringType-item' 5885 - $ref: '#/components/schemas/EnumType-item' 5886 properties: 5887 type: 5888 description: Discriminator property 5889 type: string 5890 required: 5891 - type 5892 template_ValidateAction_source: 5893 oneOf: 5894 - $ref: '#/components/schemas/ValidateSourceGit' 5895 - $ref: '#/components/schemas/ValidateSourceString' 5896 securitySchemes: 5897 ApiKeyAuth: 5898 description: Value for the X-Auth-Token header parameter. 5899 in: header 5900 name: X-Auth-Token 5901 type: apiKey 5902 JWT: 5903 description: Value for the Authorization header parameter. 5904 in: header 5905 name: Authorization 5906 type: apiKey