tvpl.api

<back to all web services

HealthCheckRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/system/health-check

export class ServiceHealthResult
{
    public name: string;
    public status: string;
    public responseTimeMs: number;
    public message: string;

    public constructor(init?: Partial<ServiceHealthResult>) { (Object as any).assign(this, init); }
}

export class HealthCheckResponse
{
    public services: ServiceHealthResult[];
    public checkedAt: string;

    public constructor(init?: Partial<HealthCheckResponse>) { (Object as any).assign(this, init); }
}

export class HealthCheckRequest
{

    public constructor(init?: Partial<HealthCheckRequest>) { (Object as any).assign(this, init); }
}

TypeScript HealthCheckRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /system/health-check HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"services":[{"name":"String","status":"String","responseTimeMs":0,"message":"String"}],"checkedAt":"0001-01-01T00:00:00.0000000+07:06"}