CoreService

<back to all web services

GetHealth

Common - Requests

Checks the services health

The following routes are available for this service:
All Verbs/healthz
All Verbs/api/healthz
namespace YCO.Dune.Models.Dtos.Common.Requests

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ServiceHealthDto() = 
        [<ApiMember(DataType="string", IsRequired=true, ParameterType="body", Verb="GET")>]
        member val Status:String = null with get,set

        [<ApiMember(DataType="Dictionary<string, string>", IsRequired=true, ParameterType="body", Verb="GET")>]
        member val AdditionalData:IDictionary<String, String> = null with get,set

    ///<summary>
    ///Checks the services health
    ///</summary>
    [<Api(Description="Checks the services health")>]
    [<ApiResponse(Description="Service healthy", IsDefaultResponse=true, StatusCode=200)>]
    [<ApiResponse(Description="Service not healthy", StatusCode=503)>]
    [<AllowNullLiteral>]
    type GetHealth() = 
        interface IGet

F# GetHealth 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.

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}