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

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
        : IGet
    {
    }

}

namespace YCO.Dune.Models.Dtos.Common.Responses
{
    public partial class ServiceHealthDto
    {
        [ApiMember(DataType="string", IsRequired=true, ParameterType="body", Verb="GET")]
        public virtual string Status { get; set; }

        [ApiMember(DataType="Dictionary<string, string>", IsRequired=true, ParameterType="body", Verb="GET")]
        public virtual IDictionary<string, string> AdditionalData { get; set; }
    }

}

C# 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}