This is page 3 of 5. Use http://codebase.md/stumason/coolify-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .cursor
│ └── rules
│ ├── 000-cursor-rules.mdc
│ ├── 801-feature-workflow.mdc
│ ├── 802-coolify-mcp-workflow.mdc
│ └── 803-npm-publish-workflow.mdc
├── .eslintrc.json
├── .github
│ └── workflows
│ └── ci.yml
├── .gitignore
├── .lintstagedrc.json
├── .markdownlint-cli2.jsonc
├── .prettierrc
├── .repomixignore
├── debug.js
├── docs
│ ├── coolify-openapi.yaml
│ ├── features
│ │ ├── 001-core-server-setup.md
│ │ ├── 002-server-info-resource.md
│ │ ├── 003-project-management.md
│ │ ├── 004-environment-management.md
│ │ ├── 005-application-deployment.md
│ │ ├── 006-database-management.md
│ │ ├── 007-service-management.md
│ │ ├── 008-mcp-resources-implementation.md
│ │ ├── 009-mcp-prompts-implementation.md
│ │ ├── 010-private-key-management.md
│ │ ├── 011-team-management.md
│ │ ├── 012-backup-management.md
│ │ ├── 013-npx-config-fix.md
│ │ └── future-adrs.md
│ ├── mcp-example-clients.md
│ ├── mcp-js-readme.md
│ └── openapi-chunks
│ ├── applications-api.yaml
│ ├── databases-api.yaml
│ ├── deployments-api.yaml
│ ├── private-keys-api.yaml
│ ├── projects-api.yaml
│ ├── resources-api.yaml
│ ├── schemas.yaml
│ ├── servers-api.yaml
│ ├── services-api.yaml
│ ├── teams-api.yaml
│ └── untagged-api.yaml
├── jest.config.js
├── package-lock.json
├── package.json
├── README.md
├── repomix-output.xml
├── src
│ ├── __tests__
│ │ ├── coolify-client.test.ts
│ │ └── resources
│ │ ├── application-resources.test.ts
│ │ ├── database-resources.test.ts
│ │ ├── deployment-resources.test.ts
│ │ └── service-resources.test.ts
│ ├── index.ts
│ ├── lib
│ │ ├── coolify-client.ts
│ │ ├── mcp-server.ts
│ │ └── resource.ts
│ ├── resources
│ │ ├── application-resources.ts
│ │ ├── database-resources.ts
│ │ ├── deployment-resources.ts
│ │ ├── index.ts
│ │ └── service-resources.ts
│ └── types
│ └── coolify.ts
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/docs/openapi-chunks/applications-api.yaml:
--------------------------------------------------------------------------------
```yaml
1 | openapi: 3.1.0
2 | info:
3 | title: Coolify
4 | version: '0.1'
5 | paths:
6 | /applications:
7 | get:
8 | tags:
9 | - Applications
10 | summary: List
11 | description: List all applications.
12 | operationId: list-applications
13 | responses:
14 | '200':
15 | description: Get all applications.
16 | content:
17 | application/json:
18 | schema:
19 | type: array
20 | items:
21 | $ref: '#/components/schemas/Application'
22 | '400':
23 | $ref: '#/components/responses/400'
24 | '401':
25 | $ref: '#/components/responses/401'
26 | security:
27 | - bearerAuth: []
28 | /applications/public:
29 | post:
30 | tags:
31 | - Applications
32 | summary: Create (Public)
33 | description: Create new application based on a public git repository.
34 | operationId: create-public-application
35 | requestBody:
36 | description: Application object that needs to be created.
37 | required: true
38 | content:
39 | application/json:
40 | schema:
41 | required:
42 | - project_uuid
43 | - server_uuid
44 | - environment_name
45 | - environment_uuid
46 | - git_repository
47 | - git_branch
48 | - build_pack
49 | - ports_exposes
50 | properties:
51 | project_uuid:
52 | type: string
53 | description: The project UUID.
54 | server_uuid:
55 | type: string
56 | description: The server UUID.
57 | environment_name:
58 | type: string
59 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
60 | environment_uuid:
61 | type: string
62 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
63 | git_repository:
64 | type: string
65 | description: The git repository URL.
66 | git_branch:
67 | type: string
68 | description: The git branch.
69 | build_pack:
70 | type: string
71 | enum:
72 | - nixpacks
73 | - static
74 | - dockerfile
75 | - dockercompose
76 | description: The build pack type.
77 | ports_exposes:
78 | type: string
79 | description: The ports to expose.
80 | destination_uuid:
81 | type: string
82 | description: The destination UUID.
83 | name:
84 | type: string
85 | description: The application name.
86 | description:
87 | type: string
88 | description: The application description.
89 | domains:
90 | type: string
91 | description: The application domains.
92 | git_commit_sha:
93 | type: string
94 | description: The git commit SHA.
95 | docker_registry_image_name:
96 | type: string
97 | description: The docker registry image name.
98 | docker_registry_image_tag:
99 | type: string
100 | description: The docker registry image tag.
101 | is_static:
102 | type: boolean
103 | description: The flag to indicate if the application is static.
104 | static_image:
105 | type: string
106 | enum:
107 | - nginx:alpine
108 | description: The static image.
109 | install_command:
110 | type: string
111 | description: The install command.
112 | build_command:
113 | type: string
114 | description: The build command.
115 | start_command:
116 | type: string
117 | description: The start command.
118 | ports_mappings:
119 | type: string
120 | description: The ports mappings.
121 | base_directory:
122 | type: string
123 | description: The base directory for all commands.
124 | publish_directory:
125 | type: string
126 | description: The publish directory.
127 | health_check_enabled:
128 | type: boolean
129 | description: Health check enabled.
130 | health_check_path:
131 | type: string
132 | description: Health check path.
133 | health_check_port:
134 | type: string
135 | nullable: true
136 | description: Health check port.
137 | health_check_host:
138 | type: string
139 | nullable: true
140 | description: Health check host.
141 | health_check_method:
142 | type: string
143 | description: Health check method.
144 | health_check_return_code:
145 | type: integer
146 | description: Health check return code.
147 | health_check_scheme:
148 | type: string
149 | description: Health check scheme.
150 | health_check_response_text:
151 | type: string
152 | nullable: true
153 | description: Health check response text.
154 | health_check_interval:
155 | type: integer
156 | description: Health check interval in seconds.
157 | health_check_timeout:
158 | type: integer
159 | description: Health check timeout in seconds.
160 | health_check_retries:
161 | type: integer
162 | description: Health check retries count.
163 | health_check_start_period:
164 | type: integer
165 | description: Health check start period in seconds.
166 | limits_memory:
167 | type: string
168 | description: Memory limit.
169 | limits_memory_swap:
170 | type: string
171 | description: Memory swap limit.
172 | limits_memory_swappiness:
173 | type: integer
174 | description: Memory swappiness.
175 | limits_memory_reservation:
176 | type: string
177 | description: Memory reservation.
178 | limits_cpus:
179 | type: string
180 | description: CPU limit.
181 | limits_cpuset:
182 | type: string
183 | nullable: true
184 | description: CPU set.
185 | limits_cpu_shares:
186 | type: integer
187 | description: CPU shares.
188 | custom_labels:
189 | type: string
190 | description: Custom labels.
191 | custom_docker_run_options:
192 | type: string
193 | description: Custom docker run options.
194 | post_deployment_command:
195 | type: string
196 | description: Post deployment command.
197 | post_deployment_command_container:
198 | type: string
199 | description: Post deployment command container.
200 | pre_deployment_command:
201 | type: string
202 | description: Pre deployment command.
203 | pre_deployment_command_container:
204 | type: string
205 | description: Pre deployment command container.
206 | manual_webhook_secret_github:
207 | type: string
208 | description: Manual webhook secret for Github.
209 | manual_webhook_secret_gitlab:
210 | type: string
211 | description: Manual webhook secret for Gitlab.
212 | manual_webhook_secret_bitbucket:
213 | type: string
214 | description: Manual webhook secret for Bitbucket.
215 | manual_webhook_secret_gitea:
216 | type: string
217 | description: Manual webhook secret for Gitea.
218 | redirect:
219 | type: string
220 | nullable: true
221 | description: How to set redirect with Traefik / Caddy. www<->non-www.
222 | enum:
223 | - www
224 | - non-www
225 | - both
226 | instant_deploy:
227 | type: boolean
228 | description: The flag to indicate if the application should be deployed instantly.
229 | dockerfile:
230 | type: string
231 | description: The Dockerfile content.
232 | docker_compose_location:
233 | type: string
234 | description: The Docker Compose location.
235 | docker_compose_raw:
236 | type: string
237 | description: The Docker Compose raw content.
238 | docker_compose_custom_start_command:
239 | type: string
240 | description: The Docker Compose custom start command.
241 | docker_compose_custom_build_command:
242 | type: string
243 | description: The Docker Compose custom build command.
244 | docker_compose_domains:
245 | type: array
246 | description: The Docker Compose domains.
247 | watch_paths:
248 | type: string
249 | description: The watch paths.
250 | use_build_server:
251 | type: boolean
252 | nullable: true
253 | description: Use build server.
254 | type: object
255 | responses:
256 | '201':
257 | description: Application created successfully.
258 | content:
259 | application/json:
260 | schema:
261 | properties:
262 | uuid:
263 | type: string
264 | type: object
265 | '400':
266 | $ref: '#/components/responses/400'
267 | '401':
268 | $ref: '#/components/responses/401'
269 | security:
270 | - bearerAuth: []
271 | /applications/private-github-app:
272 | post:
273 | tags:
274 | - Applications
275 | summary: Create (Private - GH App)
276 | description: Create new application based on a private repository through a Github App.
277 | operationId: create-private-github-app-application
278 | requestBody:
279 | description: Application object that needs to be created.
280 | required: true
281 | content:
282 | application/json:
283 | schema:
284 | required:
285 | - project_uuid
286 | - server_uuid
287 | - environment_name
288 | - environment_uuid
289 | - github_app_uuid
290 | - git_repository
291 | - git_branch
292 | - build_pack
293 | - ports_exposes
294 | properties:
295 | project_uuid:
296 | type: string
297 | description: The project UUID.
298 | server_uuid:
299 | type: string
300 | description: The server UUID.
301 | environment_name:
302 | type: string
303 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
304 | environment_uuid:
305 | type: string
306 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
307 | github_app_uuid:
308 | type: string
309 | description: The Github App UUID.
310 | git_repository:
311 | type: string
312 | description: The git repository URL.
313 | git_branch:
314 | type: string
315 | description: The git branch.
316 | ports_exposes:
317 | type: string
318 | description: The ports to expose.
319 | destination_uuid:
320 | type: string
321 | description: The destination UUID.
322 | build_pack:
323 | type: string
324 | enum:
325 | - nixpacks
326 | - static
327 | - dockerfile
328 | - dockercompose
329 | description: The build pack type.
330 | name:
331 | type: string
332 | description: The application name.
333 | description:
334 | type: string
335 | description: The application description.
336 | domains:
337 | type: string
338 | description: The application domains.
339 | git_commit_sha:
340 | type: string
341 | description: The git commit SHA.
342 | docker_registry_image_name:
343 | type: string
344 | description: The docker registry image name.
345 | docker_registry_image_tag:
346 | type: string
347 | description: The docker registry image tag.
348 | is_static:
349 | type: boolean
350 | description: The flag to indicate if the application is static.
351 | static_image:
352 | type: string
353 | enum:
354 | - nginx:alpine
355 | description: The static image.
356 | install_command:
357 | type: string
358 | description: The install command.
359 | build_command:
360 | type: string
361 | description: The build command.
362 | start_command:
363 | type: string
364 | description: The start command.
365 | ports_mappings:
366 | type: string
367 | description: The ports mappings.
368 | base_directory:
369 | type: string
370 | description: The base directory for all commands.
371 | publish_directory:
372 | type: string
373 | description: The publish directory.
374 | health_check_enabled:
375 | type: boolean
376 | description: Health check enabled.
377 | health_check_path:
378 | type: string
379 | description: Health check path.
380 | health_check_port:
381 | type: string
382 | nullable: true
383 | description: Health check port.
384 | health_check_host:
385 | type: string
386 | nullable: true
387 | description: Health check host.
388 | health_check_method:
389 | type: string
390 | description: Health check method.
391 | health_check_return_code:
392 | type: integer
393 | description: Health check return code.
394 | health_check_scheme:
395 | type: string
396 | description: Health check scheme.
397 | health_check_response_text:
398 | type: string
399 | nullable: true
400 | description: Health check response text.
401 | health_check_interval:
402 | type: integer
403 | description: Health check interval in seconds.
404 | health_check_timeout:
405 | type: integer
406 | description: Health check timeout in seconds.
407 | health_check_retries:
408 | type: integer
409 | description: Health check retries count.
410 | health_check_start_period:
411 | type: integer
412 | description: Health check start period in seconds.
413 | limits_memory:
414 | type: string
415 | description: Memory limit.
416 | limits_memory_swap:
417 | type: string
418 | description: Memory swap limit.
419 | limits_memory_swappiness:
420 | type: integer
421 | description: Memory swappiness.
422 | limits_memory_reservation:
423 | type: string
424 | description: Memory reservation.
425 | limits_cpus:
426 | type: string
427 | description: CPU limit.
428 | limits_cpuset:
429 | type: string
430 | nullable: true
431 | description: CPU set.
432 | limits_cpu_shares:
433 | type: integer
434 | description: CPU shares.
435 | custom_labels:
436 | type: string
437 | description: Custom labels.
438 | custom_docker_run_options:
439 | type: string
440 | description: Custom docker run options.
441 | post_deployment_command:
442 | type: string
443 | description: Post deployment command.
444 | post_deployment_command_container:
445 | type: string
446 | description: Post deployment command container.
447 | pre_deployment_command:
448 | type: string
449 | description: Pre deployment command.
450 | pre_deployment_command_container:
451 | type: string
452 | description: Pre deployment command container.
453 | manual_webhook_secret_github:
454 | type: string
455 | description: Manual webhook secret for Github.
456 | manual_webhook_secret_gitlab:
457 | type: string
458 | description: Manual webhook secret for Gitlab.
459 | manual_webhook_secret_bitbucket:
460 | type: string
461 | description: Manual webhook secret for Bitbucket.
462 | manual_webhook_secret_gitea:
463 | type: string
464 | description: Manual webhook secret for Gitea.
465 | redirect:
466 | type: string
467 | nullable: true
468 | description: How to set redirect with Traefik / Caddy. www<->non-www.
469 | enum:
470 | - www
471 | - non-www
472 | - both
473 | instant_deploy:
474 | type: boolean
475 | description: The flag to indicate if the application should be deployed instantly.
476 | dockerfile:
477 | type: string
478 | description: The Dockerfile content.
479 | docker_compose_location:
480 | type: string
481 | description: The Docker Compose location.
482 | docker_compose_raw:
483 | type: string
484 | description: The Docker Compose raw content.
485 | docker_compose_custom_start_command:
486 | type: string
487 | description: The Docker Compose custom start command.
488 | docker_compose_custom_build_command:
489 | type: string
490 | description: The Docker Compose custom build command.
491 | docker_compose_domains:
492 | type: array
493 | description: The Docker Compose domains.
494 | watch_paths:
495 | type: string
496 | description: The watch paths.
497 | use_build_server:
498 | type: boolean
499 | nullable: true
500 | description: Use build server.
501 | type: object
502 | responses:
503 | '201':
504 | description: Application created successfully.
505 | content:
506 | application/json:
507 | schema:
508 | properties:
509 | uuid:
510 | type: string
511 | type: object
512 | '400':
513 | $ref: '#/components/responses/400'
514 | '401':
515 | $ref: '#/components/responses/401'
516 | security:
517 | - bearerAuth: []
518 | /applications/private-deploy-key:
519 | post:
520 | tags:
521 | - Applications
522 | summary: Create (Private - Deploy Key)
523 | description: Create new application based on a private repository through a Deploy Key.
524 | operationId: create-private-deploy-key-application
525 | requestBody:
526 | description: Application object that needs to be created.
527 | required: true
528 | content:
529 | application/json:
530 | schema:
531 | required:
532 | - project_uuid
533 | - server_uuid
534 | - environment_name
535 | - environment_uuid
536 | - private_key_uuid
537 | - git_repository
538 | - git_branch
539 | - build_pack
540 | - ports_exposes
541 | properties:
542 | project_uuid:
543 | type: string
544 | description: The project UUID.
545 | server_uuid:
546 | type: string
547 | description: The server UUID.
548 | environment_name:
549 | type: string
550 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
551 | environment_uuid:
552 | type: string
553 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
554 | private_key_uuid:
555 | type: string
556 | description: The private key UUID.
557 | git_repository:
558 | type: string
559 | description: The git repository URL.
560 | git_branch:
561 | type: string
562 | description: The git branch.
563 | ports_exposes:
564 | type: string
565 | description: The ports to expose.
566 | destination_uuid:
567 | type: string
568 | description: The destination UUID.
569 | build_pack:
570 | type: string
571 | enum:
572 | - nixpacks
573 | - static
574 | - dockerfile
575 | - dockercompose
576 | description: The build pack type.
577 | name:
578 | type: string
579 | description: The application name.
580 | description:
581 | type: string
582 | description: The application description.
583 | domains:
584 | type: string
585 | description: The application domains.
586 | git_commit_sha:
587 | type: string
588 | description: The git commit SHA.
589 | docker_registry_image_name:
590 | type: string
591 | description: The docker registry image name.
592 | docker_registry_image_tag:
593 | type: string
594 | description: The docker registry image tag.
595 | is_static:
596 | type: boolean
597 | description: The flag to indicate if the application is static.
598 | static_image:
599 | type: string
600 | enum:
601 | - nginx:alpine
602 | description: The static image.
603 | install_command:
604 | type: string
605 | description: The install command.
606 | build_command:
607 | type: string
608 | description: The build command.
609 | start_command:
610 | type: string
611 | description: The start command.
612 | ports_mappings:
613 | type: string
614 | description: The ports mappings.
615 | base_directory:
616 | type: string
617 | description: The base directory for all commands.
618 | publish_directory:
619 | type: string
620 | description: The publish directory.
621 | health_check_enabled:
622 | type: boolean
623 | description: Health check enabled.
624 | health_check_path:
625 | type: string
626 | description: Health check path.
627 | health_check_port:
628 | type: string
629 | nullable: true
630 | description: Health check port.
631 | health_check_host:
632 | type: string
633 | nullable: true
634 | description: Health check host.
635 | health_check_method:
636 | type: string
637 | description: Health check method.
638 | health_check_return_code:
639 | type: integer
640 | description: Health check return code.
641 | health_check_scheme:
642 | type: string
643 | description: Health check scheme.
644 | health_check_response_text:
645 | type: string
646 | nullable: true
647 | description: Health check response text.
648 | health_check_interval:
649 | type: integer
650 | description: Health check interval in seconds.
651 | health_check_timeout:
652 | type: integer
653 | description: Health check timeout in seconds.
654 | health_check_retries:
655 | type: integer
656 | description: Health check retries count.
657 | health_check_start_period:
658 | type: integer
659 | description: Health check start period in seconds.
660 | limits_memory:
661 | type: string
662 | description: Memory limit.
663 | limits_memory_swap:
664 | type: string
665 | description: Memory swap limit.
666 | limits_memory_swappiness:
667 | type: integer
668 | description: Memory swappiness.
669 | limits_memory_reservation:
670 | type: string
671 | description: Memory reservation.
672 | limits_cpus:
673 | type: string
674 | description: CPU limit.
675 | limits_cpuset:
676 | type: string
677 | nullable: true
678 | description: CPU set.
679 | limits_cpu_shares:
680 | type: integer
681 | description: CPU shares.
682 | custom_labels:
683 | type: string
684 | description: Custom labels.
685 | custom_docker_run_options:
686 | type: string
687 | description: Custom docker run options.
688 | post_deployment_command:
689 | type: string
690 | description: Post deployment command.
691 | post_deployment_command_container:
692 | type: string
693 | description: Post deployment command container.
694 | pre_deployment_command:
695 | type: string
696 | description: Pre deployment command.
697 | pre_deployment_command_container:
698 | type: string
699 | description: Pre deployment command container.
700 | manual_webhook_secret_github:
701 | type: string
702 | description: Manual webhook secret for Github.
703 | manual_webhook_secret_gitlab:
704 | type: string
705 | description: Manual webhook secret for Gitlab.
706 | manual_webhook_secret_bitbucket:
707 | type: string
708 | description: Manual webhook secret for Bitbucket.
709 | manual_webhook_secret_gitea:
710 | type: string
711 | description: Manual webhook secret for Gitea.
712 | redirect:
713 | type: string
714 | nullable: true
715 | description: How to set redirect with Traefik / Caddy. www<->non-www.
716 | enum:
717 | - www
718 | - non-www
719 | - both
720 | instant_deploy:
721 | type: boolean
722 | description: The flag to indicate if the application should be deployed instantly.
723 | dockerfile:
724 | type: string
725 | description: The Dockerfile content.
726 | docker_compose_location:
727 | type: string
728 | description: The Docker Compose location.
729 | docker_compose_raw:
730 | type: string
731 | description: The Docker Compose raw content.
732 | docker_compose_custom_start_command:
733 | type: string
734 | description: The Docker Compose custom start command.
735 | docker_compose_custom_build_command:
736 | type: string
737 | description: The Docker Compose custom build command.
738 | docker_compose_domains:
739 | type: array
740 | description: The Docker Compose domains.
741 | watch_paths:
742 | type: string
743 | description: The watch paths.
744 | use_build_server:
745 | type: boolean
746 | nullable: true
747 | description: Use build server.
748 | type: object
749 | responses:
750 | '201':
751 | description: Application created successfully.
752 | content:
753 | application/json:
754 | schema:
755 | properties:
756 | uuid:
757 | type: string
758 | type: object
759 | '400':
760 | $ref: '#/components/responses/400'
761 | '401':
762 | $ref: '#/components/responses/401'
763 | security:
764 | - bearerAuth: []
765 | /applications/dockerfile:
766 | post:
767 | tags:
768 | - Applications
769 | summary: Create (Dockerfile)
770 | description: Create new application based on a simple Dockerfile.
771 | operationId: create-dockerfile-application
772 | requestBody:
773 | description: Application object that needs to be created.
774 | required: true
775 | content:
776 | application/json:
777 | schema:
778 | required:
779 | - project_uuid
780 | - server_uuid
781 | - environment_name
782 | - environment_uuid
783 | - dockerfile
784 | properties:
785 | project_uuid:
786 | type: string
787 | description: The project UUID.
788 | server_uuid:
789 | type: string
790 | description: The server UUID.
791 | environment_name:
792 | type: string
793 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
794 | environment_uuid:
795 | type: string
796 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
797 | dockerfile:
798 | type: string
799 | description: The Dockerfile content.
800 | build_pack:
801 | type: string
802 | enum:
803 | - nixpacks
804 | - static
805 | - dockerfile
806 | - dockercompose
807 | description: The build pack type.
808 | ports_exposes:
809 | type: string
810 | description: The ports to expose.
811 | destination_uuid:
812 | type: string
813 | description: The destination UUID.
814 | name:
815 | type: string
816 | description: The application name.
817 | description:
818 | type: string
819 | description: The application description.
820 | domains:
821 | type: string
822 | description: The application domains.
823 | docker_registry_image_name:
824 | type: string
825 | description: The docker registry image name.
826 | docker_registry_image_tag:
827 | type: string
828 | description: The docker registry image tag.
829 | ports_mappings:
830 | type: string
831 | description: The ports mappings.
832 | base_directory:
833 | type: string
834 | description: The base directory for all commands.
835 | health_check_enabled:
836 | type: boolean
837 | description: Health check enabled.
838 | health_check_path:
839 | type: string
840 | description: Health check path.
841 | health_check_port:
842 | type: string
843 | nullable: true
844 | description: Health check port.
845 | health_check_host:
846 | type: string
847 | nullable: true
848 | description: Health check host.
849 | health_check_method:
850 | type: string
851 | description: Health check method.
852 | health_check_return_code:
853 | type: integer
854 | description: Health check return code.
855 | health_check_scheme:
856 | type: string
857 | description: Health check scheme.
858 | health_check_response_text:
859 | type: string
860 | nullable: true
861 | description: Health check response text.
862 | health_check_interval:
863 | type: integer
864 | description: Health check interval in seconds.
865 | health_check_timeout:
866 | type: integer
867 | description: Health check timeout in seconds.
868 | health_check_retries:
869 | type: integer
870 | description: Health check retries count.
871 | health_check_start_period:
872 | type: integer
873 | description: Health check start period in seconds.
874 | limits_memory:
875 | type: string
876 | description: Memory limit.
877 | limits_memory_swap:
878 | type: string
879 | description: Memory swap limit.
880 | limits_memory_swappiness:
881 | type: integer
882 | description: Memory swappiness.
883 | limits_memory_reservation:
884 | type: string
885 | description: Memory reservation.
886 | limits_cpus:
887 | type: string
888 | description: CPU limit.
889 | limits_cpuset:
890 | type: string
891 | nullable: true
892 | description: CPU set.
893 | limits_cpu_shares:
894 | type: integer
895 | description: CPU shares.
896 | custom_labels:
897 | type: string
898 | description: Custom labels.
899 | custom_docker_run_options:
900 | type: string
901 | description: Custom docker run options.
902 | post_deployment_command:
903 | type: string
904 | description: Post deployment command.
905 | post_deployment_command_container:
906 | type: string
907 | description: Post deployment command container.
908 | pre_deployment_command:
909 | type: string
910 | description: Pre deployment command.
911 | pre_deployment_command_container:
912 | type: string
913 | description: Pre deployment command container.
914 | manual_webhook_secret_github:
915 | type: string
916 | description: Manual webhook secret for Github.
917 | manual_webhook_secret_gitlab:
918 | type: string
919 | description: Manual webhook secret for Gitlab.
920 | manual_webhook_secret_bitbucket:
921 | type: string
922 | description: Manual webhook secret for Bitbucket.
923 | manual_webhook_secret_gitea:
924 | type: string
925 | description: Manual webhook secret for Gitea.
926 | redirect:
927 | type: string
928 | nullable: true
929 | description: How to set redirect with Traefik / Caddy. www<->non-www.
930 | enum:
931 | - www
932 | - non-www
933 | - both
934 | instant_deploy:
935 | type: boolean
936 | description: The flag to indicate if the application should be deployed instantly.
937 | use_build_server:
938 | type: boolean
939 | nullable: true
940 | description: Use build server.
941 | type: object
942 | responses:
943 | '201':
944 | description: Application created successfully.
945 | content:
946 | application/json:
947 | schema:
948 | properties:
949 | uuid:
950 | type: string
951 | type: object
952 | '400':
953 | $ref: '#/components/responses/400'
954 | '401':
955 | $ref: '#/components/responses/401'
956 | security:
957 | - bearerAuth: []
958 | /applications/dockerimage:
959 | post:
960 | tags:
961 | - Applications
962 | summary: Create (Docker Image)
963 | description: Create new application based on a prebuilt docker image
964 | operationId: create-dockerimage-application
965 | requestBody:
966 | description: Application object that needs to be created.
967 | required: true
968 | content:
969 | application/json:
970 | schema:
971 | required:
972 | - project_uuid
973 | - server_uuid
974 | - environment_name
975 | - environment_uuid
976 | - docker_registry_image_name
977 | - ports_exposes
978 | properties:
979 | project_uuid:
980 | type: string
981 | description: The project UUID.
982 | server_uuid:
983 | type: string
984 | description: The server UUID.
985 | environment_name:
986 | type: string
987 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
988 | environment_uuid:
989 | type: string
990 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
991 | docker_registry_image_name:
992 | type: string
993 | description: The docker registry image name.
994 | docker_registry_image_tag:
995 | type: string
996 | description: The docker registry image tag.
997 | ports_exposes:
998 | type: string
999 | description: The ports to expose.
1000 | destination_uuid:
1001 | type: string
1002 | description: The destination UUID.
1003 | name:
1004 | type: string
1005 | description: The application name.
1006 | description:
1007 | type: string
1008 | description: The application description.
1009 | domains:
1010 | type: string
1011 | description: The application domains.
1012 | ports_mappings:
1013 | type: string
1014 | description: The ports mappings.
1015 | health_check_enabled:
1016 | type: boolean
1017 | description: Health check enabled.
1018 | health_check_path:
1019 | type: string
1020 | description: Health check path.
1021 | health_check_port:
1022 | type: string
1023 | nullable: true
1024 | description: Health check port.
1025 | health_check_host:
1026 | type: string
1027 | nullable: true
1028 | description: Health check host.
1029 | health_check_method:
1030 | type: string
1031 | description: Health check method.
1032 | health_check_return_code:
1033 | type: integer
1034 | description: Health check return code.
1035 | health_check_scheme:
1036 | type: string
1037 | description: Health check scheme.
1038 | health_check_response_text:
1039 | type: string
1040 | nullable: true
1041 | description: Health check response text.
1042 | health_check_interval:
1043 | type: integer
1044 | description: Health check interval in seconds.
1045 | health_check_timeout:
1046 | type: integer
1047 | description: Health check timeout in seconds.
1048 | health_check_retries:
1049 | type: integer
1050 | description: Health check retries count.
1051 | health_check_start_period:
1052 | type: integer
1053 | description: Health check start period in seconds.
1054 | limits_memory:
1055 | type: string
1056 | description: Memory limit.
1057 | limits_memory_swap:
1058 | type: string
1059 | description: Memory swap limit.
1060 | limits_memory_swappiness:
1061 | type: integer
1062 | description: Memory swappiness.
1063 | limits_memory_reservation:
1064 | type: string
1065 | description: Memory reservation.
1066 | limits_cpus:
1067 | type: string
1068 | description: CPU limit.
1069 | limits_cpuset:
1070 | type: string
1071 | nullable: true
1072 | description: CPU set.
1073 | limits_cpu_shares:
1074 | type: integer
1075 | description: CPU shares.
1076 | custom_labels:
1077 | type: string
1078 | description: Custom labels.
1079 | custom_docker_run_options:
1080 | type: string
1081 | description: Custom docker run options.
1082 | post_deployment_command:
1083 | type: string
1084 | description: Post deployment command.
1085 | post_deployment_command_container:
1086 | type: string
1087 | description: Post deployment command container.
1088 | pre_deployment_command:
1089 | type: string
1090 | description: Pre deployment command.
1091 | pre_deployment_command_container:
1092 | type: string
1093 | description: Pre deployment command container.
1094 | manual_webhook_secret_github:
1095 | type: string
1096 | description: Manual webhook secret for Github.
1097 | manual_webhook_secret_gitlab:
1098 | type: string
1099 | description: Manual webhook secret for Gitlab.
1100 | manual_webhook_secret_bitbucket:
1101 | type: string
1102 | description: Manual webhook secret for Bitbucket.
1103 | manual_webhook_secret_gitea:
1104 | type: string
1105 | description: Manual webhook secret for Gitea.
1106 | redirect:
1107 | type: string
1108 | nullable: true
1109 | description: How to set redirect with Traefik / Caddy. www<->non-www.
1110 | enum:
1111 | - www
1112 | - non-www
1113 | - both
1114 | instant_deploy:
1115 | type: boolean
1116 | description: The flag to indicate if the application should be deployed instantly.
1117 | use_build_server:
1118 | type: boolean
1119 | nullable: true
1120 | description: Use build server.
1121 | type: object
1122 | responses:
1123 | '201':
1124 | description: Application created successfully.
1125 | content:
1126 | application/json:
1127 | schema:
1128 | properties:
1129 | uuid:
1130 | type: string
1131 | type: object
1132 | '400':
1133 | $ref: '#/components/responses/400'
1134 | '401':
1135 | $ref: '#/components/responses/401'
1136 | security:
1137 | - bearerAuth: []
1138 | /applications/dockercompose:
1139 | post:
1140 | tags:
1141 | - Applications
1142 | summary: Create (Docker Compose)
1143 | description: Create new application based on a docker-compose file.
1144 | operationId: create-dockercompose-application
1145 | requestBody:
1146 | description: Application object that needs to be created.
1147 | required: true
1148 | content:
1149 | application/json:
1150 | schema:
1151 | required:
1152 | - project_uuid
1153 | - server_uuid
1154 | - environment_name
1155 | - environment_uuid
1156 | - docker_compose_raw
1157 | properties:
1158 | project_uuid:
1159 | type: string
1160 | description: The project UUID.
1161 | server_uuid:
1162 | type: string
1163 | description: The server UUID.
1164 | environment_name:
1165 | type: string
1166 | description: The environment name. You need to provide at least one of environment_name or environment_uuid.
1167 | environment_uuid:
1168 | type: string
1169 | description: The environment UUID. You need to provide at least one of environment_name or environment_uuid.
1170 | docker_compose_raw:
1171 | type: string
1172 | description: The Docker Compose raw content.
1173 | destination_uuid:
1174 | type: string
1175 | description: The destination UUID if the server has more than one destinations.
1176 | name:
1177 | type: string
1178 | description: The application name.
1179 | description:
1180 | type: string
1181 | description: The application description.
1182 | instant_deploy:
1183 | type: boolean
1184 | description: The flag to indicate if the application should be deployed instantly.
1185 | use_build_server:
1186 | type: boolean
1187 | nullable: true
1188 | description: Use build server.
1189 | type: object
1190 | responses:
1191 | '201':
1192 | description: Application created successfully.
1193 | content:
1194 | application/json:
1195 | schema:
1196 | properties:
1197 | uuid:
1198 | type: string
1199 | type: object
1200 | '400':
1201 | $ref: '#/components/responses/400'
1202 | '401':
1203 | $ref: '#/components/responses/401'
1204 | security:
1205 | - bearerAuth: []
1206 | /applications/{uuid}:
1207 | get:
1208 | tags:
1209 | - Applications
1210 | summary: Get
1211 | description: Get application by UUID.
1212 | operationId: get-application-by-uuid
1213 | parameters:
1214 | - name: uuid
1215 | in: path
1216 | description: UUID of the application.
1217 | required: true
1218 | schema:
1219 | type: string
1220 | format: uuid
1221 | responses:
1222 | '200':
1223 | description: Get application by UUID.
1224 | content:
1225 | application/json:
1226 | schema:
1227 | $ref: '#/components/schemas/Application'
1228 | '400':
1229 | $ref: '#/components/responses/400'
1230 | '401':
1231 | $ref: '#/components/responses/401'
1232 | '404':
1233 | $ref: '#/components/responses/404'
1234 | security:
1235 | - bearerAuth: []
1236 | delete:
1237 | tags:
1238 | - Applications
1239 | summary: Delete
1240 | description: Delete application by UUID.
1241 | operationId: delete-application-by-uuid
1242 | parameters:
1243 | - name: uuid
1244 | in: path
1245 | description: UUID of the application.
1246 | required: true
1247 | schema:
1248 | type: string
1249 | format: uuid
1250 | - name: delete_configurations
1251 | in: query
1252 | description: Delete configurations.
1253 | required: false
1254 | schema:
1255 | type: boolean
1256 | default: true
1257 | - name: delete_volumes
1258 | in: query
1259 | description: Delete volumes.
1260 | required: false
1261 | schema:
1262 | type: boolean
1263 | default: true
1264 | - name: docker_cleanup
1265 | in: query
1266 | description: Run docker cleanup.
1267 | required: false
1268 | schema:
1269 | type: boolean
1270 | default: true
1271 | - name: delete_connected_networks
1272 | in: query
1273 | description: Delete connected networks.
1274 | required: false
1275 | schema:
1276 | type: boolean
1277 | default: true
1278 | responses:
1279 | '200':
1280 | description: Application deleted.
1281 | content:
1282 | application/json:
1283 | schema:
1284 | properties:
1285 | message:
1286 | type: string
1287 | example: Application deleted.
1288 | type: object
1289 | '400':
1290 | $ref: '#/components/responses/400'
1291 | '401':
1292 | $ref: '#/components/responses/401'
1293 | '404':
1294 | $ref: '#/components/responses/404'
1295 | security:
1296 | - bearerAuth: []
1297 | patch:
1298 | tags:
1299 | - Applications
1300 | summary: Update
1301 | description: Update application by UUID.
1302 | operationId: update-application-by-uuid
1303 | requestBody:
1304 | description: Application updated.
1305 | required: true
1306 | content:
1307 | application/json:
1308 | schema:
1309 | properties:
1310 | project_uuid:
1311 | type: string
1312 | description: The project UUID.
1313 | server_uuid:
1314 | type: string
1315 | description: The server UUID.
1316 | environment_name:
1317 | type: string
1318 | description: The environment name.
1319 | github_app_uuid:
1320 | type: string
1321 | description: The Github App UUID.
1322 | git_repository:
1323 | type: string
1324 | description: The git repository URL.
1325 | git_branch:
1326 | type: string
1327 | description: The git branch.
1328 | ports_exposes:
1329 | type: string
1330 | description: The ports to expose.
1331 | destination_uuid:
1332 | type: string
1333 | description: The destination UUID.
1334 | build_pack:
1335 | type: string
1336 | enum:
1337 | - nixpacks
1338 | - static
1339 | - dockerfile
1340 | - dockercompose
1341 | description: The build pack type.
1342 | name:
1343 | type: string
1344 | description: The application name.
1345 | description:
1346 | type: string
1347 | description: The application description.
1348 | domains:
1349 | type: string
1350 | description: The application domains.
1351 | git_commit_sha:
1352 | type: string
1353 | description: The git commit SHA.
1354 | docker_registry_image_name:
1355 | type: string
1356 | description: The docker registry image name.
1357 | docker_registry_image_tag:
1358 | type: string
1359 | description: The docker registry image tag.
1360 | is_static:
1361 | type: boolean
1362 | description: The flag to indicate if the application is static.
1363 | install_command:
1364 | type: string
1365 | description: The install command.
1366 | build_command:
1367 | type: string
1368 | description: The build command.
1369 | start_command:
1370 | type: string
1371 | description: The start command.
1372 | ports_mappings:
1373 | type: string
1374 | description: The ports mappings.
1375 | base_directory:
1376 | type: string
1377 | description: The base directory for all commands.
1378 | publish_directory:
1379 | type: string
1380 | description: The publish directory.
1381 | health_check_enabled:
1382 | type: boolean
1383 | description: Health check enabled.
1384 | health_check_path:
1385 | type: string
1386 | description: Health check path.
1387 | health_check_port:
1388 | type: string
1389 | nullable: true
1390 | description: Health check port.
1391 | health_check_host:
1392 | type: string
1393 | nullable: true
1394 | description: Health check host.
1395 | health_check_method:
1396 | type: string
1397 | description: Health check method.
1398 | health_check_return_code:
1399 | type: integer
1400 | description: Health check return code.
1401 | health_check_scheme:
1402 | type: string
1403 | description: Health check scheme.
1404 | health_check_response_text:
1405 | type: string
1406 | nullable: true
1407 | description: Health check response text.
1408 | health_check_interval:
1409 | type: integer
1410 | description: Health check interval in seconds.
1411 | health_check_timeout:
1412 | type: integer
1413 | description: Health check timeout in seconds.
1414 | health_check_retries:
1415 | type: integer
1416 | description: Health check retries count.
1417 | health_check_start_period:
1418 | type: integer
1419 | description: Health check start period in seconds.
1420 | limits_memory:
1421 | type: string
1422 | description: Memory limit.
1423 | limits_memory_swap:
1424 | type: string
1425 | description: Memory swap limit.
1426 | limits_memory_swappiness:
1427 | type: integer
1428 | description: Memory swappiness.
1429 | limits_memory_reservation:
1430 | type: string
1431 | description: Memory reservation.
1432 | limits_cpus:
1433 | type: string
1434 | description: CPU limit.
1435 | limits_cpuset:
1436 | type: string
1437 | nullable: true
1438 | description: CPU set.
1439 | limits_cpu_shares:
1440 | type: integer
1441 | description: CPU shares.
1442 | custom_labels:
1443 | type: string
1444 | description: Custom labels.
1445 | custom_docker_run_options:
1446 | type: string
1447 | description: Custom docker run options.
1448 | post_deployment_command:
1449 | type: string
1450 | description: Post deployment command.
1451 | post_deployment_command_container:
1452 | type: string
1453 | description: Post deployment command container.
1454 | pre_deployment_command:
1455 | type: string
1456 | description: Pre deployment command.
1457 | pre_deployment_command_container:
1458 | type: string
1459 | description: Pre deployment command container.
1460 | manual_webhook_secret_github:
1461 | type: string
1462 | description: Manual webhook secret for Github.
1463 | manual_webhook_secret_gitlab:
1464 | type: string
1465 | description: Manual webhook secret for Gitlab.
1466 | manual_webhook_secret_bitbucket:
1467 | type: string
1468 | description: Manual webhook secret for Bitbucket.
1469 | manual_webhook_secret_gitea:
1470 | type: string
1471 | description: Manual webhook secret for Gitea.
1472 | redirect:
1473 | type: string
1474 | nullable: true
1475 | description: How to set redirect with Traefik / Caddy. www<->non-www.
1476 | enum:
1477 | - www
1478 | - non-www
1479 | - both
1480 | instant_deploy:
1481 | type: boolean
1482 | description: The flag to indicate if the application should be deployed instantly.
1483 | dockerfile:
1484 | type: string
1485 | description: The Dockerfile content.
1486 | docker_compose_location:
1487 | type: string
1488 | description: The Docker Compose location.
1489 | docker_compose_raw:
1490 | type: string
1491 | description: The Docker Compose raw content.
1492 | docker_compose_custom_start_command:
1493 | type: string
1494 | description: The Docker Compose custom start command.
1495 | docker_compose_custom_build_command:
1496 | type: string
1497 | description: The Docker Compose custom build command.
1498 | docker_compose_domains:
1499 | type: array
1500 | description: The Docker Compose domains.
1501 | watch_paths:
1502 | type: string
1503 | description: The watch paths.
1504 | use_build_server:
1505 | type: boolean
1506 | nullable: true
1507 | description: Use build server.
1508 | type: object
1509 | responses:
1510 | '200':
1511 | description: Application updated.
1512 | content:
1513 | application/json:
1514 | schema:
1515 | properties:
1516 | uuid:
1517 | type: string
1518 | type: object
1519 | '400':
1520 | $ref: '#/components/responses/400'
1521 | '401':
1522 | $ref: '#/components/responses/401'
1523 | '404':
1524 | $ref: '#/components/responses/404'
1525 | security:
1526 | - bearerAuth: []
1527 | /applications/{uuid}/envs:
1528 | get:
1529 | tags:
1530 | - Applications
1531 | summary: List Envs
1532 | description: List all envs by application UUID.
1533 | operationId: list-envs-by-application-uuid
1534 | parameters:
1535 | - name: uuid
1536 | in: path
1537 | description: UUID of the application.
1538 | required: true
1539 | schema:
1540 | type: string
1541 | format: uuid
1542 | responses:
1543 | '200':
1544 | description: All environment variables by application UUID.
1545 | content:
1546 | application/json:
1547 | schema:
1548 | type: array
1549 | items:
1550 | $ref: '#/components/schemas/EnvironmentVariable'
1551 | '400':
1552 | $ref: '#/components/responses/400'
1553 | '401':
1554 | $ref: '#/components/responses/401'
1555 | '404':
1556 | $ref: '#/components/responses/404'
1557 | security:
1558 | - bearerAuth: []
1559 | post:
1560 | tags:
1561 | - Applications
1562 | summary: Create Env
1563 | description: Create env by application UUID.
1564 | operationId: create-env-by-application-uuid
1565 | parameters:
1566 | - name: uuid
1567 | in: path
1568 | description: UUID of the application.
1569 | required: true
1570 | schema:
1571 | type: string
1572 | format: uuid
1573 | requestBody:
1574 | description: Env created.
1575 | required: true
1576 | content:
1577 | application/json:
1578 | schema:
1579 | properties:
1580 | key:
1581 | type: string
1582 | description: The key of the environment variable.
1583 | value:
1584 | type: string
1585 | description: The value of the environment variable.
1586 | is_preview:
1587 | type: boolean
1588 | description: The flag to indicate if the environment variable is used in preview deployments.
1589 | is_build_time:
1590 | type: boolean
1591 | description: The flag to indicate if the environment variable is used in build time.
1592 | is_literal:
1593 | type: boolean
1594 | description: The flag to indicate if the environment variable is a literal, nothing espaced.
1595 | is_multiline:
1596 | type: boolean
1597 | description: The flag to indicate if the environment variable is multiline.
1598 | is_shown_once:
1599 | type: boolean
1600 | description: The flag to indicate if the environment variable's value is shown on the UI.
1601 | type: object
1602 | responses:
1603 | '201':
1604 | description: Environment variable created.
1605 | content:
1606 | application/json:
1607 | schema:
1608 | properties:
1609 | uuid:
1610 | type: string
1611 | example: nc0k04gk8g0cgsk440g0koko
1612 | type: object
1613 | '400':
1614 | $ref: '#/components/responses/400'
1615 | '401':
1616 | $ref: '#/components/responses/401'
1617 | '404':
1618 | $ref: '#/components/responses/404'
1619 | security:
1620 | - bearerAuth: []
1621 | patch:
1622 | tags:
1623 | - Applications
1624 | summary: Update Env
1625 | description: Update env by application UUID.
1626 | operationId: update-env-by-application-uuid
1627 | parameters:
1628 | - name: uuid
1629 | in: path
1630 | description: UUID of the application.
1631 | required: true
1632 | schema:
1633 | type: string
1634 | format: uuid
1635 | requestBody:
1636 | description: Env updated.
1637 | required: true
1638 | content:
1639 | application/json:
1640 | schema:
1641 | required:
1642 | - key
1643 | - value
1644 | properties:
1645 | key:
1646 | type: string
1647 | description: The key of the environment variable.
1648 | value:
1649 | type: string
1650 | description: The value of the environment variable.
1651 | is_preview:
1652 | type: boolean
1653 | description: The flag to indicate if the environment variable is used in preview deployments.
1654 | is_build_time:
1655 | type: boolean
1656 | description: The flag to indicate if the environment variable is used in build time.
1657 | is_literal:
1658 | type: boolean
1659 | description: The flag to indicate if the environment variable is a literal, nothing espaced.
1660 | is_multiline:
1661 | type: boolean
1662 | description: The flag to indicate if the environment variable is multiline.
1663 | is_shown_once:
1664 | type: boolean
1665 | description: The flag to indicate if the environment variable's value is shown on the UI.
1666 | type: object
1667 | responses:
1668 | '201':
1669 | description: Environment variable updated.
1670 | content:
1671 | application/json:
1672 | schema:
1673 | properties:
1674 | message:
1675 | type: string
1676 | example: Environment variable updated.
1677 | type: object
1678 | '400':
1679 | $ref: '#/components/responses/400'
1680 | '401':
1681 | $ref: '#/components/responses/401'
1682 | '404':
1683 | $ref: '#/components/responses/404'
1684 | security:
1685 | - bearerAuth: []
1686 | /applications/{uuid}/envs/bulk:
1687 | patch:
1688 | tags:
1689 | - Applications
1690 | summary: Update Envs (Bulk)
1691 | description: Update multiple envs by application UUID.
1692 | operationId: update-envs-by-application-uuid
1693 | parameters:
1694 | - name: uuid
1695 | in: path
1696 | description: UUID of the application.
1697 | required: true
1698 | schema:
1699 | type: string
1700 | format: uuid
1701 | requestBody:
1702 | description: Bulk envs updated.
1703 | required: true
1704 | content:
1705 | application/json:
1706 | schema:
1707 | required:
1708 | - data
1709 | properties:
1710 | data:
1711 | type: array
1712 | items:
1713 | properties:
1714 | key:
1715 | type: string
1716 | description: The key of the environment variable.
1717 | value:
1718 | type: string
1719 | description: The value of the environment variable.
1720 | is_preview:
1721 | type: boolean
1722 | description: The flag to indicate if the environment variable is used in preview deployments.
1723 | is_build_time:
1724 | type: boolean
1725 | description: The flag to indicate if the environment variable is used in build time.
1726 | is_literal:
1727 | type: boolean
1728 | description: The flag to indicate if the environment variable is a literal, nothing espaced.
1729 | is_multiline:
1730 | type: boolean
1731 | description: The flag to indicate if the environment variable is multiline.
1732 | is_shown_once:
1733 | type: boolean
1734 | description: The flag to indicate if the environment variable's value is shown on the UI.
1735 | type: object
1736 | type: object
1737 | responses:
1738 | '201':
1739 | description: Environment variables updated.
1740 | content:
1741 | application/json:
1742 | schema:
1743 | properties:
1744 | message:
1745 | type: string
1746 | example: Environment variables updated.
1747 | type: object
1748 | '400':
1749 | $ref: '#/components/responses/400'
1750 | '401':
1751 | $ref: '#/components/responses/401'
1752 | '404':
1753 | $ref: '#/components/responses/404'
1754 | security:
1755 | - bearerAuth: []
1756 | /applications/{uuid}/envs/{env_uuid}:
1757 | delete:
1758 | tags:
1759 | - Applications
1760 | summary: Delete Env
1761 | description: Delete env by UUID.
1762 | operationId: delete-env-by-application-uuid
1763 | parameters:
1764 | - name: uuid
1765 | in: path
1766 | description: UUID of the application.
1767 | required: true
1768 | schema:
1769 | type: string
1770 | format: uuid
1771 | - name: env_uuid
1772 | in: path
1773 | description: UUID of the environment variable.
1774 | required: true
1775 | schema:
1776 | type: string
1777 | format: uuid
1778 | responses:
1779 | '200':
1780 | description: Environment variable deleted.
1781 | content:
1782 | application/json:
1783 | schema:
1784 | properties:
1785 | message:
1786 | type: string
1787 | example: Environment variable deleted.
1788 | type: object
1789 | '400':
1790 | $ref: '#/components/responses/400'
1791 | '401':
1792 | $ref: '#/components/responses/401'
1793 | '404':
1794 | $ref: '#/components/responses/404'
1795 | security:
1796 | - bearerAuth: []
1797 | /applications/{uuid}/start:
1798 | get:
1799 | tags:
1800 | - Applications
1801 | summary: Start
1802 | description: Start application. `Post` request is also accepted.
1803 | operationId: start-application-by-uuid
1804 | parameters:
1805 | - name: uuid
1806 | in: path
1807 | description: UUID of the application.
1808 | required: true
1809 | schema:
1810 | type: string
1811 | format: uuid
1812 | - name: force
1813 | in: query
1814 | description: Force rebuild.
1815 | schema:
1816 | type: boolean
1817 | default: false
1818 | - name: instant_deploy
1819 | in: query
1820 | description: Instant deploy (skip queuing).
1821 | schema:
1822 | type: boolean
1823 | default: false
1824 | responses:
1825 | '200':
1826 | description: Start application.
1827 | content:
1828 | application/json:
1829 | schema:
1830 | properties:
1831 | message:
1832 | type: string
1833 | example: Deployment request queued.
1834 | description: Message.
1835 | deployment_uuid:
1836 | type: string
1837 | example: doogksw
1838 | description: UUID of the deployment.
1839 | type: object
1840 | '400':
1841 | $ref: '#/components/responses/400'
1842 | '401':
1843 | $ref: '#/components/responses/401'
1844 | '404':
1845 | $ref: '#/components/responses/404'
1846 | security:
1847 | - bearerAuth: []
1848 | /applications/{uuid}/stop:
1849 | get:
1850 | tags:
1851 | - Applications
1852 | summary: Stop
1853 | description: Stop application. `Post` request is also accepted.
1854 | operationId: stop-application-by-uuid
1855 | parameters:
1856 | - name: uuid
1857 | in: path
1858 | description: UUID of the application.
1859 | required: true
1860 | schema:
1861 | type: string
1862 | format: uuid
1863 | responses:
1864 | '200':
1865 | description: Stop application.
1866 | content:
1867 | application/json:
1868 | schema:
1869 | properties:
1870 | message:
1871 | type: string
1872 | example: Application stopping request queued.
1873 | type: object
1874 | '400':
1875 | $ref: '#/components/responses/400'
1876 | '401':
1877 | $ref: '#/components/responses/401'
1878 | '404':
1879 | $ref: '#/components/responses/404'
1880 | security:
1881 | - bearerAuth: []
1882 | /applications/{uuid}/restart:
1883 | get:
1884 | tags:
1885 | - Applications
1886 | summary: Restart
1887 | description: Restart application. `Post` request is also accepted.
1888 | operationId: restart-application-by-uuid
1889 | parameters:
1890 | - name: uuid
1891 | in: path
1892 | description: UUID of the application.
1893 | required: true
1894 | schema:
1895 | type: string
1896 | format: uuid
1897 | responses:
1898 | '200':
1899 | description: Restart application.
1900 | content:
1901 | application/json:
1902 | schema:
1903 | properties:
1904 | message:
1905 | type: string
1906 | example: Restart request queued.
1907 | deployment_uuid:
1908 | type: string
1909 | example: doogksw
1910 | description: UUID of the deployment.
1911 | type: object
1912 | '400':
1913 | $ref: '#/components/responses/400'
1914 | '401':
1915 | $ref: '#/components/responses/401'
1916 | '404':
1917 | $ref: '#/components/responses/404'
1918 | security:
1919 | - bearerAuth: []
1920 | /applications/{uuid}/execute:
1921 | post:
1922 | tags:
1923 | - Applications
1924 | summary: Execute Command
1925 | description: Execute a command on the application's current container.
1926 | operationId: execute-command-application
1927 | parameters:
1928 | - name: uuid
1929 | in: path
1930 | description: UUID of the application.
1931 | required: true
1932 | schema:
1933 | type: string
1934 | format: uuid
1935 | requestBody:
1936 | description: Command to execute.
1937 | required: true
1938 | content:
1939 | application/json:
1940 | schema:
1941 | properties:
1942 | command:
1943 | type: string
1944 | description: Command to execute.
1945 | type: object
1946 | responses:
1947 | '200':
1948 | description: Execute a command on the application's current container.
1949 | content:
1950 | application/json:
1951 | schema:
1952 | properties:
1953 | message:
1954 | type: string
1955 | example: Command executed.
1956 | response:
1957 | type: string
1958 | type: object
1959 | '400':
1960 | $ref: '#/components/responses/400'
1961 | '401':
1962 | $ref: '#/components/responses/401'
1963 | '404':
1964 | $ref: '#/components/responses/404'
1965 | security:
1966 | - bearerAuth: []
1967 |
```