Sign in
External Services

Postgres WAL & archive health snapshot

Returns the latest WAL/archive health snapshot recorded by the background health monitor for a Postgres external service. Powers the warning banner on the service detail page when the disk is filling up due to stale replication slots, archive backlog, or misconfigured archive_command.

Returns 404 when no snapshot exists yet (probe hasn't run, or the service isn't Postgres).

get/external-services/{id}/wal-health

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{id}/wal-health
  • Auth: none declared

Path parameters

idinteger required

External service ID

Response

Latest WAL health snapshot

archive_backloginteger required

Number of archive_status/*.ready files — un-shipped WAL segments.

archive_commandstring nullable

The literal archive_command setting. May be empty or /bin/true when archiving is effectively disabled despite archive_mode = on.

archive_mode'off' | 'on' | 'always' | 'unknown' required
archiver_failed_countinteger nullable
archiver_last_failed_atstring date-time nullable
max_wal_size_bytesinteger required

max_wal_size setting in bytes (parsed from pg_settings).

oldest_wal_age_secsinteger required

Age of the oldest WAL file in pg_wal/ (seconds).

pg_wal_bytesinteger required

Total size of files under pg_wal/, from pg_ls_waldir().

probed_atstring date-time required

When the snapshot was taken.

Changes

No recorded changes to this operation across all 50 revisions of this API.