POST
/
applications
/
private-gh-app

Authorizations

Authorization
string
headerrequired

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

Body

application/json
project_uuid
string
required

The project UUID.

server_uuid
string
required

The server UUID.

environment_name
string
required

The environment name.

github_app_uuid
string
required

The Github App UUID.

git_repository
string
required

The git repository URL.

git_branch
string
required

The git branch.

ports_exposes
string
required

The ports to expose.

destination_uuid
string

The destination UUID.

build_pack
enum<string>
required

The build pack type.

Available options:
nixpacks,
static,
dockerfile,
dockercompose
name
string

The application name.

description
string

The application description.

domains
string

The application domains.

git_commit_sha
string

The git commit SHA.

docker_registry_image_name
string

The docker registry image name.

docker_registry_image_tag
string

The docker registry image tag.

is_static
boolean

The flag to indicate if the application is static.

install_command
string

The install command.

build_command
string

The build command.

start_command
string

The start command.

ports_mappings
string

The ports mappings.

base_directory
string

The base directory for all commands.

publish_directory
string

The publish directory.

health_check_enabled
boolean

Health check enabled.

health_check_path
string

Health check path.

health_check_port
string | null

Health check port.

health_check_host
string | null

Health check host.

health_check_method
string

Health check method.

health_check_return_code
integer

Health check return code.

health_check_scheme
string

Health check scheme.

health_check_response_text
string | null

Health check response text.

health_check_interval
integer

Health check interval in seconds.

health_check_timeout
integer

Health check timeout in seconds.

health_check_retries
integer

Health check retries count.

health_check_start_period
integer

Health check start period in seconds.

limits_memory
string

Memory limit.

limits_memory_swap
string

Memory swap limit.

limits_memory_swappiness
integer

Memory swappiness.

limits_memory_reservation
string

Memory reservation.

limits_cpus
string

CPU limit.

limits_cpuset
string | null

CPU set.

limits_cpu_shares
integer

CPU shares.

custom_labels
string

Custom labels.

custom_docker_run_options
string

Custom docker run options.

post_deployment_command
string

Post deployment command.

post_deployment_command_container
string

Post deployment command container.

pre_deployment_command
string

Pre deployment command.

pre_deployment_command_container
string

Pre deployment command container.

manual_webhook_secret_github
string

Manual webhook secret for Github.

manual_webhook_secret_gitlab
string

Manual webhook secret for Gitlab.

manual_webhook_secret_bitbucket
string

Manual webhook secret for Bitbucket.

manual_webhook_secret_gitea
string

Manual webhook secret for Gitea.

redirect
enum<string> | null

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

Available options:
www,
non-www,
both
instant_deploy
boolean

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

dockerfile
string

The Dockerfile content.

docker_compose_location
string

The Docker Compose location.

docker_compose_raw
string

The Docker Compose raw content.

docker_compose_custom_start_command
string

The Docker Compose custom start command.

docker_compose_custom_build_command
string

The Docker Compose custom build command.

docker_compose_domains
any[]

The Docker Compose domains.

watch_paths
string

The watch paths.