v1

latestOpenAPI 3.1.02026-07-1213613295.5 KB
Applications

Create (Dockerfile without git)

Create new application based on a simple Dockerfile (without git).

post/applications/dockerfile

Request body

project_uuidstring required

The project UUID.

server_uuidstring required

The server UUID.

environment_namestring required

The environment name. You need to provide at least one of environment_name or environment_uuid.

environment_uuidstring required

The environment UUID. You need to provide at least one of environment_name or environment_uuid.

dockerfilestring required

The Dockerfile content.

build_pack'dockerfile'

The build pack type.

ports_exposesstring

The ports to expose.

destination_uuidstring

The destination UUID.

namestring

The application name.

descriptionstring

The application description.

domainsstring

The application URLs in a comma-separated list.

docker_registry_image_namestring

The docker registry image name.

docker_registry_image_tagstring

The docker registry image tag.

ports_mappingsstring

The ports mappings.

base_directorystring

The base directory for all commands.

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.

is_force_https_enabledboolean

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

use_build_serverboolean nullable

Use build server.

is_http_basic_auth_enabledboolean

HTTP Basic Authentication enabled.

http_basic_auth_usernamestring nullable

Username for HTTP Basic Authentication

http_basic_auth_passwordstring nullable

Password for HTTP Basic Authentication

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.

autogenerate_domainboolean

If true and domains is empty, auto-generate a domain using the server's wildcard domain or sslip.io fallback. Default: true.

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.

Response

Application created successfully.

uuidstring