Source Health Check API Reference
Available on: Cloud Free, Cloud Standard, Cloud Professional, Cloud Enterprise
The Source Health API is an admin-only endpoint which reports the health of sources whose Health Check is configured. Documentation here.
All requests are
GET requests to the
GET /healthz/sources HTTP/1.1
The response is an object with the source name as key and health status as value.
HealthStatus is an object with the following members.
|status||The status of the Health Check|
|error||any ||An additional field whose value varies based on the |
|timestamp||A UTC time encoded value|
Find the possible values of
status field in the following along with corresponding
error field value.
|"OK"||Health Check succeeded with configured test; the source is healthy|
|"TIMEOUT"||Health Check timed out|
|"ERROR"||Exceptions occurred after running Health Check; refer |
|"FAILED"||Health Check failed due to bad configuration|
HealthCheckError is an object with the following members.
|message||A very short description of the error|
|extra||any ||An optional value that contains more details about the error|
HTTP/1.1 200 OK
"message": "connection error",
"extra": "connection to server at \"localhost\" (::1), port 6432 failed: Connection refused\n\tIs the server running on that host and accepting TCP/IP connections?\nconnection to server at \"localhost\" (127.0.0.1), port 6432 failed: Connection refused\n\tIs the server running on that host and accepting TCP/IP connections?\n"
healthz/sources API endpoint cannot be disabled.