Get a database service
/api/v1/database-services/{id}tse_sessionAPI key · cookierequiredidstringrequiredOK
backupConfigOutOfSyncbooleanrequiredbackupNeedsAttentionbooleanrequiredbackupUnprotectedbooleanrequiredcomponentsComponentInfo[]requiredShow propertiesHide properties
ComponentInfonamestringrequiredserver_idsstring[]requiredconnection_stringsRenderedConnection[]requiredShow propertiesHide properties
RenderedConnectionrecommendedbooleanrequiredservicestringrequiredpostgrespgbouncerhaproxyhaproxy-directuristringrequiredconnectionsConnectionEntry[]requiredShow propertiesHide properties
ConnectionEntrydatabasestringrequiredhoststringrequiredpasswordstringrequiredpooledbooleanrequiredportinteger<int64>requiredtypestringrequiredpostgrespgbouncerhaproxyhaproxy-directusernamestringrequiredcreated_atstringrequireddata_dirstringrequireddatabase_namestringrequireddcs_cluster_idstringdcs_cluster_namestringdcs_cluster_used_by_countinteger<int64>demo_memory_mbinteger<int64>Demo service only: the memory of PostgreSQL on each demo server, in MB
extension_versionsobjectrequiredThe stored version of each extension whose packages the deploy installs, by extension name. TimescaleDB is timescaledb_version too.
extensionsstring[]requiredhealthServiceHealthResponseThe stored health verdict of a running service. Absent before the first poll and when the service is not running.
Show propertiesHide 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[]requiredShow propertiesHide properties
ComponentHealthResponsekeystringrequiredThe stable key of the component: the path segment of its endpoint. Name is text for people and can change.
patronietcdpgbouncerhaproxypgbackrestpostgresqlreservevipmessagestringnamestringrequiredstatusstringrequiredhealthywarningerrorunknownnot_applicablereasonstringrequiredsincestring<date-time>The time the status last changed. Absent on a live reading.
statusstringrequiredhealthywarningerrorunknownidstringrequiredlicense_enforcedbooleanlicense_filestringlicense_max_machinesinteger<int64>license_max_memory_gbinteger<int64>license_max_vcpusinteger<int64>license_tierstringlivesync_targetbooleanlocal_connection_stringsRenderedConnection[]Show propertiesHide properties
RenderedConnectionrecommendedbooleanrequiredservicestringrequiredpostgrespgbouncerhaproxyhaproxy-directuristringrequirednamestringrequiredpack_releasestringrequiredThe 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_redactedbooleanpg_versionstringpg_version_minorstringpostgresql_existsbooleanrequiredredeploy_recommendedbooleanrequiredserversServiceServerInfo[]requiredShow propertiesHide properties
ServiceServerInfoidstringrequiredlan_address_changeLanAddressChangeShow propertiesHide properties
changed_atstring<date-time>requiredcurrentstringrequiredpreviousstringrequiredlicense_cap_stalebooleanrequiredlicense_cappedbooleanrequiredmemory_gbinteger<int64>requirednamestringrequiredrebuild_errorstringrequiredrebuild_pendingbooleanrequiredrebuild_statestringrequiredrunning, failed, or empty when no rebuild runs or failed
rolestringrequiredvcpusinteger<int64>requiredvip_problemstringsizestringslotsServiceSlotInfo[]requiredShow propertiesHide properties
ServiceSlotInfomember_namestringrequiredprevious_server_idstringrequiredprevious_server_namestringrequiredrebuild_pendingbooleanrequiredrolestringrequiredserver_idstringrequiredserver_namestringrequiredstanzaStanzaResponseShow propertiesHide properties
idstringrequirednamestringrequiredreposRepoResponse[]requiredShow propertiesHide properties
RepoResponseappliedbooleanrequiredattached_server_idsstring[]requireddiff_cronstringrequireddiff_enabledbooleanrequiredfull_cronstringrequiredfull_enabledbooleanrequiredhost_server_idstringrequiredhost_server_namestringrequiredidstringrequiredpathstringrequiredrepo_indexinteger<int64>requiredretention_fullinteger<int64>requiredretention_full_typestringrequiredcounttimestatusstringrequiredactivedetachedstatusstringrequiredtimescaledb_versionstringEmpty when unknown (a service from before TSE-734)
topologystringrequiredsingle_nodestandard_haadvanced_hatypestringrequiredsingle-nodehigh-availabilityupdates_availablebooleanrequiredThe 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
vipstringwrite_lockWriteLockInfoShow propertiesHide properties
guard_checked_atstring<date-time>guard_detailstringguard_statestringoklockednot_loadedunavailablelicense_expirystring<date-time>lockedbooleanrequiredWrites are expected to be refused on this service's cluster
reasonstringtrial_expiredlicense_expiredlicense_revokedError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message