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

Make the first recovery key

Makes an age key pair and returns the private key once, as a file. The console keeps only the public key. The backups stay off until an admin confirms the key. A new setup replaces a key that waits for its confirm. With a confirmed key, use rotate.

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

OK

created_atstring<date-time>required
file_namestringrequired

The file name for the download of key_file

fingerprintstringrequired
key_filestringrequired

The recovery key file, with the private key. The console shows it only in this answer and does not keep it

recipientstringrequired

The age public key that the console keeps

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/keys/setup' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "file_name": "string",
  "fingerprint": "string",
  "key_file": "string",
  "recipient": "string"
}