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

Stop a service

Stops a service identified by its UUID. Use docker_cleanup to control whether Docker cleanup runs when server disk usage reaches its cleanup threshold; cleanup is skipped if it ran on the server in the previous hour. A 200 response returns a message confirming the stop request.

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

2 parameters
uuidstringrequired
The UUID of the service to stop.
docker_cleanupbooleanoptional
Whether to run Docker cleanup when the 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 service stop request was processed.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service cannot be found.
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 when the request is unauthenticated. A 404 is returned when uuid does not identify an existing service.