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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports YCO.Dune.Models.Dtos.Common.Requests
Imports YCO.Dune.Models.Dtos.Common.Responses

Namespace Global

    Namespace YCO.Dune.Models.Dtos.Common.Requests

        '''<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)>
        Public Partial Class GetHealth
            Implements IGet
        End Class
    End Namespace

    Namespace YCO.Dune.Models.Dtos.Common.Responses

        Public Partial Class ServiceHealthDto
            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="body", Verb:="GET")>
            Public Overridable Property Status As String

            <ApiMember(DataType:="Dictionary<string, string>", IsRequired:=true, ParameterType:="body", Verb:="GET")>
            Public Overridable Property AdditionalData As IDictionary(Of String, String)
        End Class
    End Namespace
End Namespace

VB.NET 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}