database
Manage DB instances: start, stop, restart, create, update, delete, set environment variables, and schedule backups with history and on-demand triggers.
Instructions
Database CRUD, lifecycle, env vars, and backup-schedule actions — list via resource tool. Actions: get(uuid?, name?) · start(uuid?) · stop(uuid?) · restart(uuid?) · create(engine, server_uuid) · update(uuid?) · delete(uuid?, confirm) · delete_preview(uuid?, name?) · envs:list(uuid?) · envs:get(uuid?, env_uuid?, key?) · envs:create(uuid?, key, value) · envs:update(uuid?, env_uuid?, key?, value) · envs:delete(uuid?, env_uuid, confirm) · envs:bulk-update(uuid?, entries, confirm) · backup:create(uuid?, frequency) · backup:list(uuid?) · backup:history(uuid?, scheduled_backup_uuid) · backup:update(uuid?, scheduled_backup_uuid) · backup:delete(uuid?, scheduled_backup_uuid, confirm) · backup:now(uuid?, scheduled_backup_uuid) Safety: confirm for destructive ops · optional instance · reveal opt-in only
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Environment variable key | |
| name | No | Database name substring | |
| page | No | Page number for pagination | |
| uuid | No | Database UUID | |
| image | No | Custom database image | |
| value | No | Environment variable value | |
| action | Yes | The action to run | |
| engine | No | Database engine (required for create) | |
| format | No | Output format (default pretty) | |
| reveal | No | Reveal sensitive/masked values in full projection (default false — secrets masked as ***) | |
| confirm | No | Confirm destructive or public exposure ops | |
| enabled | No | Enable schedule | |
| entries | No | ||
| save_s3 | No | Upload backups to S3 | |
| timeout | No | Backup timeout in seconds | |
| dump_all | No | ||
| env_uuid | No | Environment variable UUID | |
| instance | No | Coolify instance name from registry (optional — uses env credentials or registry default) | |
| per_page | No | Items per page | |
| delete_s3 | No | Also delete S3 backup artifacts | |
| frequency | No | Backup frequency preset or cron expression | |
| is_public | No | Expose database port publicly | |
| max_chars | No | Max formatted output characters (default 16000) | |
| backup_now | No | ||
| is_literal | No | ||
| mysql_user | No | ||
| projection | No | Detail projection depth | |
| description | No | Database description | |
| limits_cpus | No | ||
| postgres_db | No | ||
| public_port | No | Public port when is_public | |
| server_uuid | No | Target server UUID | |
| include_full | No | Alias for projection: full | |
| is_multiline | No | ||
| mariadb_user | No | ||
| project_name | No | Project name | |
| project_uuid | No | Project UUID | |
| is_shown_once | No | ||
| limits_cpuset | No | ||
| limits_memory | No | ||
| postgres_conf | No | ||
| postgres_user | No | ||
| delete_volumes | No | ||
| docker_cleanup | No | ||
| instant_deploy | No | Start database after create | |
| keydb_password | No | ||
| mysql_database | No | ||
| mysql_password | No | ||
| redis_password | No | ||
| s3_storage_uuid | No | S3 storage destination UUID | |
| destination_uuid | No | ||
| environment_name | No | Environment name | |
| environment_uuid | No | Environment UUID | |
| mariadb_database | No | ||
| mariadb_password | No | ||
| limits_cpu_shares | No | ||
| postgres_password | No | ||
| dragonfly_password | No | ||
| limits_memory_swap | No | ||
| databases_to_backup | No | ||
| mysql_root_password | No | ||
| public_port_timeout | No | Public port mapping timeout | |
| postgres_initdb_args | No | ||
| clickhouse_admin_user | No | ||
| delete_configurations | No | ||
| mariadb_root_password | No | ||
| mongo_initdb_database | No | ||
| scheduled_backup_uuid | No | Backup schedule UUID | |
| limits_memory_swappiness | No | ||
| clickhouse_admin_password | No | ||
| delete_connected_networks | No | ||
| limits_memory_reservation | No | ||
| postgres_host_auth_method | No | ||
| mongo_initdb_root_password | No | ||
| database_backup_retention_days_s3 | No | ||
| database_backup_retention_amount_s3 | No | ||
| database_backup_retention_days_locally | No | ||
| database_backup_retention_amount_locally | No | ||
| database_backup_retention_max_storage_s3 | No | ||
| database_backup_retention_max_storage_locally | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | No | ||
| _meta | No | ||
| error | No | ||
| _size_warning | No | ||
| _formattedText | No |