v1

latestOpenAPI 3.1.02026-07-1213613295.5 KB
Applications

List

List all applications.

get/applications

Query parameters

tagstring

Filter applications by tag name.

Response

Get all applications.

idinteger

The application identifier in the database.

descriptionstring nullable

The application description.

repository_project_idinteger nullable

The repository project identifier.

uuidstring

The application UUID.

namestring

The application name.

fqdnstring nullable

The application domains.

config_hashstring

Configuration hash.

git_repositorystring

Git repository URL.

git_branchstring

Git branch.

git_commit_shastring

Git commit SHA.

git_full_urlstring nullable

Git full URL.

docker_registry_image_namestring nullable

Docker registry image name.

docker_registry_image_tagstring nullable

Docker registry image tag.

build_pack'nixpacks' | 'railpack' | 'static' | 'dockerfile' | 'dockercompose'

Build pack.

static_imagestring

Static image used when static site is deployed.

install_commandstring

Install command.

build_commandstring

Build command.

start_commandstring

Start command.

ports_exposesstring

Ports exposes.

ports_mappingsstring nullable

Ports mappings.

custom_network_aliasesstring nullable

Network aliases for Docker container.

base_directorystring

Base directory for all commands.

publish_directorystring

Publish directory.

health_check_enabledboolean

Health check enabled.

health_check_pathstring

Health check path.

health_check_portstring nullable

Health check port.

health_check_hoststring nullable

Health check host.

health_check_methodstring

Health check method.

health_check_return_codeinteger

Health check return code.

health_check_schemestring

Health check scheme.

health_check_response_textstring nullable

Health check response text.

health_check_intervalinteger

Health check interval in seconds.

health_check_timeoutinteger

Health check timeout in seconds.

health_check_retriesinteger

Health check retries count.

health_check_start_periodinteger

Health check start period in seconds.

health_check_type'http' | 'cmd'

Health check type: http or cmd.

health_check_commandstring nullable

Health check command for CMD type.

limits_memorystring

Memory limit.

limits_memory_swapstring

Memory swap limit.

limits_memory_swappinessinteger

Memory swappiness.

limits_memory_reservationstring

Memory reservation.

limits_cpusstring

CPU limit.

limits_cpusetstring nullable

CPU set.

limits_cpu_sharesinteger

CPU shares.

statusstring

Application status.

preview_url_templatestring

Preview URL template.

destination_typestring

Destination type.

destination_idinteger

Destination identifier.

source_idinteger nullable

Source identifier.

private_key_idinteger nullable

Private key identifier.

environment_idinteger

Environment identifier.

dockerfilestring nullable

Dockerfile content. Used for dockerfile build pack.

dockerfile_locationstring

Dockerfile location.

custom_labelsstring nullable

Custom labels.

dockerfile_target_buildstring nullable

Dockerfile target build.

manual_webhook_secret_githubstring nullable

Manual webhook secret for GitHub.

manual_webhook_secret_gitlabstring nullable

Manual webhook secret for GitLab.

manual_webhook_secret_bitbucketstring nullable

Manual webhook secret for Bitbucket.

manual_webhook_secret_giteastring nullable

Manual webhook secret for Gitea.

docker_compose_locationstring

Docker compose location.

docker_composestring nullable

Docker compose content. Used for docker compose build pack.

docker_compose_rawstring nullable

Docker compose raw content.

docker_compose_domainsstring nullable

Docker compose domains.

docker_compose_custom_start_commandstring nullable

Docker compose custom start command.

docker_compose_custom_build_commandstring nullable

Docker compose custom build command.

swarm_replicasinteger nullable

Swarm replicas. Only used for swarm deployments.

swarm_placement_constraintsstring nullable

Swarm placement constraints. Only used for swarm deployments.

custom_docker_run_optionsstring nullable

Custom docker run options.

post_deployment_commandstring nullable

Post deployment command.

post_deployment_command_containerstring nullable

Post deployment command container.

pre_deployment_commandstring nullable

Pre deployment command.

pre_deployment_command_containerstring nullable

Pre deployment command container.

watch_pathsstring nullable

Watch paths.

custom_healthcheck_foundboolean

Custom healthcheck found.

redirect'www' | 'non-www' | 'both' nullable

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

created_atstring date-time

The date and time when the application was created.

updated_atstring date-time

The date and time when the application was last updated.

deleted_atstring date-time nullable

The date and time when the application was deleted.

compose_parsing_versionstring

How Coolify parse the compose file.

custom_nginx_configurationstring nullable

Custom Nginx configuration base64 encoded.

is_http_basic_auth_enabledboolean

HTTP Basic Authentication enabled.

http_basic_auth_usernamestring nullable

Username for HTTP Basic Authentication

http_basic_auth_passwordstring nullable

Password for HTTP Basic Authentication

All 136 operations