Skip to content

Get

GET
/applications/{uuid}

Get application by UUID.

Authorizations

Parameters

Path Parameters

uuid
required
string format: uuid

UUID of the application.

Responses

200

Get application by UUID.

Application model

object
id

The application identifier in the database.

integer
description

The application description.

string
nullable
repository_project_id

The repository project identifier.

integer
nullable
uuid

The application UUID.

string
name

The application name.

string
fqdn

The application domains.

string
nullable
config_hash

Configuration hash.

string
git_repository

Git repository URL.

string
git_branch

Git branch.

string
git_commit_sha

Git commit SHA.

string
git_full_url

Git full URL.

string
nullable
docker_registry_image_name

Docker registry image name.

string
nullable
docker_registry_image_tag

Docker registry image tag.

string
nullable
build_pack

Build pack.

string
Allowed values: nixpacks static dockerfile dockercompose
static_image

Static image used when static site is deployed.

string
install_command

Install command.

string
build_command

Build command.

string
start_command

Start command.

string
ports_exposes

Ports exposes.

string
ports_mappings

Ports mappings.

string
nullable
base_directory

Base directory for all commands.

string
publish_directory

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
status

Application status.

string
preview_url_template

Preview URL template.

string
destination_type

Destination type.

string
destination_id

Destination identifier.

integer
source_id

Source identifier.

integer
nullable
private_key_id

Private key identifier.

integer
nullable
environment_id

Environment identifier.

integer
dockerfile

Dockerfile content. Used for dockerfile build pack.

string
nullable
dockerfile_location

Dockerfile location.

string
custom_labels

Custom labels.

string
nullable
dockerfile_target_build

Dockerfile target build.

string
nullable
manual_webhook_secret_github

Manual webhook secret for GitHub.

string
nullable
manual_webhook_secret_gitlab

Manual webhook secret for GitLab.

string
nullable
manual_webhook_secret_bitbucket

Manual webhook secret for Bitbucket.

string
nullable
manual_webhook_secret_gitea

Manual webhook secret for Gitea.

string
nullable
docker_compose_location

Docker compose location.

string
docker_compose

Docker compose content. Used for docker compose build pack.

string
nullable
docker_compose_raw

Docker compose raw content.

string
nullable
docker_compose_domains

Docker compose domains.

string
nullable
docker_compose_custom_start_command

Docker compose custom start command.

string
nullable
docker_compose_custom_build_command

Docker compose custom build command.

string
nullable
swarm_replicas

Swarm replicas. Only used for swarm deployments.

integer
nullable
swarm_placement_constraints

Swarm placement constraints. Only used for swarm deployments.

string
nullable
custom_docker_run_options

Custom docker run options.

string
nullable
post_deployment_command

Post deployment command.

string
nullable
post_deployment_command_container

Post deployment command container.

string
nullable
pre_deployment_command

Pre deployment command.

string
nullable
pre_deployment_command_container

Pre deployment command container.

string
nullable
watch_paths

Watch paths.

string
nullable
custom_healthcheck_found

Custom healthcheck found.

boolean
redirect

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

string
nullable
Allowed values: www non-www both
created_at

The date and time when the application was created.

string format: date-time
updated_at

The date and time when the application was last updated.

string format: date-time
deleted_at

The date and time when the application was deleted.

string format: date-time
nullable
compose_parsing_version

How Coolify parse the compose file.

string

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.

404

Resource not found.

object
message
string
Resource not found.