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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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 static class GetHealth implements IGet
    {
        
    }

    public static class ServiceHealthDto
    {
        @ApiMember(DataType="string", IsRequired=true, ParameterType="body", Verb="GET")
        public String status = null;

        @ApiMember(DataType="Dictionary<string, string>", IsRequired=true, ParameterType="body", Verb="GET")
        public HashMap<String,String> additionalData = null;
        
        public String getStatus() { return status; }
        public ServiceHealthDto setStatus(String value) { this.status = value; return this; }
        public HashMap<String,String> getAdditionalData() { return additionalData; }
        public ServiceHealthDto setAdditionalData(HashMap<String,String> value) { this.additionalData = value; return this; }
    }

}

Java 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}