Skip to content

Create (Private - Deploy Key)

POST
/applications/private-deploy-key

Create new application based on a private repository through a Deploy Key.

Authorizations

Request Body required

Application object that needs to be created.

object
project_uuid
required

The project UUID.

string
server_uuid
required

The server UUID.

string
environment_name
required

The environment name.

string
private_key_uuid
required

The private key UUID.

string
git_repository
required

The git repository URL.

string
git_branch
required

The git branch.

string
ports_exposes
required

The ports to expose.

string
destination_uuid

The destination UUID.

string
build_pack
required

The build pack type.

string
Allowed values: nixpacks static dockerfile dockercompose
name

The application name.

string
description

The application description.

string
domains

The application domains.

string
git_commit_sha

The git commit SHA.

string
docker_registry_image_name

The docker registry image name.

string
docker_registry_image_tag

The docker registry image tag.

string
is_static

The flag to indicate if the application is static.

boolean
install_command

The install command.

string
build_command

The build command.

string
start_command

The start command.

string
ports_mappings

The ports mappings.

string
base_directory

The base directory for all commands.

string
publish_directory

The publish directory.

string
health_check_enabled

Health check enabled.

boolean
health_check_path

Health check path.

string
health_check_port

Health check port.

string
nullable
health_check_host

Health check host.

string
nullable
health_check_method

Health check method.

string
health_check_return_code

Health check return code.

integer
health_check_scheme

Health check scheme.

string
health_check_response_text

Health check response text.

string
nullable
health_check_interval

Health check interval in seconds.

integer
health_check_timeout

Health check timeout in seconds.

integer
health_check_retries

Health check retries count.

integer
health_check_start_period

Health check start period in seconds.

integer
limits_memory

Memory limit.

string
limits_memory_swap

Memory swap limit.

string
limits_memory_swappiness

Memory swappiness.

integer
limits_memory_reservation

Memory reservation.

string
limits_cpus

CPU limit.

string
limits_cpuset

CPU set.

string
nullable
limits_cpu_shares

CPU shares.

integer
custom_labels

Custom labels.

string
custom_docker_run_options

Custom docker run options.

string
post_deployment_command

Post deployment command.

string
post_deployment_command_container

Post deployment command container.

string
pre_deployment_command

Pre deployment command.

string
pre_deployment_command_container

Pre deployment command container.

string
manual_webhook_secret_github

Manual webhook secret for Github.

string
manual_webhook_secret_gitlab

Manual webhook secret for Gitlab.

string
manual_webhook_secret_bitbucket

Manual webhook secret for Bitbucket.

string
manual_webhook_secret_gitea

Manual webhook secret for Gitea.

string
redirect

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

string
nullable
Allowed values: www non-www both
instant_deploy

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

boolean
dockerfile

The Dockerfile content.

string
docker_compose_location

The Docker Compose location.

string
docker_compose_raw

The Docker Compose raw content.

string
docker_compose_custom_start_command

The Docker Compose custom start command.

string
docker_compose_custom_build_command

The Docker Compose custom build command.

string
docker_compose_domains

The Docker Compose domains.

array
watch_paths

The watch paths.

string
use_build_server

Use build server.

boolean
nullable

Responses

200

Application created successfully.

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.