Auth.Api

<back to all web services

HealthCheckDTOGet

The following routes are available for this service:
GET/healthchecks/hcReaquest API's helth check.
HealthCheckDTOGet Parameters:
NameParameterData TypeRequiredDescription
DBTimeoutqueryint?No
CacheTimeoutqueryint?No
HealthCheckDTOResponse Parameters:
NameParameterData TypeRequiredDescription
HealthChecksformList<HealthCheckResult>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
CodeformintNo
apiVersionformstringNo
appVersionformstringNo
ApiResponseStatus Enum:
OK
FAIL
Default
HealthCheckResult Parameters:
NameParameterData TypeRequiredDescription
CheckStatusformCheckStatusNo
CheckStatusCodeformstringNo
DescriptionformstringNo
ElapsedMsformlongNo
CheckStatus Enum:
Unknown
Unhealthy
Healthy
Warning

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 /healthchecks/hc HTTP/1.1 
Host: auth.mepis.si 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	healthChecks: 
	[
		{
			checkStatus: Unknown,
			checkStatusCode: Unknown,
			description: String,
			elapsedMs: 0
		}
	],
	status: OK,
	code: 0,
	apiVersion: String,
	appVersion: String
}