Coolify Documentation

Create (Docker Image)

curl --request POST \
  --url https://app.coolify.io/api/v1/applications/dockerimage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_uuid": "<string>",
  "server_uuid": "<string>",
  "environment_name": "<string>",
  "docker_registry_image_name": "<string>",
  "docker_registry_image_tag": "<string>",
  "ports_exposes": "<string>",
  "destination_uuid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "domains": "<string>",
  "ports_mappings": "<string>",
  "health_check_enabled": true,
  "health_check_path": "<string>",
  "health_check_port": "<string>",
  "health_check_host": "<string>",
  "health_check_method": "<string>",
  "health_check_return_code": 123,
  "health_check_scheme": "<string>",
  "health_check_response_text": "<string>",
  "health_check_interval": 123,
  "health_check_timeout": 123,
  "health_check_retries": 123,
  "health_check_start_period": 123,
  "limits_memory": "<string>",
  "limits_memory_swap": "<string>",
  "limits_memory_swappiness": 123,
  "limits_memory_reservation": "<string>",
  "limits_cpus": "<string>",
  "limits_cpuset": "<string>",
  "limits_cpu_shares": 123,
  "custom_labels": "<string>",
  "custom_docker_run_options": "<string>",
  "post_deployment_command": "<string>",
  "post_deployment_command_container": "<string>",
  "pre_deployment_command": "<string>",
  "pre_deployment_command_container": "<string>",
  "manual_webhook_secret_github": "<string>",
  "manual_webhook_secret_gitlab": "<string>",
  "manual_webhook_secret_bitbucket": "<string>",
  "manual_webhook_secret_gitea": "<string>",
  "redirect": "www",
  "instant_deploy": true
}'

This response does not have an example.

POST

applications

dockerimage

Create (Docker Image)

curl --request POST \
  --url https://app.coolify.io/api/v1/applications/dockerimage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_uuid": "<string>",
  "server_uuid": "<string>",
  "environment_name": "<string>",
  "docker_registry_image_name": "<string>",
  "docker_registry_image_tag": "<string>",
  "ports_exposes": "<string>",
  "destination_uuid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "domains": "<string>",
  "ports_mappings": "<string>",
  "health_check_enabled": true,
  "health_check_path": "<string>",
  "health_check_port": "<string>",
  "health_check_host": "<string>",
  "health_check_method": "<string>",
  "health_check_return_code": 123,
  "health_check_scheme": "<string>",
  "health_check_response_text": "<string>",
  "health_check_interval": 123,
  "health_check_timeout": 123,
  "health_check_retries": 123,
  "health_check_start_period": 123,
  "limits_memory": "<string>",
  "limits_memory_swap": "<string>",
  "limits_memory_swappiness": 123,
  "limits_memory_reservation": "<string>",
  "limits_cpus": "<string>",
  "limits_cpuset": "<string>",
  "limits_cpu_shares": 123,
  "custom_labels": "<string>",
  "custom_docker_run_options": "<string>",
  "post_deployment_command": "<string>",
  "post_deployment_command_container": "<string>",
  "pre_deployment_command": "<string>",
  "pre_deployment_command_container": "<string>",
  "manual_webhook_secret_github": "<string>",
  "manual_webhook_secret_gitlab": "<string>",
  "manual_webhook_secret_bitbucket": "<string>",
  "manual_webhook_secret_gitea": "<string>",
  "redirect": "www",
  "instant_deploy": true
}'

This response does not have an example.

Authorizations

Authorization

string

header

required

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

Body

application/json

Application object that needs to be created.

project_uuid

string

required

The project UUID.

server_uuid

string

required

The server UUID.

environment_name

string

required

The environment name.

docker_registry_image_name

string

required

The docker registry image name.

ports_exposes

string

required

The ports to expose.

docker_registry_image_tag

string

The docker registry image tag.

destination_uuid

string

The destination UUID.

name

string

The application name.

description

string

The application description.

domains

string

The application domains.

ports_mappings

string

The ports mappings.

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.

Response

Application created successfully.

Create (Dockerfile)Create (Docker Compose)

⌘I

API Reference

Authorizations

Body

Response