Coolify Octri Demo
POST/databases/redis

Create a Redis database

Creates a Redis database. Provide the server and project identifiers along with the environment details, and optionally configure the database name, image, or resource limits. The request schema marks server_uuid, project_uuid, environment_name, and environment_uuid as required.

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

22 body fields

Redis database configuration. The schema requires server_uuid, project_uuid, environment_name, and environment_uuid.

descriptionstringoptional
Description of the database
destination_uuidstringoptional
UUID of the destination if the server has multiple destinations
environment_namestringrequired
Name of the environment. You need to provide at least one of environment_name or environment_uuid.
environment_uuidstringrequired
UUID of the environment. You need to provide at least one of environment_name or environment_uuid.
imagestringoptional
Docker Image of the database
instant_deploybooleanoptional
Instant deploy the database
is_publicbooleanoptional
Is the database public?
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
namestringoptional
Name of the database
project_uuidstringrequired
UUID of the project
public_portintegeroptional
Public port of the database
public_port_timeoutintegeroptional
Public port timeout in seconds (default: 3600)
redis_confstringoptional
Redis conf
redis_passwordstringoptional
Redis password
server_uuidstringrequired
UUID of the server
tagsarray<string>optional
Tags to assign to the database.

4 status codes
200Returns confirmation that the database was created or updated.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
422Returned when database data fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, a 401 is returned when the request is unauthenticated, and a 422 is returned when database data fails validation. The schema requires server_uuid, project_uuid, environment_name, and environment_uuid; provide values for each required field.