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

Check a backup archive

Reads the archive back from the target and compares its size and SHA-256 with its sidecar. Needs no key. The sidecar keeps the result. Refused for an archive of another console.

POST/api/v1/console-backup/targets/{id}/archives/{name}/check
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
namestringrequired
Responses
200

OK

atstring<date-time>required
errorstring
okbooleanrequired

The archive read back from the target matches the size and the SHA-256 of its sidecar

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/targets/string/archives/string/check' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "at": "2019-08-24T14:15:22Z",
  "error": "string",
  "ok": true
}