tvpl.api

HealthCheckRequest

**Requires Authentication**
Required role:	super-admin

The following routes are available for this service:
GET	/system/health-check

**HealthCheckResponse** Parameters:
Name	Parameter	Data Type	Required
Services	form	List<ServiceHealthResult>	Yes
CheckedAt	form	DateTime	No
BackgroundServices	form	HealthCheckResponse	Yes

**ServiceHealthResult** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Status	form	string	Yes
ResponseTimeMs	form	long	No
Message	form	string	Yes
Host	form	string	Yes

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: qlcn-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,
			host: String
		}
	],
	backgroundServices: 
	{
		services: 
		[
			{
				name: String,
				status: String,
				responseTimeMs: 0,
				message: String,
				host: String
			}
		],
		backgroundServices: 
		{
			services: 
			[
				{
					name: String,
					status: String,
					responseTimeMs: 0,
					message: String,
					host: String
				}
			],
			backgroundServices: 
			{
				services: 
				[
					{
						name: String,
						status: String,
						responseTimeMs: 0,
						message: String,
						host: String
					}
				]
			}
		}
	}
}