v1
latestOpenAPI 3.1.02026-07-1213613295.5 KBCreate (Private - Deploy Key)
Create new application based on a private repository through a Deploy Key.
Request body
The project UUID.
The server UUID.
The environment name. You need to provide at least one of environment_name or environment_uuid.
The environment UUID. You need to provide at least one of environment_name or environment_uuid.
The private key UUID.
The git repository URL.
The git branch.
The ports to expose.
The destination UUID.
The build pack type.
The application name.
The application description.
The application URLs in a comma-separated list.
The git commit SHA.
The docker registry image name.
The docker registry image tag.
The flag to indicate if the application is static.
The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.
The flag to indicate if auto-deploy is enabled on git push. Defaults to true.
The flag to indicate if HTTPS is forced. Defaults to true.
The static image.
The install command.
The build command.
The start command.
The ports mappings.
The base directory for all commands.
The publish directory.
Health check enabled.
Health check path.
Health check port.
Health check host.
Health check method.
Health check return code.
Health check scheme.
Health check response text.
Health check interval in seconds.
Health check timeout in seconds.
Health check retries count.
Health check start period in seconds.
Memory limit.
Memory swap limit.
Memory swappiness.
Memory reservation.
CPU limit.
CPU set.
CPU shares.
Custom labels.
Custom docker run options.
Post deployment command.
Post deployment command container.
Pre deployment command.
Pre deployment command container.
Manual webhook secret for Github.
Manual webhook secret for Gitlab.
Manual webhook secret for Bitbucket.
Manual webhook secret for Gitea.
How to set redirect with Traefik / Caddy. www<->non-www.
The flag to indicate if the application should be deployed instantly.
The Dockerfile content.
The Dockerfile location in the repository.
The Docker Compose location.
The Docker Compose custom start command.
The Docker Compose custom build command.
The watch paths.
Use build server.
HTTP Basic Authentication enabled.
Username for HTTP Basic Authentication
Password for HTTP Basic Authentication
The flag to connect the service to the predefined Docker network.
Force domain usage even if conflicts are detected. Default is false.
If true and domains is empty, auto-generate a domain using the server's wildcard domain or sslip.io fallback. Default: true.
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.
Preserve repository during deployment.
Response
Application created successfully.