GET | /status |
---|
export enum HealthStatus
{
Unhealthy = 'Unhealthy',
Degraded = 'Degraded',
Healthy = 'Healthy',
}
export class HealthCheckReportEntry
{
public Key?: string;
public Description?: string;
public Duration: string;
public Status: HealthStatus;
public Error?: string;
public constructor(init?: Partial<HealthCheckReportEntry>) { (Object as any).assign(this, init); }
}
export class HealthCheckReport
{
public Status: HealthStatus;
public Duration: string;
public Version: string;
public BuildDate?: string;
public Entries?: HealthCheckReportEntry[];
public constructor(init?: Partial<HealthCheckReport>) { (Object as any).assign(this, init); }
}
export class HealthResponse
{
public Result?: HealthCheckReport;
public constructor(init?: Partial<HealthResponse>) { (Object as any).assign(this, init); }
}
export class HealthRequest implements IGet
{
public constructor(init?: Partial<HealthRequest>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: prod-api-auth-mb-dhc.rapp-customers.co.uk Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Result: { Status: Unhealthy, Duration: PT0S, Version: String, BuildDate: String } }