Coolify Octri Demo
PATCH/databases/{uuid}

Update a database

Updates a database identified by its UUID. Supply the database properties you want to change, such as description, image, or health-check settings. Changing is_public or enabling instant_deploy requires deploy permission; adding predefined Coolify variables requires team admin permissions.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 50 body fields
uuidstringrequired
The UUID of the database to update.

Database properties to update. Changing is_public or using instant_deploy requires deploy permission; enabling include_coolify_default_variables requires team admin permissions.

clickhouse_admin_passwordstringoptional
Clickhouse admin password
clickhouse_admin_userstringoptional
Clickhouse admin user
descriptionstringoptional
Description of the database
dragonfly_passwordstringoptional
DragonFly password
health_check_enabledbooleanoptional
Enable the database healthcheck probe.
Default:true
health_check_intervalintegeroptional
Healthcheck interval in seconds.
Default:15
health_check_retriesintegeroptional
Healthcheck retries count.
Default:5
health_check_start_periodintegeroptional
Healthcheck start period in seconds.
Default:5
health_check_timeoutintegeroptional
Healthcheck timeout in seconds.
Default:5
imagestringoptional
Docker Image of the database
include_coolify_default_variablesbooleanoptional
Add the predefined COOLIFY_* variables (COOLIFY_URL, COOLIFY_FQDN, ...) to the environment. Requires team admin permissions. Restart the database to apply it.
instant_deploybooleanoptional
Restart the database after the update. Requires the deploy ability.
is_log_drain_enabledbooleanoptional
Send the database logs to the log drain of the server. Log drain must be enabled on the server. Restart the database to apply it.
is_publicbooleanoptional
Is the database public? Changing it starts or stops the database proxy, so it needs a token with the deploy permission.
keydb_confstringoptional
KeyDB conf
keydb_passwordstringoptional
KeyDB password
limits_cpu_sharesintegeroptional
CPU shares of the database
limits_cpusstringoptional
CPU limit of the database
limits_cpusetstringoptional
CPU set of the database
limits_memorystringoptional
Memory limit of the database
limits_memory_reservationstringoptional
Memory reservation of the database
limits_memory_swapstringoptional
Memory swap limit of the database
limits_memory_swappinessintegeroptional
Memory swappiness of the database
mariadb_confstringoptional
MariaDB conf
mariadb_databasestringoptional
MariaDB database
mariadb_passwordstringoptional
MariaDB password
mariadb_root_passwordstringoptional
MariaDB root password
mariadb_userstringoptional
MariaDB user
mongo_confstringoptional
Mongo conf
mongo_initdb_databasestringoptional
Mongo initdb init database
mongo_initdb_root_passwordstringoptional
Mongo initdb root password
mongo_initdb_root_usernamestringoptional
Mongo initdb root username
mysql_confstringoptional
MySQL conf
mysql_databasestringoptional
MySQL database
mysql_passwordstringoptional
MySQL password
mysql_root_passwordstringoptional
MySQL root password
mysql_userstringoptional
MySQL user
namestringoptional
Name of the database
postgres_confstringoptional
PostgreSQL conf
postgres_dbstringoptional
PostgreSQL database
postgres_host_auth_methodstringoptional
PostgreSQL host auth method
postgres_initdb_argsstringoptional
PostgreSQL initdb args
postgres_passwordstringoptional
PostgreSQL password
postgres_userstringoptional
PostgreSQL user
public_portintegeroptional
Public port of the database (1024-65535)
public_port_timeoutintegeroptional
Public port timeout in seconds (default: 3600)
redact_all_env_values_in_logsbooleanoptional
Redact all environment variable values in logs. When false, only locked (shown once) values, database passwords, and remote secrets are redacted. Requires team admin permissions.
redis_confstringoptional
Redis conf
redis_passwordstringoptional
Redis password
sqlite_databasesstringoptional
Comma-separated SQLite database file names

6 status codes
200Returns confirmation that the database was updated.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the token lacks deploy permission to change `is_public` or use `instant_deploy`.
404Returned when the database resource is not found.
messagestringoptional
422Returned when database data fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 is returned when the request is unauthenticated. A 403 is returned when you lack deploy permission to change is_public or use instant_deploy; a 404 indicates the database was not found, and a 422 indicates validation failed. The uuid path parameter must identify the database to update; health-check intervals, retries, and timeouts must be at least 1, and the start period must be at least 0.