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

Check config file drift

Runs one SSH command on each PostgreSQL server of the service. A file that Ansible writes and that changed since its latest version has drifted: the console stores the new version with the source drift. Refused with 409 while a workflow of the service runs, or when one starts during the read.

POST/api/v1/database-services/{id}/config-files/check
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

checked_atstring<date-time>

The time of the latest drift check since the console started

driftedbooleanrequired

A file of a server has drifted

errorsConfigFileReadError[]required

The servers that the check could not read

Show properties
Array of ConfigFileReadError
messagestringrequired
server_idstringrequired
server_namestringrequired
serversConfigFileServer[]required
Show properties
Array of ConfigFileServer
filesConfigFileEntry[]required
Show properties
Array of ConfigFileEntry
drift_checkedbooleanrequired

Ansible writes the file, so a change outside the console is drift

driftedbooleanrequired

The latest version is a change outside the console. The next apply or deploy writes the file again

filestringrequired

patroni.yml, postgresql.conf, postgresql.auto.conf, pg_hba.conf, pgbouncer.ini (pgbouncer-N.ini for each further PgBouncer process) or haproxy.cfg

pathstringrequired

The path of the latest version on the server

versionsConfigFileVersion[]required

The newest first

Show properties
Array of ConfigFileVersion
idstringrequired
redactedbooleanrequired

false: the console could not redact this version, and keeps only its hash

sha256stringrequired

The hash of the file on the server, before the redaction. A password change gives a new hash with the same redacted text

sourcestringrequired

workflow: read after a workflow, or the first read. patroni: Patroni wrote postgresql.conf. drift: changed outside the console

Allowed:workflowpatronidrift
taken_atstring<date-time>required
workflow_idstring

The workflow after which the console read the version

server_idstringrequired
server_namestringrequired

Empty when the server is no longer in the console

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/config-files/check' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "checked_at": "2019-08-24T14:15:22Z",
  "drifted": true,
  "errors": [
    {
      "message": "string",
      "server_id": "string",
      "server_name": "string"
    }
  ],
  "servers": [
    {
      "files": [
        {
          "drift_checked": true,
          "drifted": true,
          "file": "string",
          "path": "string",
          "versions": [
            {
              "id": "string",
              "redacted": true,
              "sha256": "string",
              "source": "workflow",
              "taken_at": "2019-08-24T14:15:22Z",
              "workflow_id": "string"
            }
          ]
        }
      ],
      "server_id": "string",
      "server_name": "string"
    }
  ]
}