openapi: 3.1.0
info:
title: Coolify
version: '0.1'
paths: {}
components:
schemas:
Application:
description: Application model
properties:
id:
type: integer
description: The application identifier in the database.
description:
type: string
nullable: true
description: The application description.
repository_project_id:
type: integer
nullable: true
description: The repository project identifier.
uuid:
type: string
description: The application UUID.
name:
type: string
description: The application name.
fqdn:
type: string
nullable: true
description: The application domains.
config_hash:
type: string
description: Configuration hash.
git_repository:
type: string
description: Git repository URL.
git_branch:
type: string
description: Git branch.
git_commit_sha:
type: string
description: Git commit SHA.
git_full_url:
type: string
nullable: true
description: Git full URL.
docker_registry_image_name:
type: string
nullable: true
description: Docker registry image name.
docker_registry_image_tag:
type: string
nullable: true
description: Docker registry image tag.
build_pack:
type: string
description: Build pack.
enum:
- nixpacks
- static
- dockerfile
- dockercompose
static_image:
type: string
description: Static image used when static site is deployed.
install_command:
type: string
description: Install command.
build_command:
type: string
description: Build command.
start_command:
type: string
description: Start command.
ports_exposes:
type: string
description: Ports exposes.
ports_mappings:
type: string
nullable: true
description: Ports mappings.
base_directory:
type: string
description: Base directory for all commands.
publish_directory:
type: string
description: Publish directory.
health_check_enabled:
type: boolean
description: Health check enabled.
health_check_path:
type: string
description: Health check path.
health_check_port:
type: string
nullable: true
description: Health check port.
health_check_host:
type: string
nullable: true
description: Health check host.
health_check_method:
type: string
description: Health check method.
health_check_return_code:
type: integer
description: Health check return code.
health_check_scheme:
type: string
description: Health check scheme.
health_check_response_text:
type: string
nullable: true
description: Health check response text.
health_check_interval:
type: integer
description: Health check interval in seconds.
health_check_timeout:
type: integer
description: Health check timeout in seconds.
health_check_retries:
type: integer
description: Health check retries count.
health_check_start_period:
type: integer
description: Health check start period in seconds.
limits_memory:
type: string
description: Memory limit.
limits_memory_swap:
type: string
description: Memory swap limit.
limits_memory_swappiness:
type: integer
description: Memory swappiness.
limits_memory_reservation:
type: string
description: Memory reservation.
limits_cpus:
type: string
description: CPU limit.
limits_cpuset:
type: string
nullable: true
description: CPU set.
limits_cpu_shares:
type: integer
description: CPU shares.
status:
type: string
description: Application status.
preview_url_template:
type: string
description: Preview URL template.
destination_type:
type: string
description: Destination type.
destination_id:
type: integer
description: Destination identifier.
source_id:
type: integer
nullable: true
description: Source identifier.
private_key_id:
type: integer
nullable: true
description: Private key identifier.
environment_id:
type: integer
description: Environment identifier.
dockerfile:
type: string
nullable: true
description: Dockerfile content. Used for dockerfile build pack.
dockerfile_location:
type: string
description: Dockerfile location.
custom_labels:
type: string
nullable: true
description: Custom labels.
dockerfile_target_build:
type: string
nullable: true
description: Dockerfile target build.
manual_webhook_secret_github:
type: string
nullable: true
description: Manual webhook secret for GitHub.
manual_webhook_secret_gitlab:
type: string
nullable: true
description: Manual webhook secret for GitLab.
manual_webhook_secret_bitbucket:
type: string
nullable: true
description: Manual webhook secret for Bitbucket.
manual_webhook_secret_gitea:
type: string
nullable: true
description: Manual webhook secret for Gitea.
docker_compose_location:
type: string
description: Docker compose location.
docker_compose:
type: string
nullable: true
description: Docker compose content. Used for docker compose build pack.
docker_compose_raw:
type: string
nullable: true
description: Docker compose raw content.
docker_compose_domains:
type: string
nullable: true
description: Docker compose domains.
docker_compose_custom_start_command:
type: string
nullable: true
description: Docker compose custom start command.
docker_compose_custom_build_command:
type: string
nullable: true
description: Docker compose custom build command.
swarm_replicas:
type: integer
nullable: true
description: Swarm replicas. Only used for swarm deployments.
swarm_placement_constraints:
type: string
nullable: true
description: Swarm placement constraints. Only used for swarm deployments.
custom_docker_run_options:
type: string
nullable: true
description: Custom docker run options.
post_deployment_command:
type: string
nullable: true
description: Post deployment command.
post_deployment_command_container:
type: string
nullable: true
description: Post deployment command container.
pre_deployment_command:
type: string
nullable: true
description: Pre deployment command.
pre_deployment_command_container:
type: string
nullable: true
description: Pre deployment command container.
watch_paths:
type: string
nullable: true
description: Watch paths.
custom_healthcheck_found:
type: boolean
description: Custom healthcheck found.
redirect:
type: string
nullable: true
description: How to set redirect with Traefik / Caddy. www<->non-www.
enum:
- www
- non-www
- both
created_at:
type: string
format: date-time
description: The date and time when the application was created.
updated_at:
type: string
format: date-time
description: The date and time when the application was last updated.
deleted_at:
type: string
format: date-time
nullable: true
description: The date and time when the application was deleted.
compose_parsing_version:
type: string
description: How Coolify parse the compose file.
custom_nginx_configuration:
type: string
nullable: true
description: Custom Nginx configuration base64 encoded.
type: object
ApplicationDeploymentQueue:
description: Project model
properties:
id:
type: integer
application_id:
type: string
deployment_uuid:
type: string
pull_request_id:
type: integer
force_rebuild:
type: boolean
commit:
type: string
status:
type: string
is_webhook:
type: boolean
is_api:
type: boolean
created_at:
type: string
updated_at:
type: string
logs:
type: string
current_process_id:
type: string
restart_only:
type: boolean
git_type:
type: string
server_id:
type: integer
application_name:
type: string
server_name:
type: string
deployment_url:
type: string
destination_id:
type: string
only_this_server:
type: boolean
rollback:
type: boolean
commit_message:
type: string
type: object
Environment:
description: Environment model
properties:
id:
type: integer
name:
type: string
project_id:
type: integer
created_at:
type: string
updated_at:
type: string
description:
type: string
type: object
EnvironmentVariable:
description: Environment Variable model
properties:
id:
type: integer
uuid:
type: string
resourceable_type:
type: string
resourceable_id:
type: integer
is_build_time:
type: boolean
is_literal:
type: boolean
is_multiline:
type: boolean
is_preview:
type: boolean
is_shared:
type: boolean
is_shown_once:
type: boolean
key:
type: string
value:
type: string
real_value:
type: string
version:
type: string
created_at:
type: string
updated_at:
type: string
type: object
PrivateKey:
description: Private Key model
properties:
id:
type: integer
uuid:
type: string
name:
type: string
description:
type: string
private_key:
type: string
format: private-key
is_git_related:
type: boolean
team_id:
type: integer
created_at:
type: string
updated_at:
type: string
type: object
Project:
description: Project model
properties:
id:
type: integer
uuid:
type: string
name:
type: string
description:
type: string
environments:
description: The environments of the project.
type: array
items:
$ref: '#/components/schemas/Environment'
type: object
Server:
description: Server model
properties:
id:
type: integer
description: The server ID.
uuid:
type: string
description: The server UUID.
name:
type: string
description: The server name.
description:
type: string
description: The server description.
ip:
type: string
description: The IP address.
user:
type: string
description: The user.
port:
type: integer
description: The port number.
proxy:
type: object
description: The proxy configuration.
proxy_type:
type: string
enum:
- traefik
- caddy
- none
description: The proxy type.
high_disk_usage_notification_sent:
type: boolean
description: The flag to indicate if the high disk usage notification has been sent.
unreachable_notification_sent:
type: boolean
description: The flag to indicate if the unreachable notification has been sent.
unreachable_count:
type: integer
description: The unreachable count for your server.
validation_logs:
type: string
description: The validation logs.
log_drain_notification_sent:
type: boolean
description: The flag to indicate if the log drain notification has been sent.
swarm_cluster:
type: string
description: The swarm cluster configuration.
settings:
$ref: '#/components/schemas/ServerSetting'
type: object
ServerSetting:
description: Server Settings model
properties:
id:
type: integer
concurrent_builds:
type: integer
dynamic_timeout:
type: integer
force_disabled:
type: boolean
force_server_cleanup:
type: boolean
is_build_server:
type: boolean
is_cloudflare_tunnel:
type: boolean
is_jump_server:
type: boolean
is_logdrain_axiom_enabled:
type: boolean
is_logdrain_custom_enabled:
type: boolean
is_logdrain_highlight_enabled:
type: boolean
is_logdrain_newrelic_enabled:
type: boolean
is_metrics_enabled:
type: boolean
is_reachable:
type: boolean
is_sentinel_enabled:
type: boolean
is_swarm_manager:
type: boolean
is_swarm_worker:
type: boolean
is_usable:
type: boolean
logdrain_axiom_api_key:
type: string
logdrain_axiom_dataset_name:
type: string
logdrain_custom_config:
type: string
logdrain_custom_config_parser:
type: string
logdrain_highlight_project_id:
type: string
logdrain_newrelic_base_uri:
type: string
logdrain_newrelic_license_key:
type: string
sentinel_metrics_history_days:
type: integer
sentinel_metrics_refresh_rate_seconds:
type: integer
sentinel_token:
type: string
docker_cleanup_frequency:
type: string
docker_cleanup_threshold:
type: integer
server_id:
type: integer
wildcard_domain:
type: string
created_at:
type: string
updated_at:
type: string
delete_unused_volumes:
type: boolean
description: The flag to indicate if the unused volumes should be deleted.
delete_unused_networks:
type: boolean
description: The flag to indicate if the unused networks should be deleted.
type: object
Service:
description: Service model
properties:
id:
type: integer
description: The unique identifier of the service. Only used for database identification.
uuid:
type: string
description: The unique identifier of the service.
name:
type: string
description: The name of the service.
environment_id:
type: integer
description: The unique identifier of the environment where the service is attached to.
server_id:
type: integer
description: The unique identifier of the server where the service is running.
description:
type: string
description: The description of the service.
docker_compose_raw:
type: string
description: The raw docker-compose.yml file of the service.
docker_compose:
type: string
description: The docker-compose.yml file that is parsed and modified by Coolify.
destination_type:
type: string
description: Destination type.
destination_id:
type: integer
description: The unique identifier of the destination where the service is running.
connect_to_docker_network:
type: boolean
description: The flag to connect the service to the predefined Docker network.
is_container_label_escape_enabled:
type: boolean
description: The flag to enable the container label escape.
is_container_label_readonly_enabled:
type: boolean
description: The flag to enable the container label readonly.
config_hash:
type: string
description: The hash of the service configuration.
service_type:
type: string
description: The type of the service.
created_at:
type: string
description: The date and time when the service was created.
updated_at:
type: string
description: The date and time when the service was last updated.
deleted_at:
type: string
description: The date and time when the service was deleted.
type: object
Team:
description: Team model
properties:
id:
type: integer
description: The unique identifier of the team.
name:
type: string
description: The name of the team.
description:
type: string
description: The description of the team.
personal_team:
type: boolean
description: Whether the team is personal or not.
created_at:
type: string
description: The date and time the team was created.
updated_at:
type: string
description: The date and time the team was last updated.
show_boarding:
type: boolean
description: Whether to show the boarding screen or not.
custom_server_limit:
type: string
description: The custom server limit.
members:
description: The members of the team.
type: array
items:
$ref: '#/components/schemas/User'
type: object
User:
description: User model
properties:
id:
type: integer
description: The user identifier in the database.
name:
type: string
description: The user name.
email:
type: string
description: The user email.
email_verified_at:
type: string
description: The date when the user email was verified.
created_at:
type: string
description: The date when the user was created.
updated_at:
type: string
description: The date when the user was updated.
two_factor_confirmed_at:
type: string
description: The date when the user two factor was confirmed.
force_password_reset:
type: boolean
description: The flag to force the user to reset the password.
marketing_emails:
type: boolean
description: The flag to receive marketing emails.
type: object
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/StuMason/coolify-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server