Sign in
Backups
backups

Create Backup Schedule

Create or update backup schedule

post/api/v1/backups/schedule

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Headers

X-API-Keystring nullable

Request body

frequencystring

Frequency: daily, weekly, or monthly

retention_daysinteger

Days to retain backups

backup_timestring

Time to run backup (HH:MM UTC)

s3_bucketstring required

S3 bucket for backup storage

max_backup_size_gbinteger

Maximum backup size

enable_incrementalboolean

Enable incremental backups

Response

Successful Response

schedule_idstring uuid required
statusstring required
messagestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.