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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ServiceHealthDto implements JsonSerializable
{
    public function __construct(
        // @ApiMember(DataType="string", IsRequired=true, ParameterType="body", Verb="GET")
        /** @var string */
        public string $status='',

        // @ApiMember(DataType="Dictionary<string, string>", IsRequired=true, ParameterType="body", Verb="GET")
        /** @var array<string,string>|null */
        public ?array $additionalData=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['status'])) $this->status = $o['status'];
        if (isset($o['additionalData'])) $this->additionalData = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['additionalData']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->status)) $o['status'] = $this->status;
        if (isset($this->additionalData)) $o['additionalData'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->additionalData);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description 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)
class GetHealth implements IGet, JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

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