Create a folder archive snapshot schedule
Creates a per-folder recurring snapshot. Convertly runs due schedules automatically; you do not need your own cron unless you prefer one-off archives via POST /api/files/archive.
POST
Create a folder archive snapshot schedule
Authorizations
Dashboard-generated Convertly API key. Keys currently begin with cvly_.
Body
application/json
Folder to snapshot. One schedule row applies to one folder.
Maximum string length:
120Example:
"Campaign assets backup"
Available options:
daily, weekly, monthly Required range:
0 <= x <= 23Example:
2
Required range:
0 <= x <= 59Example:
0
Required for weekly schedules. 0 = Sunday.
Required range:
0 <= x <= 6Required for monthly schedules.
Required range:
1 <= x <= 28Example:
"America/New_York"
Available options:
zip, tar, tgz Where to store the archive. Defaults to the source folder.
Maximum number of snapshots to keep for this schedule.
Required range:
1 <= x <= 365Delete snapshots older than this many days.
Required range:
1 <= x <= 3650Response
Schedule created
Create a folder archive snapshot schedule