Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Add a backup schedule

Refuses a cron expression that does not parse, a descriptor such as @daily, a time zone, and an expression that never runs. A tick that passes while the console is down does not run later. A tick that finds a backup running records a skipped run.

POST/api/v1/console-backup/schedules
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
cronstringrequired

A cron expression of 5 fields (minute hour day-of-month month day-of-week), in UTC. No descriptor such as @daily and no time zone

min length 1 · max length 200
enabledbooleanrequired

false: the schedule does not run

keep_countinteger<int64>required

After each successful run, keep the newest archives of the schedule on its target. 0: no count limit. The retention never deletes the newest successful archive, a manual archive or an archive of another console

min 0 · max 1000
max_age_daysinteger<int64>required

After each successful run, delete the archives of the schedule on its target that are older. 0: no age limit. Not 0 together with keep_count

min 0 · max 3650
target_idstringrequired
tiersstring[]required

The tiers of the archives. core is always in. logs adds the logs of the finished workflows. packs adds the loaded server packs, not the packs of the image. metrics adds the Prometheus data. A tier that this release cannot back up gives 422 (size-estimate shows the available tiers)

Responses
200

OK

created_atstring<date-time>required
cronstringrequired

A cron expression of 5 fields (minute hour day-of-month month day-of-week), in UTC

enabledbooleanrequired
idstringrequired
keep_countinteger<int64>required

The retention keeps the newest archives of the schedule on its target. 0: no count limit

max_age_daysinteger<int64>required

The retention deletes the archives of the schedule that are older. 0: no age limit

next_runsstring<date-time>[]required

The next three runs, in UTC. Empty when the schedule is off

target_idstringrequired
tiersstring[]required
updated_atstring<date-time>required
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/console-backup/schedules' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "cron": "string",
  "enabled": true,
  "keep_count": 0,
  "max_age_days": 0,
  "target_id": "string",
  "tiers": [
    "core"
  ]
}'
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "cron": "string",
  "enabled": true,
  "id": "string",
  "keep_count": 0,
  "max_age_days": 0,
  "next_runs": [
    "2019-08-24T14:15:22Z"
  ],
  "target_id": "string",
  "tiers": [
    "string"
  ],
  "updated_at": "2019-08-24T14:15:22Z"
}