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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class HealthCheckRequest
{
}

open class HealthCheckResponse
{
    var services:ArrayList<ServiceHealthResult> = ArrayList<ServiceHealthResult>()
    var checkedAt:Date? = null
}

open class ServiceHealthResult
{
    var name:String? = null
    var status:String? = null
    var responseTimeMs:Long? = null
    var message:String? = null
}

Kotlin HealthCheckRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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