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

List backup targets

List the targets of the console backups.

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

OK

targetsBackupTargetItem[]required
Show properties
Array of BackupTargetItem
created_atstring<date-time>required
idstringrequired
kindstringrequired
Allowed:locals3
namestringrequired
secrets_setbooleanrequired

The target has stored credentials. The API never returns them

settingsBackupTargetSettingsBodyrequired
Show properties
s3S3BackupSettings

The settings of an s3 target. A local target has no settings

Show properties
bucketstringrequired
ca_bundlestring
endpointstring
path_styleboolean
prefixstring
regionstring
updated_atstring<date-time>required
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/targets' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "targets": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "id": "string",
      "kind": "local",
      "name": "string",
      "secrets_set": true,
      "settings": {
        "s3": {
          "bucket": "string",
          "ca_bundle": "string",
          "endpoint": "string",
          "path_style": true,
          "prefix": "string",
          "region": "string"
        }
      },
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}