v1

latestOpenAPI 3.1.02026-07-1213613295.5 KB
Applications

Update

Update application by UUID.

patch/applications/{uuid}

Path parameters

uuidstring required

UUID of the application.

Request body

project_uuidstring

The project UUID.

server_uuidstring

The server UUID.

environment_namestring

The environment name.

github_app_uuidstring

The Github App UUID.

git_repositorystring

The git repository URL.

git_branchstring

The git branch.

ports_exposesstring

The ports to expose.

destination_uuidstring

The destination UUID.

build_pack'nixpacks' | 'railpack' | 'static' | 'dockerfile' | 'dockercompose'

The build pack type.

namestring

The application name.

descriptionstring

The application description.

domainsstring

The application URLs in a comma-separated list.

git_commit_shastring

The git commit SHA.

docker_registry_image_namestring

The docker registry image name.

docker_registry_image_tagstring

The docker registry image tag.

is_staticboolean

The flag to indicate if the application is static.

is_spaboolean

The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.

is_auto_deploy_enabledboolean

The flag to indicate if auto-deploy is enabled on git push. Defaults to true.

is_force_https_enabledboolean

The flag to indicate if HTTPS is forced. Defaults to true.

install_commandstring

The install command.

build_commandstring

The build command.

start_commandstring

The start command.

ports_mappingsstring

The ports mappings.

base_directorystring

The base directory for all commands.

publish_directorystring

The publish directory.

health_check_enabledboolean

Health check enabled.

health_check_pathstring

Health check path.

health_check_portstring nullable

Health check port.

health_check_hoststring nullable

Health check host.

health_check_methodstring

Health check method.

health_check_return_codeinteger

Health check return code.

health_check_schemestring

Health check scheme.

health_check_response_textstring nullable

Health check response text.

health_check_intervalinteger

Health check interval in seconds.

health_check_timeoutinteger

Health check timeout in seconds.

health_check_retriesinteger

Health check retries count.

health_check_start_periodinteger

Health check start period in seconds.

limits_memorystring

Memory limit.

limits_memory_swapstring

Memory swap limit.

limits_memory_swappinessinteger

Memory swappiness.

limits_memory_reservationstring

Memory reservation.

limits_cpusstring

CPU limit.

limits_cpusetstring nullable

CPU set.

limits_cpu_sharesinteger

CPU shares.

custom_labelsstring

Custom labels.

custom_docker_run_optionsstring

Custom docker run options.

post_deployment_commandstring

Post deployment command.

post_deployment_command_containerstring

Post deployment command container.

pre_deployment_commandstring

Pre deployment command.

pre_deployment_command_containerstring

Pre deployment command container.

manual_webhook_secret_githubstring

Manual webhook secret for Github.

manual_webhook_secret_gitlabstring

Manual webhook secret for Gitlab.

manual_webhook_secret_bitbucketstring

Manual webhook secret for Bitbucket.

manual_webhook_secret_giteastring

Manual webhook secret for Gitea.

redirect'www' | 'non-www' | 'both' nullable

How to set redirect with Traefik / Caddy. www<->non-www.

instant_deployboolean

The flag to indicate if the application should be deployed instantly.

dockerfilestring

The Dockerfile content.

dockerfile_locationstring

The Dockerfile location in the repository.

docker_compose_locationstring

The Docker Compose location.

docker_compose_custom_start_commandstring

The Docker Compose custom start command.

docker_compose_custom_build_commandstring

The Docker Compose custom build command.

watch_pathsstring

The watch paths.

use_build_serverboolean nullable

Use build server.

connect_to_docker_networkboolean

The flag to connect the service to the predefined Docker network.

force_domain_overrideboolean

Force domain usage even if conflicts are detected. Default is false.

is_container_label_escape_enabledboolean

Escape special characters in labels. By default, $ (and other chars) is escaped. So if you write $ in the labels, it will be saved as $$. If you want to use env variables inside the labels, turn this off.

is_preserve_repository_enabledboolean

Preserve git repository during application update. If false, the existing repository will be removed and replaced with the new one. If true, the existing repository will be kept and the new one will be ignored. Default is false.

Response

Application updated.

uuidstring