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

Get live settings

Reads pg_settings in the database of the service on the leader (on a replica when the leader does not answer, with a note; in the postgres database when PostgreSQL refuses the database of the service, with a note), the pending restart of each member from Patroni, and SHOW CONFIG of PgBouncer on each PostgreSQL server. The HAProxy tunables come from the latest stored haproxy.cfg of each balancer, because HAProxy has no command that prints its configuration. The HBA rules of the user come from the store of the console. Each PostgreSQL row has its owner and, when a user cannot change it, the lock and its reason. A value with password= shows password=<redacted>. It is a fixed query, so a viewer can call it. It answers 502 when no PostgreSQL server gives pg_settings. A member or a PgBouncer that does not answer has an error in its entry.

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

OK

haproxyServiceSettingsHAProxyrequired
Show properties
appliesbooleanrequired

The topology has HAProxy balancers.

notestring
serversHaproxyServerSettings[]required

One entry per balancer. Empty when the topology has no balancers.

Show properties
Array of HaproxyServerSettings
errorstring

Why the server has no values.

server_idstringrequired
settingsHaproxySetting[]required
Show properties
Array of HaproxySetting
applystringrequired

A change needs a reload of HAProxy.

Allowed:reload
descriptionstringrequired
lock_reasonstring
lockedbooleanrequired

A user cannot change the value.

namestringrequired
valuestringrequired
taken_atstring<date-time>

The time of the stored haproxy.cfg that gave the values.

tunablesHaproxyTunable[]required

The tunables that an admin can change (ADR D16), with the override of each. Empty when the topology has no balancers.

Show properties
Array of HaproxyTunable
defaultstringrequired

The value with no override.

kindstringrequired

count: a whole number. time: an HAProxy time, a whole number with the unit us, ms, s, m, h or d (no unit: ms).

Allowed:counttime
maxstringrequired
max_ofstring

Another tunable whose value is also an upper bound.

minstringrequired
namestringrequired

The key of the tunable in the expert YAML and in the servers.

overrideSettingOverrideState

The row of the overrides store (ADR D7). Absent when the store has no row.

Show properties
appliedstring | nullrequired

The value of the last applied workflow. null: no workflow applied it.

pendingbooleanrequired

The row waits for its apply (Not applied).

valuestring | nullrequired

The value that the user wants. null: a reset that waits for its apply.

ownerstringrequired
Allowed:defaultoverride
hbaServiceSettingsHBArequired

The HBA rules of the user, from the store of the console (TSE-1149).

Show properties
appliedHbaRule[]required

The user rules of the last applied workflow: the servers use them.

Show properties
Array of HbaRule
addressstringrequired

An IPv4 or IPv6 CIDR with no host bits, for example 10.20.0.0/16. Empty for local.

max length 64
commentstring

A note of the user. The files do not get it.

max length 256
databasestringrequired

all, sameuser, replication, or a comma list of database names.

max length 1024
methodstringrequired

scram-sha-256, md5, cert (hostssl only) or reject.

max length 32
typestringrequired

host, hostssl, hostnossl or local.

max length 16
userstringrequired

all, or a comma list of user names.

max length 1024
defaultbooleanrequired

The service has the default rules: one rule for all IPv4 addresses.

lockedHbaLockedRule[]required

The locked rule of the console. The rules of the server socket, loopback, the members and replication come before it.

Show properties
Array of HbaLockedRule
addressstringrequired
databasestringrequired
methodstringrequired
reasonstringrequired
typestringrequired
userstringrequired
pendingbooleanrequired

The rules wait for their apply.

rulesHbaRule[]required

The user rules that the user wants, in their order.

Show properties
Array of HbaRule
addressstringrequired

An IPv4 or IPv6 CIDR with no host bits, for example 10.20.0.0/16. Empty for local.

max length 64
commentstring

A note of the user. The files do not get it.

max length 256
databasestringrequired

all, sameuser, replication, or a comma list of database names.

max length 1024
methodstringrequired

scram-sha-256, md5, cert (hostssl only) or reject.

max length 32
typestringrequired

host, hostssl, hostnossl or local.

max length 16
userstringrequired

all, or a comma list of user names.

max length 1024
versionstringrequired

The version of the rules (a hash). A plan and an apply of hba send it back as hba_version (TSE-1203).

pgbouncerServiceSettingsPgBouncerrequired
Show properties
serversPgbouncerServerSettings[]required
Show properties
Array of PgbouncerServerSettings
errorstring
server_idstringrequired
settingsPgbouncerSetting[]required
Show properties
Array of PgbouncerSetting
applystringrequired

restart when changeable is no.

Allowed:reloadrestart
changeablebooleanrequired
defaultstringrequired
keystringrequired
valuestringrequired
settingsServiceSetting[]required

The settings of PgBouncer on the server that gave the PostgreSQL rows (or on the first server that answers), with the owner, the lock and the rules of each one. An admin changes the settings that are not locked.

Show properties
Array of ServiceSetting
applystringrequired

What a change needs, from the context.

Allowed:reloadrestartnone
boot_valstring
contextstringrequired
enumvalsstring[]
errorstring

Why PostgreSQL refuses the value of the override, for example after an upgrade (ADR D18). The user resets or changes it.

lock_featurestring
lock_reasonstring
lockedbooleanrequired
max_valstring
min_valstring
namestringrequired
overrideSettingOverrideState

The row of the overrides store (ADR D7). Absent when the store has no row.

ownerstringrequired
Allowed:sizedconsoledefaultoverrideunmanagedalter_system
pending_restartbooleanrequired
pending_restart_serversstring[]required

The servers where the parameter waits for a restart (pending_restart_reason of Patroni).

reset_valstring
scopestring

pgbouncer for a setting of PgBouncer. Absent for a PostgreSQL parameter.

Allowed:pgbouncer
settingstringrequired
short_descstring
sourcestringrequired
sourcefilestring
unitstring
valuestringrequired

The live value in the unit that a user writes (current_setting).

vartypestringrequired

The vartype of pg_settings, or placeholder: a custom name of an override that no loaded library defines (pg_settings does not list it).

postgresqlServiceSettingsPostgreSQLrequired
Show properties
dcs_errorstring

The DCS of Patroni did not answer. A value that no owner wrote shows as a default.

membersServiceSettingsMember[]required

The pending restart of each PostgreSQL server.

Show properties
Array of ServiceSettingsMember
errorstring
namestring
pending_restartstringrequired

unknown: Patroni on the server did not answer.

Allowed:yesnounknown
rolestring
server_idstringrequired
notestring

Why the rows do not come from the leader, or not from the database of the service.

read_fromstringrequired

The Patroni role of that server.

Allowed:leaderreplicaunknown
server_idstring

The server that gave the rows of pg_settings.

settingsServiceSetting[]required
Show properties
Array of ServiceSetting
applystringrequired

What a change needs, from the context.

Allowed:reloadrestartnone
boot_valstring
contextstringrequired
enumvalsstring[]
errorstring

Why PostgreSQL refuses the value of the override, for example after an upgrade (ADR D18). The user resets or changes it.

lock_featurestring
lock_reasonstring
lockedbooleanrequired
max_valstring
min_valstring
namestringrequired
overrideSettingOverrideState

The row of the overrides store (ADR D7). Absent when the store has no row.

ownerstringrequired
Allowed:sizedconsoledefaultoverrideunmanagedalter_system
pending_restartbooleanrequired
pending_restart_serversstring[]required

The servers where the parameter waits for a restart (pending_restart_reason of Patroni).

reset_valstring
scopestring

pgbouncer for a setting of PgBouncer. Absent for a PostgreSQL parameter.

Allowed:pgbouncer
settingstringrequired
short_descstring
sourcestringrequired
sourcefilestring
unitstring
valuestringrequired

The live value in the unit that a user writes (current_setting).

vartypestringrequired

The vartype of pg_settings, or placeholder: a custom name of an override that no loaded library defines (pg_settings does not list it).

read_atstring<date-time>required

The time of the read.

settings_versioninteger<int64>required

The version of the overrides. A plan, an apply and a discard send it back.

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/settings' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "haproxy": {
    "applies": true,
    "note": "string",
    "servers": [
      {
        "error": "string",
        "server_id": "string",
        "settings": [
          {
            "apply": "reload",
            "description": "string",
            "lock_reason": "string",
            "locked": true,
            "name": "string",
            "value": "string"
          }
        ],
        "taken_at": "2019-08-24T14:15:22Z"
      }
    ],
    "tunables": [
      {
        "default": "string",
        "kind": "count",
        "max": "string",
        "max_of": "string",
        "min": "string",
        "name": "string",
        "override": {
          "applied": "string",
          "pending": true,
          "value": "string"
        },
        "owner": "default"
      }
    ]
  },
  "hba": {
    "applied": [
      {
        "address": "string",
        "comment": "string",
        "database": "string",
        "method": "string",
        "type": "string",
        "user": "string"
      }
    ],
    "default": true,
    "locked": [
      {
        "address": "string",
        "database": "string",
        "method": "string",
        "reason": "string",
        "type": "string",
        "user": "string"
      }
    ],
    "pending": true,
    "rules": [
      {
        "address": "string",
        "comment": "string",
        "database": "string",
        "method": "string",
        "type": "string",
        "user": "string"
      }
    ],
    "version": "string"
  },
  "pgbouncer": {
    "servers": [
      {
        "error": "string",
        "server_id": "string",
        "settings": [
          {
            "apply": "reload",
            "changeable": true,
            "default": "string",
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "settings": [
      {
        "apply": "reload",
        "boot_val": "string",
        "context": "string",
        "enumvals": [
          "string"
        ],
        "error": "string",
        "lock_feature": "string",
        "lock_reason": "string",
        "locked": true,
        "max_val": "string",
        "min_val": "string",
        "name": "string",
        "override": {
          "applied": "string",
          "pending": true,
          "value": "string"
        },
        "owner": "sized",
        "pending_restart": true,
        "pending_restart_servers": [
          "string"
        ],
        "reset_val": "string",
        "scope": "pgbouncer",
        "setting": "string",
        "short_desc": "string",
        "source": "string",
        "sourcefile": "string",
        "unit": "string",
        "value": "string",
        "vartype": "string"
      }
    ]
  },
  "postgresql": {
    "dcs_error": "string",
    "members": [
      {
        "error": "string",
        "name": "string",
        "pending_restart": "yes",
        "role": "string",
        "server_id": "string"
      }
    ],
    "note": "string",
    "read_from": "leader",
    "server_id": "string",
    "settings": [
      {
        "apply": "reload",
        "boot_val": "string",
        "context": "string",
        "enumvals": [
          "string"
        ],
        "error": "string",
        "lock_feature": "string",
        "lock_reason": "string",
        "locked": true,
        "max_val": "string",
        "min_val": "string",
        "name": "string",
        "override": {
          "applied": "string",
          "pending": true,
          "value": "string"
        },
        "owner": "sized",
        "pending_restart": true,
        "pending_restart_servers": [
          "string"
        ],
        "reset_val": "string",
        "scope": "pgbouncer",
        "setting": "string",
        "short_desc": "string",
        "source": "string",
        "sourcefile": "string",
        "unit": "string",
        "value": "string",
        "vartype": "string"
      }
    ]
  },
  "read_at": "2019-08-24T14:15:22Z",
  "settings_version": 0
}