GET/applications

List applications

Lists applications available to the authenticated user. Use tag to filter the results by tag name.

1 parameter
tagstringoptional
Filter applications by tag name.

3 status codes
200Returns an array of application objects with application configuration and metadata.
base_directorystringoptional
Base directory for all commands.
build_commandstringoptional
Build command.
build_packstringoptional
Build pack.
Allowed:nixpacksrailpackstaticdockerfiledockercompose
compose_parsing_versionstringoptional
How Coolify parse the compose file.
config_hashstringoptional
Configuration hash.
created_atstringoptional
The date and time when the application was created.
custom_docker_run_optionsstringoptional
Custom docker run options.
custom_healthcheck_foundbooleanoptional
Custom healthcheck found.
custom_labelsstringoptional
Custom labels.
custom_network_aliasesstringoptional
Network aliases for Docker container.
custom_nginx_configurationstringoptional
Custom Nginx configuration base64 encoded.
deleted_atstringoptional
The date and time when the application was deleted.
descriptionstringoptional
The application description.
destination_idintegeroptional
Destination identifier.
destination_typestringoptional
Destination type.
docker_composestringoptional
Docker compose content. Used for docker compose build pack.
docker_compose_custom_build_commandstringoptional
Docker compose custom build command.
docker_compose_custom_start_commandstringoptional
Docker compose custom start command.
docker_compose_domainsstringoptional
Docker compose domains.
docker_compose_locationstringoptional
Docker compose location.
docker_compose_rawstringoptional
Docker compose raw content.
docker_registry_image_namestringoptional
Docker registry image name.
docker_registry_image_tagstringoptional
Docker registry image tag.
dockerfilestringoptional
Dockerfile content. Used for dockerfile build pack.
dockerfile_locationstringoptional
Dockerfile location.
dockerfile_target_buildstringoptional
Dockerfile target build.
environment_idintegeroptional
Environment identifier.
fqdnstringoptional
The application domains.
git_branchstringoptional
Git branch.
git_commit_shastringoptional
Git commit SHA.
git_full_urlstringoptional
Git full URL.
git_repositorystringoptional
Git repository URL.
health_check_commandstringoptional
Health check command for CMD type.
health_check_enabledbooleanoptional
Health check enabled.
health_check_hoststringoptional
Health check host.
health_check_intervalintegeroptional
Health check interval in seconds.
health_check_methodstringoptional
Health check method.
health_check_pathstringoptional
Health check path.
health_check_portstringoptional
Health check port.
health_check_response_textstringoptional
Health check response text.
health_check_retriesintegeroptional
Health check retries count.
health_check_return_codeintegeroptional
Health check return code.
health_check_schemestringoptional
Health check scheme.
health_check_start_periodintegeroptional
Health check start period in seconds.
health_check_timeoutintegeroptional
Health check timeout in seconds.
health_check_typestringoptional
Health check type: http or cmd.
Allowed:httpcmd
http_basic_auth_argon2id_memory_costintegeroptional
Argon2id memory cost in KiB for the HTTP Basic Authentication password.
http_basic_auth_argon2id_time_costintegeroptional
Argon2id time cost (iterations) for the HTTP Basic Authentication password.
http_basic_auth_bcrypt_costintegeroptional
Bcrypt cost for the HTTP Basic Authentication password.
http_basic_auth_hash_algorithmstringoptional
Hash algorithm for the HTTP Basic Authentication password. Argon2id needs the Caddy proxy, version 2.11 or newer.
Allowed:bcryptargon2id
http_basic_auth_passwordstringoptional
Password for HTTP Basic Authentication
http_basic_auth_usernamestringoptional
Username for HTTP Basic Authentication
idintegeroptional
The application identifier in the database.
install_commandstringoptional
Install command.
is_http_basic_auth_enabledbooleanoptional
HTTP Basic Authentication enabled.
limits_cpu_sharesintegeroptional
CPU shares.
limits_cpusstringoptional
CPU limit.
limits_cpusetstringoptional
CPU set.
limits_memorystringoptional
Memory limit.
limits_memory_reservationstringoptional
Memory reservation.
limits_memory_swapstringoptional
Memory swap limit.
limits_memory_swappinessintegeroptional
Memory swappiness.
manual_webhook_secret_bitbucketstringoptional
Manual webhook secret for Bitbucket.
manual_webhook_secret_giteastringoptional
Manual webhook secret for Gitea.
manual_webhook_secret_githubstringoptional
Manual webhook secret for GitHub.
manual_webhook_secret_gitlabstringoptional
Manual webhook secret for GitLab.
max_restart_countintegeroptional
Maximum container restart count before stopping.
namestringoptional
The application name.
noindex_domainsarray<string>optional
The subset of the application domains served with an X-Robots-Tag: noindex, nofollow response header.
ports_exposesstringoptional
Ports exposes.
ports_mappingsstringoptional
Ports mappings.
post_deployment_commandstringoptional
Post deployment command.
post_deployment_command_containerstringoptional
Post deployment command container.
pre_deployment_commandstringoptional
Pre deployment command.
pre_deployment_command_containerstringoptional
Pre deployment command container.
preview_url_templatestringoptional
Preview URL template.
private_key_idintegeroptional
Private key identifier.
publish_directorystringoptional
Publish directory.
redirectstringoptional
How to set redirect with Traefik / Caddy. www<->non-www.
Allowed:wwwnon-wwwboth
repository_project_idintegeroptional
The repository project identifier.
settingsobjectoptional
Application settings.
source_idintegeroptional
Source identifier.
start_commandstringoptional
Start command.
static_imagestringoptional
Static image used when static site is deployed.
statusstringoptional
Application status.
swarm_placement_constraintsstringoptional
Swarm placement constraints. Only used for swarm deployments.
swarm_replicasintegeroptional
Swarm replicas. Only used for swarm deployments.
updated_atstringoptional
The date and time when the application was last updated.
uuidstringoptional
The application UUID.
watch_pathsstringoptional
Watch paths.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional

Error handling

A 400 is returned when the token is invalid, and a 401 when the request is unauthenticated. If you provide tag, use the tag name to filter the listed applications.