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, when another workflow runs on the service or holds its backup server or DCS cluster, and when the apply restarts PostgreSQL while a LiveSync session of the service is active; 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.
/api/v1/database-services/{id}/settings/applytse_sessionAPI key · cookierequiredidstringrequiredapplication/jsonchangesSettingChangeInput[]The changes. Omit changes and yaml to apply again the overrides that wait for their apply.
Show propertiesHide properties
SettingChangeInputnamestringrequiredscopestringrequiredThe scope of the setting: a PostgreSQL parameter, a setting of PgBouncer, or an HAProxy tunable of ADR D16.
postgresqlpgbouncerhaproxyvaluestring | nullrequiredThe new value, as a user writes it (for example 1min). null: a reset.
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.
Show propertiesHide properties
HbaRuleaddressstringrequiredAn IPv4 or IPv6 CIDR with no host bits, for example 10.20.0.0/16. Empty for local.
commentstringA note of the user. The files do not get it.
databasestringrequiredall, sameuser, replication, or a comma list of database names.
methodstringrequiredscram-sha-256, md5, cert (hostssl only) or reject.
typestringrequiredhost, hostssl, hostnossl or local.
userstringrequiredall, or a comma list of user names.
hba_versionstringWith 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.
restartstringrequirednow: a rolling restart applies the parameters that need a restart. later: they wait for the next restart.
nowlatersettings_versioninteger<int64>requiredThe version that the user saw.
yamlstringAll overrides as one YAML document (ADR D14), in place of changes.
Accepted
settings_versioninteger<int64>requiredworkflow_idstringrequiredThe workflow apply_settings. Empty when the change needs no workflow: it only set overrides that no workflow applied back.
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message