Skip to content

Main Navigation Coolify Cloud

Appearance

Sidebar Navigation

Get Started

Introduction

Installation

Upgrade

Downgrade

Uninstallation

Cloud

Usage

Concepts

Screenshots

Videos

Team

Support

Sponsors

Contribute

Coolify

New Service

Documentation

Builds

Introduction

Build Packs

Overview

Static

Nixpacks

Dockerfile

Docker Compose

Build Servers

Applications

Overview

Django

Jekyll

Laravel

Phoenix

Ruby on Rails

Symfony

Next.js

Vite

Vue

Nuxt

SvelteKit

Services

Introduction

All Services

Services Directory

Databases

Overview

Database SSL

Backups

MySQL

MariaDB

PostgreSQL

MongoDB

Redis

DragonFly

KeyDB

Clickhouse

Integrations

Webstudio

Knowledge Base

Overview

Internal

Scalability

Terminal

Self-hosted Instance

Monitoring

Notifications

Coolify Updates

Commands

Delete User

OAuth

Default Root User

Custom Docker Network

Custom Docker Registry

Change Localhost Key

DNS & Domains

DNS Configuration

Domains

Destinations

Overview

Creating Destinations

Managing Destinations

Resources

Environment Variables

Persistent Storage

Drain Logs

Rolling Updates

Health Checks

Cron Syntax

How-Tos

Migrate Applications

Backup & Restore Coolify

Load-balancing on Hetzner

WordPress Multisite

Raspberry Pi OS Setup

Private NPM Registry

Ollama with GPU

Git

Github

Manually Setup GitHub App

Move Between GitHub Apps

Integrations

Github Actions

Gitlab

Integrations

Bitbucket

Integrations

Gitea

Integrations

Servers

Introduction

Automated Cleanup

Build Server

Firewall

Multiple Servers

Sentinel and Metrics

Non-root User

OpenSSH

Oracle Cloud

Proxies

Server Patching

Terminal Access

S3

Introduction

AWS

R2

Docker

Compose

Docker Commands

Registry

Swarm

Cloudflare

Tunnels

Overview

All Resources

Single Resource

Server SSH Access

Full TLS/HTTPS

Origin Certificate

Proxy

Traefik

Overview

Basic Auth

Custom SSL Certificates

Dashboard

Dynamic Configurations

Load Balancing

Redirects

Wildcard SSL Certificates

Protect Services with Authentik

Caddy

Overview

Basic Auth

API Reference

Authorization

Applications

GET List

POST Create (Public)

POST Create (Private - GH App)

POST Create (Private - Deploy Key)

POST Create (Dockerfile)

POST Create (Docker Image)

POST Create (Docker Compose)

GET Get

DELETE Delete

PATCH Update

GET Get application logs.

GET List Envs

POST Create Env

PATCH Update Env

PATCH Update Envs (Bulk)

DELETE Delete Env

GET Start

GET Stop

GET Restart

Databases

GET List

GET Get

DELETE Delete

PATCH Update

POST Create (PostgreSQL)

POST Create (Clickhouse)

POST Create (DragonFly)

POST Create (Redis)

POST Create (KeyDB)

POST Create (MariaDB)

POST Create (MySQL)

POST Create (MongoDB)

GET Start

GET Stop

GET Restart

Deployments

GET List

GET Get

GET Deploy

GET List application deployments

Default

GET Version

GET Enable API

GET Disable API

GET Healthcheck

Projects

GET List

POST Create

GET Get

DELETE Delete

PATCH Update

GET Environment

GET List Environments

POST Create Environment

DELETE Delete Environment

Resources

GET List

Private Keys

GET List

POST Create

PATCH Update

GET Get

DELETE Delete

Servers

GET List

POST Create

GET Get

DELETE Delete

PATCH Update

GET Resources

GET Domains

GET Validate

Services

GET List

POST Create service

GET Get

DELETE Delete

PATCH Update

GET List Envs

POST Create Env

PATCH Update Env

PATCH Update Envs (Bulk)

DELETE Delete Env

GET Start

GET Stop

GET Restart

Teams

GET List

GET Get

GET Members

GET Authenticated Team

GET Authenticated Team Members

Troubleshoot

Overview

Installation

Docker Installation Failed

Applications

Bad Gateway (502)

No Available Server (503)

Gateway Timeout (504)

Failed To Get Access Token During Deployment

Dashboard

Inaccessible

Very Slow

Disable 2FA Manually

Docker

Expired GitHub Personal Access Token (PAT)

Server

Connection Unstable

Crash During Build

2FA Stopped Working

Raspberry Pi Crashes

Server Validation Issues

DNS & Domains

Wildcard SSL not working

Let's Encrypt not working

Cert Resolver doesn't exist

Healthcheck

GET

/health

Healthcheck endpoint.

Responses

Healthcheck endpoint.

Content-Type

application/json

GET

/health

Playground

Samples

Powered by VitePress OpenAPI

Edit this page on GitHub

Pager

Previous page GET Disable API

Next page GET List