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
"use strict";
export class ServiceHealthDto {
    /** @param {{status?:string,additionalData?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    status;
    /** @type {{ [index:string]: string; }} */
    additionalData;
}
export class GetHealth {
    constructor(init) { Object.assign(this, init) }
}

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