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

Get overrides as YAML

Gives the desired overrides as one YAML document, with the keys in name order (ADR D14), and the settings version. The hba section has the HBA rules of the user when they are not the default rules. A reset that waits for its apply is not in it. The store keeps no comments.

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

OK

settings_versioninteger<int64>required
yamlstringrequired

The overrides as one YAML document, with the keys in name order (ADR D14), and the HBA rules of the user in the hba section when they are not the default rules. A reset that waits for its apply is not in it.

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/yaml' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "settings_version": 0,
  "yaml": "string"
}