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
ServiceHealthResult Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
StatusformstringYes
ResponseTimeMsformlongNo
MessageformstringYes

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

HTTP + JSV

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: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	services: 
	[
		{
			name: String,
			status: String,
			responseTimeMs: 0,
			message: String
		}
	]
}