Coolify Octri Demo
POST/servers/{uuid}/docker-cleanup/run

Run Docker cleanup

Triggers a manual Docker cleanup job for a server owned by the authenticated team. You can optionally set whether the job deletes unused networks or volumes; triggering the job requires a token with the write and deploy permissions. A 200 response confirms that the job was dispatched.

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

1 parameter · 2 body fields
uuidstringrequired
The UUID of the server on which to run Docker cleanup.

Optional settings for the manual Docker cleanup job.

delete_unused_networksbooleanoptional
Whether the job deletes unused Docker networks.
delete_unused_volumesbooleanoptional
Whether the job deletes unused Docker volumes.

6 status codes
200Returns a message confirming that the Docker cleanup job was dispatched.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the token lacks the `write` or `deploy` permission.
404Returned when the server resource is not found.
messagestringoptional
422Returned when the request 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 if the token lacks the write or deploy permission; a 404 indicates the server resource was not found, and a 422 indicates validation errors. The uuid path parameter must identify a server.