GET
/
applications
/
{uuid}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

uuid
string
required

UUID of the application.

Response

200 - application/json
id
integer

The application identifier in the database.

description
string | null

The application description.

repository_project_id
integer | null

The repository project identifier.

uuid
string

The application UUID.

name
string

The application name.

fqdn
string | null

The application domains.

config_hash
string

Configuration hash.

git_repository
string

Git repository URL.

git_branch
string

Git branch.

git_commit_sha
string

Git commit SHA.

git_full_url
string | null

Git full URL.

docker_registry_image_name
string | null

Docker registry image name.

docker_registry_image_tag
string | null

Docker registry image tag.

build_pack
enum<string>

Build pack.

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

Static image used when static site is deployed.

install_command
string

Install command.

build_command
string

Build command.

start_command
string

Start command.

ports_exposes
string

Ports exposes.

ports_mappings
string | null

Ports mappings.

base_directory
string

Base directory for all commands.

publish_directory
string

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.

status
string

Application status.

preview_url_template
string

Preview URL template.

destination_type
string

Destination type.

destination_id
integer

Destination identifier.

source_id
integer | null

Source identifier.

private_key_id
integer | null

Private key identifier.

environment_id
integer

Environment identifier.

dockerfile
string | null

Dockerfile content. Used for dockerfile build pack.

dockerfile_location
string

Dockerfile location.

custom_labels
string | null

Custom labels.

dockerfile_target_build
string | null

Dockerfile target build.

manual_webhook_secret_github
string | null

Manual webhook secret for GitHub.

manual_webhook_secret_gitlab
string | null

Manual webhook secret for GitLab.

manual_webhook_secret_bitbucket
string | null

Manual webhook secret for Bitbucket.

manual_webhook_secret_gitea
string | null

Manual webhook secret for Gitea.

docker_compose_location
string

Docker compose location.

docker_compose
string | null

Docker compose content. Used for docker compose build pack.

docker_compose_raw
string | null

Docker compose raw content.

docker_compose_domains
string | null

Docker compose domains.

docker_compose_custom_start_command
string | null

Docker compose custom start command.

docker_compose_custom_build_command
string | null

Docker compose custom build command.

swarm_replicas
integer | null

Swarm replicas. Only used for swarm deployments.

swarm_placement_constraints
string | null

Swarm placement constraints. Only used for swarm deployments.

custom_docker_run_options
string | null

Custom docker run options.

post_deployment_command
string | null

Post deployment command.

post_deployment_command_container
string | null

Post deployment command container.

pre_deployment_command
string | null

Pre deployment command.

pre_deployment_command_container
string | null

Pre deployment command container.

watch_paths
string | null

Watch paths.

custom_healthcheck_found
boolean

Custom healthcheck found.

redirect
enum<string> | null

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

Available options:
www,
non-www,
both
created_at
string

The date and time when the application was created.

updated_at
string

The date and time when the application was last updated.

deleted_at
string | null

The date and time when the application was deleted.

compose_parsing_version
string

How Coolify parse the compose file.