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

Estimate the backup size

Gives the size of each tier before the compression, and whether this release can back it up. It reads the sizes of the files and writes no archive. A tier that takes more than 10 seconds gets an error. With no confirmed recovery key, the tiers have no size.

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

OK

tiersBackupTierEstimate[]required
Show properties
Array of BackupTierEstimate
availablebooleanrequired

This release can back up the tier. false: back up now and the schedules refuse the tier

errorstring

Why the tier has no size

sizeinteger<int64>

The bytes of the tier before the compression; the archive is smaller. None with no confirmed recovery key, for a tier that is not available, and with an error

tierstringrequired
Allowed:corelogspacksmetrics
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/size-estimate' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "tiers": [
    {
      "available": true,
      "error": "string",
      "size": 0,
      "tier": "core"
    }
  ]
}