Coolify Octri Demo
PUT/applications/{uuid}/storages/{storage_uuid}/backups

Set an application storage backup schedule

Replaces the backup schedule for an application's persistent volume or directory storage, or creates a schedule if one does not exist. Supply frequency and configure any desired retention, local backup, or S3 destination settings. Setting stop_during_backup requires a token with deploy permission.

2 parameters · 15 body fields
uuidstringrequired
The UUID of the application whose storage backup schedule to set.
storage_uuidstringrequired
The UUID of the persistent volume or directory storage for the backup schedule.

Backup schedule settings. Supply frequency; all other fields are optional and use their documented defaults when omitted.

disable_local_backupbooleanoptional
Whether to disable local backups. Defaults to false when omitted.
Default:false
enabledbooleanoptional
Whether the backup schedule is enabled. Defaults to true when omitted.
Default:true
frequencystringrequired
The backup schedule frequency. Must not exceed 255 characters.
missing_backup_notification_daysintegeroptional
Alert after this many days without an execution; 0 disables alerts
Default:0
retention_amount_locallyintegeroptional
Number of local backups to retain. Must be between 0 and 10000. Defaults to 7 when omitted.
Default:7
retention_amount_s3integeroptional
Number of S3 backups to retain. Must be between 0 and 10000. Defaults to 7 when omitted.
Default:7
retention_days_locallyintegeroptional
Number of days to retain local backups. Must be between 0 and 2147483647. Defaults to 0 when omitted.
Default:0
retention_days_s3integeroptional
Number of days to retain S3 backups. Must be between 0 and 2147483647. Defaults to 0 when omitted.
Default:0
retention_max_storage_locallynumberoptional
Maximum local backup storage to retain. Must be between 0 and 9999999999. Defaults to 0 when omitted.
Default:0
retention_max_storage_s3numberoptional
Maximum S3 backup storage to retain. Must be between 0 and 9999999999. Defaults to 0 when omitted.
Default:0
s3_storage_uuidstringoptional
Primary S3 storage UUID. Sent without s3_storage_uuids, it selects this storage as the only destination.
s3_storage_uuidsarray<string>optional
UUIDs of every S3 storage the backup is uploaded to. When s3_storage_uuid is also sent, it must be in this list and becomes the primary destination; otherwise the first entry is the primary destination. save_s3 requires at least one destination.
save_s3booleanoptional
Whether to save backups to S3. Defaults to false when omitted.
Default:false
stop_during_backupbooleanoptional
Stop the resource containers during the backup. Needs a token with the deploy permission.
Default:false
timeoutintegeroptional
Backup timeout in seconds. Must be between 60 and 36000. Defaults to 36000 when omitted.
Default:36000

7 status codes
200Returns the replaced backup schedule, including its settings, storage identifiers, and message.
disable_local_backupbooleanrequired
enabledbooleanrequired
frequencystringrequired
messagestringrequired
missing_backup_notification_daysintegerrequired
retention_amount_locallyintegerrequired
retention_amount_s3integerrequired
retention_days_locallyintegerrequired
retention_days_s3integerrequired
retention_max_storage_locallynumberrequired
retention_max_storage_s3numberrequired
s3_storage_uuidstringoptional
Primary S3 destination.
s3_storage_uuidsarray<string>optional
Every S3 destination, primary first.
save_s3booleanrequired
stop_during_backupbooleanrequired
storage_typestringrequired
Allowed:persistentdirectory
storage_uuidstringrequired
timeoutintegerrequired
uuidstringrequired
201Returns the created backup schedule, including its settings, storage identifiers, and message.
disable_local_backupbooleanrequired
enabledbooleanrequired
frequencystringrequired
messagestringrequired
missing_backup_notification_daysintegerrequired
retention_amount_locallyintegerrequired
retention_amount_s3integerrequired
retention_days_locallyintegerrequired
retention_days_s3integerrequired
retention_max_storage_locallynumberrequired
retention_max_storage_s3numberrequired
s3_storage_uuidstringoptional
Primary S3 destination.
s3_storage_uuidsarray<string>optional
Every S3 destination, primary first.
save_s3booleanrequired
stop_during_backupbooleanrequired
storage_typestringrequired
Allowed:persistentdirectory
storage_uuidstringrequired
timeoutintegerrequired
uuidstringrequired
400Returned when the API token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when access is forbidden or the token lacks deploy permission for `stop_during_backup`.
404Returned when the application or storage resource is not found.
messagestringoptional
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token; a 401 when the request is unauthenticated; a 403 when access is forbidden or the token lacks deploy permission for stop_during_backup; a 404 when the uuid path parameter or storage_uuid path parameter identifies no resource; and a 422 for a validation error. frequency is required and must not exceed 255 characters. Numeric retention and timeout fields must meet their schema ranges; when save_s3 is enabled, provide at least one S3 destination in s3_storage_uuids.