Coolify MCP Server

openapi: 3.1.0 info: title: Coolify version: '0.1' paths: /applications: get: tags: - Applications summary: List description: List all applications. operationId: list-applications responses: '200': description: Get all applications. content: application/json: schema: type: array items: $ref: '#/components/schemas/Application' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/public: post: tags: - Applications summary: Create (Public) description: Create new application based on a public git repository. operationId: create-public-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - git_repository - git_branch - build_pack - ports_exposes properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. git_repository: type: string description: The git repository URL. git_branch: type: string description: The git branch. build_pack: type: string enum: - nixpacks - static - dockerfile - dockercompose description: The build pack type. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. git_commit_sha: type: string description: The git commit SHA. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. is_static: type: boolean description: The flag to indicate if the application is static. static_image: type: string enum: - nginx:alpine description: The static image. install_command: type: string description: The install command. build_command: type: string description: The build command. start_command: type: string description: The start command. ports_mappings: type: string description: The ports mappings. base_directory: type: string description: The base directory for all commands. publish_directory: type: string description: The publish directory. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. dockerfile: type: string description: The Dockerfile content. docker_compose_location: type: string description: The Docker Compose location. docker_compose_raw: type: string description: The Docker Compose raw content. docker_compose_custom_start_command: type: string description: The Docker Compose custom start command. docker_compose_custom_build_command: type: string description: The Docker Compose custom build command. docker_compose_domains: type: array description: The Docker Compose domains. watch_paths: type: string description: The watch paths. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/private-github-app: post: tags: - Applications summary: Create (Private - GH App) description: Create new application based on a private repository through a Github App. operationId: create-private-github-app-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - github_app_uuid - git_repository - git_branch - build_pack - ports_exposes properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. github_app_uuid: type: string description: The Github App UUID. git_repository: type: string description: The git repository URL. git_branch: type: string description: The git branch. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. build_pack: type: string enum: - nixpacks - static - dockerfile - dockercompose description: The build pack type. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. git_commit_sha: type: string description: The git commit SHA. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. is_static: type: boolean description: The flag to indicate if the application is static. static_image: type: string enum: - nginx:alpine description: The static image. install_command: type: string description: The install command. build_command: type: string description: The build command. start_command: type: string description: The start command. ports_mappings: type: string description: The ports mappings. base_directory: type: string description: The base directory for all commands. publish_directory: type: string description: The publish directory. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. dockerfile: type: string description: The Dockerfile content. docker_compose_location: type: string description: The Docker Compose location. docker_compose_raw: type: string description: The Docker Compose raw content. docker_compose_custom_start_command: type: string description: The Docker Compose custom start command. docker_compose_custom_build_command: type: string description: The Docker Compose custom build command. docker_compose_domains: type: array description: The Docker Compose domains. watch_paths: type: string description: The watch paths. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/private-deploy-key: post: tags: - Applications summary: Create (Private - Deploy Key) description: Create new application based on a private repository through a Deploy Key. operationId: create-private-deploy-key-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - private_key_uuid - git_repository - git_branch - build_pack - ports_exposes properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. private_key_uuid: type: string description: The private key UUID. git_repository: type: string description: The git repository URL. git_branch: type: string description: The git branch. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. build_pack: type: string enum: - nixpacks - static - dockerfile - dockercompose description: The build pack type. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. git_commit_sha: type: string description: The git commit SHA. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. is_static: type: boolean description: The flag to indicate if the application is static. static_image: type: string enum: - nginx:alpine description: The static image. install_command: type: string description: The install command. build_command: type: string description: The build command. start_command: type: string description: The start command. ports_mappings: type: string description: The ports mappings. base_directory: type: string description: The base directory for all commands. publish_directory: type: string description: The publish directory. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. dockerfile: type: string description: The Dockerfile content. docker_compose_location: type: string description: The Docker Compose location. docker_compose_raw: type: string description: The Docker Compose raw content. docker_compose_custom_start_command: type: string description: The Docker Compose custom start command. docker_compose_custom_build_command: type: string description: The Docker Compose custom build command. docker_compose_domains: type: array description: The Docker Compose domains. watch_paths: type: string description: The watch paths. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/dockerfile: post: tags: - Applications summary: Create (Dockerfile) description: Create new application based on a simple Dockerfile. operationId: create-dockerfile-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - dockerfile properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. dockerfile: type: string description: The Dockerfile content. build_pack: type: string enum: - nixpacks - static - dockerfile - dockercompose description: The build pack type. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. ports_mappings: type: string description: The ports mappings. base_directory: type: string description: The base directory for all commands. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/dockerimage: post: tags: - Applications summary: Create (Docker Image) description: Create new application based on a prebuilt docker image operationId: create-dockerimage-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - docker_registry_image_name - ports_exposes properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. ports_mappings: type: string description: The ports mappings. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/dockercompose: post: tags: - Applications summary: Create (Docker Compose) description: Create new application based on a docker-compose file. operationId: create-dockercompose-application requestBody: description: Application object that needs to be created. required: true content: application/json: schema: required: - project_uuid - server_uuid - environment_name - environment_uuid - docker_compose_raw properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. You need to provide at least one of environment_name or environment_uuid. environment_uuid: type: string description: The environment UUID. You need to provide at least one of environment_name or environment_uuid. docker_compose_raw: type: string description: The Docker Compose raw content. destination_uuid: type: string description: The destination UUID if the server has more than one destinations. name: type: string description: The application name. description: type: string description: The application description. instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '201': description: Application created successfully. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - bearerAuth: [] /applications/{uuid}: get: tags: - Applications summary: Get description: Get application by UUID. operationId: get-application-by-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid responses: '200': description: Get application by UUID. content: application/json: schema: $ref: '#/components/schemas/Application' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] delete: tags: - Applications summary: Delete description: Delete application by UUID. operationId: delete-application-by-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid - name: delete_configurations in: query description: Delete configurations. required: false schema: type: boolean default: true - name: delete_volumes in: query description: Delete volumes. required: false schema: type: boolean default: true - name: docker_cleanup in: query description: Run docker cleanup. required: false schema: type: boolean default: true - name: delete_connected_networks in: query description: Delete connected networks. required: false schema: type: boolean default: true responses: '200': description: Application deleted. content: application/json: schema: properties: message: type: string example: Application deleted. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] patch: tags: - Applications summary: Update description: Update application by UUID. operationId: update-application-by-uuid requestBody: description: Application updated. required: true content: application/json: schema: properties: project_uuid: type: string description: The project UUID. server_uuid: type: string description: The server UUID. environment_name: type: string description: The environment name. github_app_uuid: type: string description: The Github App UUID. git_repository: type: string description: The git repository URL. git_branch: type: string description: The git branch. ports_exposes: type: string description: The ports to expose. destination_uuid: type: string description: The destination UUID. build_pack: type: string enum: - nixpacks - static - dockerfile - dockercompose description: The build pack type. name: type: string description: The application name. description: type: string description: The application description. domains: type: string description: The application domains. git_commit_sha: type: string description: The git commit SHA. docker_registry_image_name: type: string description: The docker registry image name. docker_registry_image_tag: type: string description: The docker registry image tag. is_static: type: boolean description: The flag to indicate if the application is static. install_command: type: string description: The install command. build_command: type: string description: The build command. start_command: type: string description: The start command. ports_mappings: type: string description: The ports mappings. base_directory: type: string description: The base directory for all commands. publish_directory: type: string description: The publish directory. health_check_enabled: type: boolean description: Health check enabled. health_check_path: type: string description: Health check path. health_check_port: type: string nullable: true description: Health check port. health_check_host: type: string nullable: true description: Health check host. health_check_method: type: string description: Health check method. health_check_return_code: type: integer description: Health check return code. health_check_scheme: type: string description: Health check scheme. health_check_response_text: type: string nullable: true description: Health check response text. health_check_interval: type: integer description: Health check interval in seconds. health_check_timeout: type: integer description: Health check timeout in seconds. health_check_retries: type: integer description: Health check retries count. health_check_start_period: type: integer description: Health check start period in seconds. limits_memory: type: string description: Memory limit. limits_memory_swap: type: string description: Memory swap limit. limits_memory_swappiness: type: integer description: Memory swappiness. limits_memory_reservation: type: string description: Memory reservation. limits_cpus: type: string description: CPU limit. limits_cpuset: type: string nullable: true description: CPU set. limits_cpu_shares: type: integer description: CPU shares. custom_labels: type: string description: Custom labels. custom_docker_run_options: type: string description: Custom docker run options. post_deployment_command: type: string description: Post deployment command. post_deployment_command_container: type: string description: Post deployment command container. pre_deployment_command: type: string description: Pre deployment command. pre_deployment_command_container: type: string description: Pre deployment command container. manual_webhook_secret_github: type: string description: Manual webhook secret for Github. manual_webhook_secret_gitlab: type: string description: Manual webhook secret for Gitlab. manual_webhook_secret_bitbucket: type: string description: Manual webhook secret for Bitbucket. manual_webhook_secret_gitea: type: string description: Manual webhook secret for Gitea. redirect: type: string nullable: true description: How to set redirect with Traefik / Caddy. www<->non-www. enum: - www - non-www - both instant_deploy: type: boolean description: The flag to indicate if the application should be deployed instantly. dockerfile: type: string description: The Dockerfile content. docker_compose_location: type: string description: The Docker Compose location. docker_compose_raw: type: string description: The Docker Compose raw content. docker_compose_custom_start_command: type: string description: The Docker Compose custom start command. docker_compose_custom_build_command: type: string description: The Docker Compose custom build command. docker_compose_domains: type: array description: The Docker Compose domains. watch_paths: type: string description: The watch paths. use_build_server: type: boolean nullable: true description: Use build server. type: object responses: '200': description: Application updated. content: application/json: schema: properties: uuid: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/envs: get: tags: - Applications summary: List Envs description: List all envs by application UUID. operationId: list-envs-by-application-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid responses: '200': description: All environment variables by application UUID. content: application/json: schema: type: array items: $ref: '#/components/schemas/EnvironmentVariable' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] post: tags: - Applications summary: Create Env description: Create env by application UUID. operationId: create-env-by-application-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid requestBody: description: Env created. required: true content: application/json: schema: properties: key: type: string description: The key of the environment variable. value: type: string description: The value of the environment variable. is_preview: type: boolean description: The flag to indicate if the environment variable is used in preview deployments. is_build_time: type: boolean description: The flag to indicate if the environment variable is used in build time. is_literal: type: boolean description: The flag to indicate if the environment variable is a literal, nothing espaced. is_multiline: type: boolean description: The flag to indicate if the environment variable is multiline. is_shown_once: type: boolean description: The flag to indicate if the environment variable's value is shown on the UI. type: object responses: '201': description: Environment variable created. content: application/json: schema: properties: uuid: type: string example: nc0k04gk8g0cgsk440g0koko type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] patch: tags: - Applications summary: Update Env description: Update env by application UUID. operationId: update-env-by-application-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid requestBody: description: Env updated. required: true content: application/json: schema: required: - key - value properties: key: type: string description: The key of the environment variable. value: type: string description: The value of the environment variable. is_preview: type: boolean description: The flag to indicate if the environment variable is used in preview deployments. is_build_time: type: boolean description: The flag to indicate if the environment variable is used in build time. is_literal: type: boolean description: The flag to indicate if the environment variable is a literal, nothing espaced. is_multiline: type: boolean description: The flag to indicate if the environment variable is multiline. is_shown_once: type: boolean description: The flag to indicate if the environment variable's value is shown on the UI. type: object responses: '201': description: Environment variable updated. content: application/json: schema: properties: message: type: string example: Environment variable updated. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/envs/bulk: patch: tags: - Applications summary: Update Envs (Bulk) description: Update multiple envs by application UUID. operationId: update-envs-by-application-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid requestBody: description: Bulk envs updated. required: true content: application/json: schema: required: - data properties: data: type: array items: properties: key: type: string description: The key of the environment variable. value: type: string description: The value of the environment variable. is_preview: type: boolean description: The flag to indicate if the environment variable is used in preview deployments. is_build_time: type: boolean description: The flag to indicate if the environment variable is used in build time. is_literal: type: boolean description: The flag to indicate if the environment variable is a literal, nothing espaced. is_multiline: type: boolean description: The flag to indicate if the environment variable is multiline. is_shown_once: type: boolean description: The flag to indicate if the environment variable's value is shown on the UI. type: object type: object responses: '201': description: Environment variables updated. content: application/json: schema: properties: message: type: string example: Environment variables updated. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/envs/{env_uuid}: delete: tags: - Applications summary: Delete Env description: Delete env by UUID. operationId: delete-env-by-application-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid - name: env_uuid in: path description: UUID of the environment variable. required: true schema: type: string format: uuid responses: '200': description: Environment variable deleted. content: application/json: schema: properties: message: type: string example: Environment variable deleted. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/start: get: tags: - Applications summary: Start description: Start application. `Post` request is also accepted. operationId: start-application-by-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid - name: force in: query description: Force rebuild. schema: type: boolean default: false - name: instant_deploy in: query description: Instant deploy (skip queuing). schema: type: boolean default: false responses: '200': description: Start application. content: application/json: schema: properties: message: type: string example: Deployment request queued. description: Message. deployment_uuid: type: string example: doogksw description: UUID of the deployment. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/stop: get: tags: - Applications summary: Stop description: Stop application. `Post` request is also accepted. operationId: stop-application-by-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid responses: '200': description: Stop application. content: application/json: schema: properties: message: type: string example: Application stopping request queued. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/restart: get: tags: - Applications summary: Restart description: Restart application. `Post` request is also accepted. operationId: restart-application-by-uuid parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid responses: '200': description: Restart application. content: application/json: schema: properties: message: type: string example: Restart request queued. deployment_uuid: type: string example: doogksw description: UUID of the deployment. type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: [] /applications/{uuid}/execute: post: tags: - Applications summary: Execute Command description: Execute a command on the application's current container. operationId: execute-command-application parameters: - name: uuid in: path description: UUID of the application. required: true schema: type: string format: uuid requestBody: description: Command to execute. required: true content: application/json: schema: properties: command: type: string description: Command to execute. type: object responses: '200': description: Execute a command on the application's current container. content: application/json: schema: properties: message: type: string example: Command executed. response: type: string type: object '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - bearerAuth: []