Coolify Octri Demo
POST/databases/{uuid}/stop

Stop a database

Stops a database identified by its UUID. Set docker_cleanup to control whether Docker cleanup runs when the server disk usage reaches or exceeds its cleanup threshold. Cleanup is skipped if it has already run on the server within the last hour.

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

2 parameters
uuidstringrequired
The UUID of the database to stop.
docker_cleanupbooleanoptional
Whether to run Docker cleanup when server disk usage is at or above its cleanup threshold; cleanup is skipped if it ran on the server in the last hour. Defaults to true when omitted.
Default:true

4 status codes
200Returns a message confirming that the database was stopped.
messagestringoptional
400Returned when the request contains an invalid token.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when a resource is not found.
messagestringoptional

Error handling

A 400 is returned for an invalid token, a 401 when the request is unauthenticated, and a 404 when the database resource is not found. The uuid path parameter must identify the database to stop; docker_cleanup defaults to true when omitted.