| All Verbs | /healthz | ||
|---|---|---|---|
| All Verbs | /api/healthz |
import Foundation
import ServiceStack
/**
* Checks the services health
*/
// @Api(Description="Checks the services health")
// @ApiResponse(Description="Service healthy", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="Service not healthy", StatusCode=503)
public class GetHealth : IGet, Codable
{
required public init(){}
}
public class ServiceHealthDto : Codable
{
// @ApiMember(DataType="string", IsRequired=true, ParameterType="body", Verb="GET")
public var status:String
// @ApiMember(DataType="Dictionary<string, string>", IsRequired=true, ParameterType="body", Verb="GET")
public var additionalData:[String:String]
required public init(){}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /healthz HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"status":"String","additionalData":null}