Skip to main content
POST
/
api
/
folder-archive-schedules
Create a folder archive snapshot schedule
curl --request POST \
  --url https://convertly.sh/api/folder-archive-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Campaign assets backup",
  "hour": 2,
  "minute": 0
}
'
{
  "error": "<string>",
  "upgradeUrl": "<string>"
}

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Body

application/json
folderId
string<uuid>
required

Folder to snapshot. One schedule row applies to one folder.

name
string
required
Maximum string length: 120
Example:

"Campaign assets backup"

frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
hour
integer
required
Required range: 0 <= x <= 23
Example:

2

minute
integer
required
Required range: 0 <= x <= 59
Example:

0

dayOfWeek
integer

Required for weekly schedules. 0 = Sunday.

Required range: 0 <= x <= 6
dayOfMonth
integer

Required for monthly schedules.

Required range: 1 <= x <= 28
timezone
string
default:UTC
Example:

"America/New_York"

format
enum<string>
default:zip
Available options:
zip,
tar,
tgz
targetFolderId
string<uuid> | null

Where to store the archive. Defaults to the source folder.

retentionCount
integer
default:7

Maximum number of snapshots to keep for this schedule.

Required range: 1 <= x <= 365
retentionDays
integer
default:90

Delete snapshots older than this many days.

Required range: 1 <= x <= 3650
enabled
boolean
default:true

Response

Schedule created