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

Get the recovery key

Get the recovery key of the console backups.

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

OK

backups_enabledbooleanrequired

A confirmed recovery key exists, so backups can run

currentBackupKeyItem

The recovery key that each backup uses

Show properties
confirmed_atstring<date-time>

When an admin confirmed the key. Not set for a key that waits for its confirm

created_atstring<date-time>required
fingerprintstringrequired
recipientstringrequired

The age public key

disabled_reasonstring

Why no backup runs, when backups_enabled is false

earlierEarlierBackupKeyItem[]required

The recovery keys of the older archives, newest first

Show properties
Array of EarlierBackupKeyItem
created_atstring<date-time>required

The start of the time that the backups used the key

fingerprintstringrequired
retired_atstring<date-time>required

The end of the time that the backups used the key

pendingBackupKeyItem

A new recovery key that waits for its confirm. The backups use the current key until the confirm

Show properties
confirmed_atstring<date-time>

When an admin confirmed the key. Not set for a key that waits for its confirm

created_atstring<date-time>required
fingerprintstringrequired
recipientstringrequired

The age public key

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/keys' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "backups_enabled": true,
  "current": {
    "confirmed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "fingerprint": "string",
    "recipient": "string"
  },
  "disabled_reason": "string",
  "earlier": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "fingerprint": "string",
      "retired_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pending": {
    "confirmed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "fingerprint": "string",
    "recipient": "string"
  }
}