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

Apply settings changes

Validates the change set again on a new read of pg_settings, stores the desired values with the check of settings_version, and starts the workflow apply_settings. It answers 409 when settings_version is old or when another workflow runs on the service or holds its backup server or DCS cluster, and 422 when a row has an error or no setting waits for its apply. Without changes and yaml, it applies again the overrides that wait for their apply. It answers 501 while the console cannot run the apply.

POST/api/v1/database-services/{id}/settings/apply
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
requiredapplication/json
changesSettingChangeInput[]

The changes. Omit changes and yaml to apply again the overrides that wait for their apply.

max items 500
Show properties
Array of SettingChangeInput
namestringrequired
min length 1 · max length 128
scopestringrequired

The scope of the setting: a PostgreSQL parameter, a setting of PgBouncer, or an HAProxy tunable of ADR D16.

Allowed:postgresqlpgbouncerhaproxy
valuestring | nullrequired

The new value, as a user writes it (for example 1min). null: a reset.

max length 4096
hbaHbaRule[]

All HBA rules of the user, in their order (ADR D17), in place of the hba section of yaml. Omit it to keep the rules.

max items 500
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
hba_versionstring

With hba: hba.version of the settings read that the user changed. Another version of the rules gives 409, and a change of other settings does not.

max length 64
restartstringrequired

now: a rolling restart applies the parameters that need a restart. later: they wait for the next restart.

Allowed:nowlater
settings_versioninteger<int64>required

The version that the user saw.

yamlstring

All overrides as one YAML document (ADR D14), in place of changes.

max length 262144
Responses
202

Accepted

settings_versioninteger<int64>required
workflow_idstringrequired

The workflow apply_settings. Empty when the change needs no workflow: it only set overrides that no workflow applied 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 POST 'https://console.example.com/api/v1/database-services/string/settings/apply' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "changes": [
    {
      "name": "string",
      "scope": "postgresql",
      "value": "string"
    }
  ],
  "hba": [
    {
      "address": "string",
      "comment": "string",
      "database": "string",
      "method": "string",
      "type": "string",
      "user": "string"
    }
  ],
  "hba_version": "string",
  "restart": "now",
  "settings_version": 0,
  "yaml": "string"
}'
Response
{
  "settings_version": 0,
  "workflow_id": "string"
}