Coolify Octri Demo
PATCH/servers/{uuid}/docker-cleanup

Update Docker cleanup settings

Updates Docker cleanup settings for a server owned by the authenticated team. Supply the settings you want to change; turning on delete_unused_volumes requires a token with the deploy permission. The response contains the updated settings.

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

1 parameter · 6 body fields
uuidstringrequired
The UUID of the server whose Docker cleanup settings you want to update.

Docker cleanup settings to update. The individual fields are optional.

delete_unused_networksbooleanoptional
Whether to delete unused Docker networks during cleanup.
delete_unused_volumesbooleanoptional
Whether to delete unused Docker volumes during cleanup. Turning this on requires the `deploy` permission.
disable_application_image_retentionbooleanoptional
Whether to disable retention of application images.
docker_cleanup_frequencystringoptional
Cron / human frequency expression.
docker_cleanup_thresholdintegeroptional
The cleanup threshold. Must be between 1 and 99.
force_docker_cleanupbooleanoptional
Whether to force Docker cleanup.

6 status codes
200Returns the updated Docker cleanup settings, including the configured cleanup options and schedule.
delete_unused_networksbooleanoptional
delete_unused_volumesbooleanoptional
disable_application_image_retentionbooleanoptional
docker_cleanup_frequencystringoptional
docker_cleanup_thresholdintegeroptional
force_docker_cleanupbooleanoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when `delete_unused_volumes` is turned on without the `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 when you turn on delete_unused_volumes without the 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, and docker_cleanup_threshold must be between 1 and 99.