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

List console restores

Each restore that a start applied, and each swap that failed and rolled back. The list is in the store of the console, so a restore removes the rows from after the backup.

GET/api/v1/console-backup/restores
Authorization
tse_sessionAPI key · cookierequired
Query parameters
limitinteger<int64>
min 1 · max 200 · default: 20
Responses
200

OK

restoresConsoleRestoreItem[]required
Show properties
Array of ConsoleRestoreItem
archive_created_atstring<date-time>required

The time of the backup that the console was restored from

archive_idstringrequired
errorstring

The reason of a failed restore

releasestringrequired

The release of the archive

restored_atstring<date-time>required

The first start after the restore. For a failed restore: the time of the failed swap

restored_bystringrequired
statusstringrequired

applied: the console ran on the files of the archive. failed: the swap failed and rolled back, and error has the reason

Allowed:appliedfailed
tiersstring[]required

The tiers of the archive

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/restores' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "restores": [
    {
      "archive_created_at": "2019-08-24T14:15:22Z",
      "archive_id": "string",
      "error": "string",
      "release": "string",
      "restored_at": "2019-08-24T14:15:22Z",
      "restored_by": "string",
      "status": "applied",
      "tiers": [
        "string"
      ]
    }
  ]
}