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

List backup schedules

Each schedule has its next three runs in UTC. The first target gets a daily schedule at 02:00 UTC with the tiers core and logs, that keeps 14 archives and 30 days.

GET/api/v1/console-backup/schedules
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

schedulesBackupScheduleItem[]required
Show properties
Array of BackupScheduleItem
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 GET 'https://console.example.com/api/v1/console-backup/schedules' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "schedules": [
    {
      "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"
    }
  ]
}