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

Restore a database service

Restore a database service from backups.

POST/api/v1/database-services/{id}/restore
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
application/json
allow_checksum_errorsboolean

Restore a backup with the Checksum errors mark (invalid page checksums) anyway. Without it, a restore or a fork that lands on such a backup is refused (422). The restore then copies every file (no delta), and pgBackRest stops at the first corrupt file

backup_setstring
bootstrap_grantstring

Machine file for the copy, issued to the source fingerprint under this service's license; for consoles that cannot mint one

modestring
repointeger<int64>
source_repo_indexinteger<int64>
source_repo_server_idstring
source_stanza_idstring
target_timestring
Responses
202

Accepted

backupConfigOutOfSyncbooleanrequired
backupNeedsAttentionbooleanrequired
backupUnprotectedbooleanrequired
created_atstringrequired
data_dirstringrequired
database_namestringrequired
extension_versionsobjectrequired

The stored version of each extension whose packages the deploy installs, by extension name. TimescaleDB is timescaledb_version too.

extensionsstring[]required
healthServiceHealthResponse

The stored health verdict of a running service. Absent before the first poll and when the service is not running.

Show properties
checked_atstring<date-time>

The time of the last real reading. Absent when there is none. When it is 15 minutes old or older, status is error with a reason that names the checks that did not run.

componentsComponentHealthResponse[]required
Show properties
Array of ComponentHealthResponse
keystringrequired

The stable key of the component: the path segment of its endpoint. Name is text for people and can change.

Allowed:patronietcdpgbouncerhaproxypgbackrestpostgresqlreservevip
messagestring
namestringrequired
statusstringrequired
Allowed:healthywarningerrorunknownnot_applicable
reasonstringrequired
sincestring<date-time>

The time the status last changed. Absent on a live reading.

statusstringrequired
Allowed:healthywarningerrorunknown
idstringrequired
license_enforcedboolean
livesync_targetboolean
namestringrequired
pack_releasestringrequired

The release of the server packages that the PostgreSQL servers of the service install from, for example v0.11.0-eap.1. Empty when the service has no pin yet: its next deploy pins the newest loaded release that has its versions

pg_versionstring
pg_version_minorstring
postgresql_existsbooleanrequired
redeploy_recommendedbooleanrequired
resolvedResolvedEcho
Show properties
backup_setstring
modestringrequired
repointeger<int64>required
statusstringrequired
timescaledb_versionstring

Empty when unknown (a service from before TSE-734)

topologystringrequired
Allowed:single_nodestandard_haadvanced_ha
updates_availablebooleanrequired

The Updates tab of the service lists items: the service runs, and its pinned server packages or a newer loaded release have newer versions, or the loaded server components are newer. Nothing changes until an operator runs Check and an admin runs Upgrade

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/database-services/string/restore' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "allow_checksum_errors": true,
  "backup_set": "string",
  "bootstrap_grant": "string",
  "mode": "string",
  "repo": 0,
  "source_repo_index": 0,
  "source_repo_server_id": "string",
  "source_stanza_id": "string",
  "target_time": "string"
}'
Response
{
  "backupConfigOutOfSync": true,
  "backupNeedsAttention": true,
  "backupUnprotected": true,
  "created_at": "string",
  "data_dir": "string",
  "database_name": "string",
  "extension_versions": {
    "property1": "string",
    "property2": "string"
  },
  "extensions": [
    "string"
  ],
  "health": {
    "checked_at": "2019-08-24T14:15:22Z",
    "components": [
      {
        "key": "patroni",
        "message": "string",
        "name": "string",
        "status": "healthy"
      }
    ],
    "reason": "string",
    "since": "2019-08-24T14:15:22Z",
    "status": "healthy"
  },
  "id": "string",
  "license_enforced": true,
  "livesync_target": true,
  "name": "string",
  "pack_release": "string",
  "pg_version": "string",
  "pg_version_minor": "string",
  "postgresql_exists": true,
  "redeploy_recommended": true,
  "resolved": {
    "backup_set": "string",
    "mode": "string",
    "repo": 0
  },
  "status": "string",
  "timescaledb_version": "string",
  "topology": "single_node",
  "updates_available": true
}