tvpl.api

<back to all web services

HealthCheckRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/system/health-check
HealthCheckResponse Parameters:
NameParameterData TypeRequiredDescription
ServicesformList<ServiceHealthResult>Yes
CheckedAtformDateTimeNo
BackgroundServicesformHealthCheckResponseYes
ServiceHealthResult Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
StatusformstringYes
ResponseTimeMsformlongNo
MessageformstringYes
HostformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /system/health-check HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"services":[{"name":"String","status":"String","responseTimeMs":0,"message":"String","host":"String"}],"checkedAt":"0001-01-01T00:00:00.0000000+07:06","backgroundServices":{"services":[{"name":"String","status":"String","responseTimeMs":0,"message":"String","host":"String"}],"checkedAt":"0001-01-01T00:00:00.0000000+07:06","backgroundServices":{"services":[{"name":"String","status":"String","responseTimeMs":0,"message":"String","host":"String"}],"checkedAt":"0001-01-01T00:00:00.0000000+07:06","backgroundServices":{"services":[{"name":"String","status":"String","responseTimeMs":0,"message":"String","host":"String"}],"checkedAt":"0001-01-01T00:00:00.0000000+07:06","backgroundServices":null}}}}