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

Get a database service

GET/api/v1/database-services/{id}
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

backupConfigOutOfSyncbooleanrequired
backupNeedsAttentionbooleanrequired
backupUnprotectedbooleanrequired
componentsComponentInfo[]required
Show properties
Array of ComponentInfo
namestringrequired
server_idsstring[]required
connection_stringsRenderedConnection[]required
Show properties
Array of RenderedConnection
recommendedbooleanrequired
servicestringrequired
Allowed:postgrespgbouncerhaproxyhaproxy-direct
uristringrequired
connectionsConnectionEntry[]required
Show properties
Array of ConnectionEntry
databasestringrequired
hoststringrequired
passwordstringrequired
pooledbooleanrequired
portinteger<int64>required
typestringrequired
Allowed:postgrespgbouncerhaproxyhaproxy-direct
usernamestringrequired
created_atstringrequired
data_dirstringrequired
database_namestringrequired
dcs_cluster_idstring
dcs_cluster_namestring
dcs_cluster_used_by_countinteger<int64>
demo_memory_mbinteger<int64>

Demo service only: the memory of PostgreSQL on each demo server, in MB

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
license_filestring
license_max_machinesinteger<int64>
license_max_memory_gbinteger<int64>
license_max_vcpusinteger<int64>
license_tierstring
livesync_targetboolean
local_connection_stringsRenderedConnection[]
Show properties
Array of RenderedConnection
recommendedbooleanrequired
servicestringrequired
Allowed:postgrespgbouncerhaproxyhaproxy-direct
uristringrequired
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

password_redactedboolean
pg_versionstring
pg_version_minorstring
postgresql_existsbooleanrequired
redeploy_recommendedbooleanrequired
serversServiceServerInfo[]required
Show properties
Array of ServiceServerInfo
idstringrequired
lan_address_changeLanAddressChange
Show properties
changed_atstring<date-time>required
currentstringrequired
previousstringrequired
license_cap_stalebooleanrequired
license_cappedbooleanrequired
memory_gbinteger<int64>required
namestringrequired
rebuild_errorstringrequired
rebuild_pendingbooleanrequired
rebuild_statestringrequired

running, failed, or empty when no rebuild runs or failed

rolestringrequired
vcpusinteger<int64>required
vip_problemstring
sizestring
slotsServiceSlotInfo[]required
Show properties
Array of ServiceSlotInfo
member_namestringrequired
previous_server_idstringrequired
previous_server_namestringrequired
rebuild_pendingbooleanrequired
rolestringrequired
server_idstringrequired
server_namestringrequired
stanzaStanzaResponse
Show properties
idstringrequired
namestringrequired
reposRepoResponse[]required
Show properties
Array of RepoResponse
appliedbooleanrequired
attached_server_idsstring[]required
diff_cronstringrequired
diff_enabledbooleanrequired
full_cronstringrequired
full_enabledbooleanrequired
host_server_idstringrequired
host_server_namestringrequired
idstringrequired
pathstringrequired
repo_indexinteger<int64>required
retention_fullinteger<int64>required
retention_full_typestringrequired
Allowed:counttime
statusstringrequired
Allowed:activedetached
statusstringrequired
timescaledb_versionstring

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

topologystringrequired
Allowed:single_nodestandard_haadvanced_ha
typestringrequired
Allowed:single-nodehigh-availability
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

vipstring
write_lockWriteLockInfo
Show properties
guard_checked_atstring<date-time>
guard_detailstring
guard_statestring
Allowed:oklockednot_loadedunavailable
license_expirystring<date-time>
lockedbooleanrequired

Writes are expected to be refused on this service's cluster

reasonstring
Allowed:trial_expiredlicense_expiredlicense_revoked
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/database-services/string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "backupConfigOutOfSync": true,
  "backupNeedsAttention": true,
  "backupUnprotected": true,
  "components": [
    {
      "name": "string",
      "server_ids": [
        "string"
      ]
    }
  ],
  "connection_strings": [
    {
      "recommended": true,
      "service": "postgres",
      "uri": "string"
    }
  ],
  "connections": [
    {
      "database": "string",
      "host": "string",
      "password": "string",
      "pooled": true,
      "port": 0,
      "type": "postgres",
      "username": "string"
    }
  ],
  "created_at": "string",
  "data_dir": "string",
  "database_name": "string",
  "dcs_cluster_id": "string",
  "dcs_cluster_name": "string",
  "dcs_cluster_used_by_count": 0,
  "demo_memory_mb": 0,
  "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,
  "license_file": "string",
  "license_max_machines": 0,
  "license_max_memory_gb": 0,
  "license_max_vcpus": 0,
  "license_tier": "string",
  "livesync_target": true,
  "local_connection_strings": [
    {
      "recommended": true,
      "service": "postgres",
      "uri": "string"
    }
  ],
  "name": "string",
  "pack_release": "string",
  "password_redacted": true,
  "pg_version": "string",
  "pg_version_minor": "string",
  "postgresql_exists": true,
  "redeploy_recommended": true,
  "servers": [
    {
      "id": "string",
      "lan_address_change": {
        "changed_at": "2019-08-24T14:15:22Z",
        "current": "string",
        "previous": "string"
      },
      "license_cap_stale": true,
      "license_capped": true,
      "memory_gb": 0,
      "name": "string",
      "rebuild_error": "string",
      "rebuild_pending": true,
      "rebuild_state": "string",
      "role": "string",
      "vcpus": 0,
      "vip_problem": "string"
    }
  ],
  "size": "string",
  "slots": [
    {
      "member_name": "string",
      "previous_server_id": "string",
      "previous_server_name": "string",
      "rebuild_pending": true,
      "role": "string",
      "server_id": "string",
      "server_name": "string"
    }
  ],
  "stanza": {
    "id": "string",
    "name": "string",
    "repos": [
      {
        "applied": true,
        "attached_server_ids": [
          "string"
        ],
        "diff_cron": "string",
        "diff_enabled": true,
        "full_cron": "string",
        "full_enabled": true,
        "host_server_id": "string",
        "host_server_name": "string",
        "id": "string",
        "path": "string",
        "repo_index": 0,
        "retention_full": 0,
        "retention_full_type": "count",
        "status": "active"
      }
    ]
  },
  "status": "string",
  "timescaledb_version": "string",
  "topology": "single_node",
  "type": "single-node",
  "updates_available": true,
  "vip": "string",
  "write_lock": {
    "guard_checked_at": "2019-08-24T14:15:22Z",
    "guard_detail": "string",
    "guard_state": "ok",
    "license_expiry": "2019-08-24T14:15:22Z",
    "locked": true,
    "reason": "trial_expired"
  }
}