Coolify Octri Demo
POST/services/{uuid}/databases/{database_uuid}/start

Start or redeploy a service database

Starts or redeploys a compose database container by running Docker Compose up. Use force or latest to control the deployment behavior; both default to false when omitted. The response confirms that the deploy request was queued.

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

4 parameters
uuidstringrequired
The UUID of the service that contains the database.
database_uuidstringrequired
The UUID of the compose service database to start or redeploy.
forcebooleanoptional
Whether to force the deployment. Defaults to false when omitted.
Default:false
latestbooleanoptional
Whether to deploy the latest image. Defaults to false when omitted.
Default:false

5 status codes
200Returns an object with a message confirming that the deploy request was queued.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service or service database does not exist.
messagestringoptional
501Returned when Swarm is not supported.

Error handling

A 400 is returned for an invalid token, and a 401 when authentication is missing. A 404 is returned when the uuid path parameter or database_uuid path parameter does not identify a resource; a 501 is returned when Swarm is not supported. force and latest are boolean query parameters and default to false when omitted.