Proxmox-Coolify-Manager/coolify_skill/references/API.md

Coolify API Reference

Generated from 107 operation pages

Table of Contents

• Applications
• Databases
• Deployments
• Environments
• GitHub
• Other
• Projects
• Security
• Servers
• Services
• Teams

---

Applications

create-dockercompose-application

• Method: POST
• Path: /api/v1/applications/dockercompose
• Description: Deprecated: Use POST /api/v1/services instead. application/json
• Category: Applications

create-dockerfile-application

• Method: POST
• Path: /api/v1/applications/dockerfile
• Description: Create new application based on a simple Dockerfile (without git). application/json
• Category: Applications

create-dockerimage-application

• Method: POST
• Path: /api/v1/applications/dockerimage
• Description: Create new application based on a prebuilt docker image (without git). application/json
• Category: Applications

create-env-by-application-uuid

• Method: POST
• Path: /api/v1/applications/{uuid}/envs
• Description: Create env by application UUID. UUID of the application.
• Category: Applications

create-private-deploy-key-application

• Method: POST
• Path: /api/v1/applications/private-deploy-key
• Description: Create new application based on a private repository through a Deploy Key. application/json
• Category: Applications

create-private-github-app-application

• Method: POST
• Path: /api/v1/applications/private-github-app
• Description: Create new application based on a private repository through a Github App. application/json
• Category: Applications

create-public-application

• Method: POST
• Path: /api/v1/applications/public
• Description: Create new application based on a public git repository. application/json
• Category: Applications

delete-application-by-uuid

• Method: DELETE
• Path: /api/v1/applications/{uuid}
• Description: Delete application by UUID. UUID of the application.
• Category: Applications

delete-env-by-application-uuid

• Method: DELETE
• Path: /api/v1/applications/{uuid}/envs/{env_uuid}
• Description: Delete env by UUID. UUID of the application.
• Category: Applications

get-application-by-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}
• Description: Get application by UUID. UUID of the application.
• Category: Applications

get-application-logs-by-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}/logs
• Description: Get application logs by UUID. UUID of the application.
• Category: Applications

list-applications

• Method: GET
• Path: /api/v1/applications
• Description: List all applications. Filter applications by tag name.
• Category: Applications

list-deployments-by-app-uuid

• Method: GET
• Path: /api/v1/deployments/applications/{uuid}
• Description: List application deployments by using the app uuid UUID of the application.
• Category: Applications

list-envs-by-application-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}/envs
• Description: List all envs by application UUID. UUID of the application.
• Category: Applications

restart-application-by-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}/restart
• Description: Restart application. Post request is also accepted. UUID of the application.
• Category: Applications

start-application-by-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}/start
• Description: Start application. Post request is also accepted. UUID of the application.
• Category: Applications

stop-application-by-uuid

• Method: GET
• Path: /api/v1/applications/{uuid}/stop
• Description: Stop application. Post request is also accepted. UUID of the application.
• Category: Applications

update-application-by-uuid

• Method: PATCH
• Path: /api/v1/applications/{uuid}
• Description: Update application by UUID. UUID of the application.
• Category: Applications

update-env-by-application-uuid

• Method: PATCH
• Path: /api/v1/applications/{uuid}/envs
• Description: Update env by application UUID. UUID of the application.
• Category: Applications

update-envs-by-application-uuid

• Method: PATCH
• Path: /api/v1/applications/{uuid}/envs/bulk
• Description: Update multiple envs by application UUID. UUID of the application.
• Category: Applications

---

Databases

create-database-backup

• Method: POST
• Path: /api/v1/databases/{uuid}/backups
• Description: Create a new scheduled backup configuration for a database UUID of the database.
• Category: Databases

create-database-clickhouse

• Method: POST
• Path: /api/v1/databases/clickhouse
• Description: Create a new Clickhouse database. application/json
• Category: Databases

create-database-dragonfly

• Method: POST
• Path: /api/v1/databases/dragonfly
• Description: Create a new DragonFly database. application/json
• Category: Databases

create-database-keydb

• Method: POST
• Path: /api/v1/databases/keydb
• Description: Create a new KeyDB database. application/json
• Category: Databases

create-database-mariadb

• Method: POST
• Path: /api/v1/databases/mariadb
• Description: Create a new MariaDB database. application/json
• Category: Databases

create-database-mongodb

• Method: POST
• Path: /api/v1/databases/mongodb
• Description: Create a new MongoDB database. application/json
• Category: Databases

create-database-mysql

• Method: POST
• Path: /api/v1/databases/mysql
• Description: Create a new MySQL database. application/json
• Category: Databases

create-database-postgresql

• Method: POST
• Path: /api/v1/databases/postgresql
• Description: Create a new PostgreSQL database. application/json
• Category: Databases

create-database-redis

• Method: POST
• Path: /api/v1/databases/redis
• Description: Create a new Redis database. application/json
• Category: Databases

delete-backup-configuration-by-uuid

• Method: DELETE
• Path: /api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}
• Description: Deletes a backup configuration and all its executions. UUID of the database
• Category: Databases

delete-backup-execution-by-uuid

• Method: DELETE
• Path: /api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}/executions/{execution_uuid}
• Description: Deletes a specific backup execution. UUID of the database
• Category: Databases

delete-database-by-uuid

• Method: DELETE
• Path: /api/v1/databases/{uuid}
• Description: Delete database by UUID. UUID of the database.
• Category: Databases

get-database-backups-by-uuid

• Method: GET
• Path: /api/v1/databases/{uuid}/backups
• Description: Get backups details by database UUID. UUID of the database.
• Category: Databases

get-database-by-uuid

• Method: GET
• Path: /api/v1/databases/{uuid}
• Description: Get database by UUID. UUID of the database.
• Category: Databases

list-backup-executions

• Method: GET
• Path: /api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}/executions
• Description: Get all executions for a specific backup configuration. UUID of the database
• Category: Databases

list-databases

• Method: GET
• Path: /api/v1/databases
• Description: List all databases. Get all databases
• Category: Databases

restart-database-by-uuid

• Method: GET
• Path: /api/v1/databases/{uuid}/restart
• Description: Restart database. Post request is also accepted. UUID of the database.
• Category: Databases

start-database-by-uuid

• Method: GET
• Path: /api/v1/databases/{uuid}/start
• Description: Start database. Post request is also accepted. UUID of the database.
• Category: Databases

stop-database-by-uuid

• Method: GET
• Path: /api/v1/databases/{uuid}/stop
• Description: Stop database. Post request is also accepted. UUID of the database.
• Category: Databases

update-database-backup

• Method: PATCH
• Path: /api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}
• Description: Update a specific backup configuration for a given database, identified by its UUID and the backup ID UUID of the database.
• Category: Databases

update-database-by-uuid

• Method: PATCH
• Path: /api/v1/databases/{uuid}
• Description: Update database by UUID. UUID of the database.
• Category: Databases

---

Deployments

cancel-deployment-by-uuid

• Method: POST
• Path: /api/v1/deployments/{uuid}/cancel
• Description: Cancel a deployment by UUID. Deployment cancelled successfully.
• Category: Deployments

deploy-by-tag-or-uuid

• Method: GET
• Path: /api/v1/deploy
• Description: Deploy by tag or uuid. Post request also accepted with uuid and tag json body. Tag name(s). Comma separated list is also accepted.
• Category: Deployments

get-deployment-by-uuid

• Method: GET
• Path: /api/v1/deployments/{uuid}
• Description: Get deployment by UUID. Get deployment by UUID.
• Category: Deployments

list-deployments

• Method: GET
• Path: /api/v1/deployments
• Description: List currently running deployments Get all currently running deployments.
• Category: Deployments

---

Environments

create-environment

• Method: POST
• Path: /api/v1/projects/{uuid}/environments
• Description: Create environment in project. application/json
• Category: Environments

delete-environment

• Method: DELETE
• Path: /api/v1/projects/{uuid}/environments/{environment_name_or_uuid}
• Description: Delete environment by name or UUID. Environment must be empty. environment_name_or_uuid*
• Category: Environments

get-environment-by-name-or-uuid

• Method: GET
• Path: /api/v1/projects/{uuid}/{environment_name_or_uuid}
• Description: Get environment by name or UUID. environment_name_or_uuid*
• Category: Environments

get-environments

• Method: GET
• Path: /api/v1/projects/{uuid}/environments
• Description: List all environments in a project. List of environments
• Category: Environments

---

GitHub

create-github-app

• Method: POST
• Path: /api/v1/github-apps
• Description: Create a new GitHub app. application/json
• Category: GitHub

deleteGithubApp

• Method: DELETE
• Path: /api/v1/github-apps/{github_app_id}
• Description: Delete a GitHub app if it's not being used by any applications. github_app_id*
• Category: GitHub

list-github-apps

• Method: GET
• Path: /api/v1/github-apps
• Description: List all GitHub apps. List of GitHub apps.
• Category: GitHub

load-branches

• Method: GET
• Path: /api/v1/github-apps/{github_app_id}/repositories/{owner}/{repo}/branches
• Description: Fetch branches from GitHub for a given repository. github_app_id*
• Category: GitHub

load-repositories

• Method: GET
• Path: /api/v1/github-apps/{github_app_id}/repositories
• Description: Fetch repositories from GitHub for a given GitHub app. github_app_id*
• Category: GitHub

updateGithubApp

• Method: PATCH
• Path: /api/v1/github-apps/{github_app_id}
• Description: Update an existing GitHub app. github_app_id*
• Category: GitHub

---

Other

healthcheck

• Method: GET
• Path: /api/v1/health
• Description: Healthcheck endpoint. Healthcheck endpoint.
• Category: Other

version

• Method: GET
• Path: /api/v1/version
• Description: Get Coolify version. Returns the version of the application
• Category: Other

---

Projects

create-project

• Method: POST
• Path: /api/v1/projects
• Description: application/json "name": "string",
• Category: Projects

delete-project-by-uuid

• Method: DELETE
• Path: /api/v1/projects/{uuid}
• Description: Delete project by UUID. UUID of the application.
• Category: Projects

get-project-by-uuid

• Method: GET
• Path: /api/v1/projects/{uuid}
• Description: Get project by UUID. application/json
• Category: Projects

list-projects

• Method: GET
• Path: /api/v1/projects
• Description: Get all projects. application/json
• Category: Projects

update-project-by-uuid

• Method: PATCH
• Path: /api/v1/projects/{uuid}
• Description: UUID of the project. application/json
• Category: Projects

---

Security

create-cloud-token

• Method: POST
• Path: /api/v1/cloud-tokens
• Description: Create a new cloud provider token. The token will be validated before being stored. application/json
• Category: Security

create-private-key

• Method: POST
• Path: /api/v1/security/keys
• Description: Create a new private key. application/json
• Category: Security

delete-cloud-token-by-uuid

• Method: DELETE
• Path: /api/v1/cloud-tokens/{uuid}
• Description: Delete cloud provider token by UUID. Cannot delete if token is used by any servers. UUID of the cloud provider token.
• Category: Security

delete-private-key-by-uuid

• Method: DELETE
• Path: /api/v1/security/keys/{uuid}
• Description: Delete a private key. Private Key UUID
• Category: Security

disable-api

• Method: GET
• Path: /api/v1/disable
• Description: Disable API (only with root permissions). application/json
• Category: Security

enable-api

• Method: GET
• Path: /api/v1/enable
• Description: Enable API (only with root permissions). application/json
• Category: Security

get-cloud-token-by-uuid

• Method: GET
• Path: /api/v1/cloud-tokens/{uuid}
• Description: Get cloud provider token by UUID. Get cloud provider token by UUID
• Category: Security

get-private-key-by-uuid

• Method: GET
• Path: /api/v1/security/keys/{uuid}
• Description: Get key by UUID. Private Key UUID
• Category: Security

list-cloud-tokens

• Method: GET
• Path: /api/v1/cloud-tokens
• Description: List all cloud provider tokens for the authenticated team. Get all cloud provider tokens.
• Category: Security

list-private-keys

• Method: GET
• Path: /api/v1/security/keys
• Description: List all private keys. Get all private keys.
• Category: Security

update-cloud-token-by-uuid

• Method: PATCH
• Path: /api/v1/cloud-tokens/{uuid}
• Description: Update cloud provider token name. application/json
• Category: Security

update-private-key

• Method: PATCH
• Path: /api/v1/security/keys
• Description: Update a private key. application/json
• Category: Security

validate-cloud-token-by-uuid

• Method: POST
• Path: /api/v1/cloud-tokens/{uuid}/validate
• Description: Validate a cloud provider token against the provider API. Token validation result.
• Category: Security

---

Servers

create-hetzner-server

• Method: POST
• Path: /api/v1/servers/hetzner
• Description: Create a new server on Hetzner and register it in Coolify. application/json
• Category: Servers

create-server

• Method: POST
• Path: /api/v1/servers
• Description: application/json "name": "My Server",
• Category: Servers

delete-server-by-uuid

• Method: DELETE
• Path: /api/v1/servers/{uuid}
• Description: Delete server by UUID. UUID of the server.
• Category: Servers

get-domains-by-server-uuid

• Method: GET
• Path: /api/v1/servers/{uuid}/domains
• Description: Get domains by server. Get domains by server
• Category: Servers

get-hetzner-images

• Method: GET
• Path: /api/v1/hetzner/images
• Description: Get all available Hetzner system images (operating systems). cloud_provider_token_uuid
• Category: Servers

get-hetzner-locations

• Method: GET
• Path: /api/v1/hetzner/locations
• Description: Get all available Hetzner datacenter locations. cloud_provider_token_uuid
• Category: Servers

get-hetzner-server-types

• Method: GET
• Path: /api/v1/hetzner/server-types
• Description: Get all available Hetzner server types (instance sizes). cloud_provider_token_uuid
• Category: Servers

get-hetzner-ssh-keys

• Method: GET
• Path: /api/v1/hetzner/ssh-keys
• Description: Get all SSH keys stored in the Hetzner account. cloud_provider_token_uuid
• Category: Servers

get-resources-by-server-uuid

• Method: GET
• Path: /api/v1/servers/{uuid}/resources
• Description: Get resources by server. Get resources by server
• Category: Servers

get-server-by-uuid

• Method: GET
• Path: /api/v1/servers/{uuid}
• Description: Get server by UUID. Get server by UUID
• Category: Servers

list-resources

• Method: GET
• Path: /api/v1/resources
• Description: Get all resources. Get all resources
• Category: Servers

list-servers

• Method: GET
• Path: /api/v1/servers
• Description: List all servers. Get all servers.
• Category: Servers

update-server-by-uuid

• Method: PATCH
• Path: /api/v1/servers/{uuid}
• Description: application/json "name": "string",
• Category: Servers

validate-server-by-uuid

• Method: GET
• Path: /api/v1/servers/{uuid}/validate
• Description: Validate server by UUID. Server validation started.
• Category: Servers

---

Services

create-env-by-service-uuid

• Method: POST
• Path: /api/v1/services/{uuid}/envs
• Description: Create env by service UUID. UUID of the service.
• Category: Services

create-service

• Method: POST
• Path: /api/v1/services
• Description: Create a one-click / custom service application/json
• Category: Services

delete-env-by-service-uuid

• Method: DELETE
• Path: /api/v1/services/{uuid}/envs/{env_uuid}
• Description: Delete env by UUID. UUID of the service.
• Category: Services

delete-service-by-uuid

• Method: DELETE
• Path: /api/v1/services/{uuid}
• Description: Delete service by UUID. delete_configurations
• Category: Services

get-service-by-uuid

• Method: GET
• Path: /api/v1/services/{uuid}
• Description: Get service by UUID. Get a service by UUID.
• Category: Services

list-envs-by-service-uuid

• Method: GET
• Path: /api/v1/services/{uuid}/envs
• Description: List all envs by service UUID. UUID of the service.
• Category: Services

list-services

• Method: GET
• Path: /api/v1/services
• Description: List all services. Get all services
• Category: Services

restart-service-by-uuid

• Method: GET
• Path: /api/v1/services/{uuid}/restart
• Description: Restart service. Post request is also accepted. UUID of the service.
• Category: Services

start-service-by-uuid

• Method: GET
• Path: /api/v1/services/{uuid}/start
• Description: Start service. Post request is also accepted. UUID of the service.
• Category: Services

stop-service-by-uuid

• Method: GET
• Path: /api/v1/services/{uuid}/stop
• Description: Stop service. Post request is also accepted. UUID of the service.
• Category: Services

update-env-by-service-uuid

• Method: PATCH
• Path: /api/v1/services/{uuid}/envs
• Description: Update env by service UUID. UUID of the service.
• Category: Services

update-envs-by-service-uuid

• Method: PATCH
• Path: /api/v1/services/{uuid}/envs/bulk
• Description: Update multiple envs by service UUID. UUID of the service.
• Category: Services

update-service-by-uuid

• Method: PATCH
• Path: /api/v1/services/{uuid}
• Description: Update service by UUID. UUID of the service.
• Category: Services

---

Teams

get-current-team

• Method: GET
• Path: /api/v1/teams/current
• Description: Get currently authenticated team. application/json
• Category: Teams

get-current-team-members

• Method: GET
• Path: /api/v1/teams/current/members
• Description: Get currently authenticated team members. Currently authenticated team members.
• Category: Teams

get-members-by-team-id

• Method: GET
• Path: /api/v1/teams/{id}/members
• Description: Get members by TeamId. List of members.
• Category: Teams

get-team-by-id

• Method: GET
• Path: /api/v1/teams/{id}
• Description: Get team by TeamId. application/json
• Category: Teams

list-teams

• Method: GET
• Path: /api/v1/teams
• Description: application/json "name": "string",
• Category: Teams

---

Generated: 2026-04-15T21:32:31.984Z | Total: 107 endpoints | 11 categories