| GET | /status |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | HealthCheckReport | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | HealthStatus | No | |
| Duration | form | TimeSpan | No | |
| Version | form | string | Yes | |
| BuildDate | form | string | No | |
| Entries | form | ICollection<HealthCheckReportEntry> | No |
| Unhealthy | |
| Degraded | |
| Healthy |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Description | form | string | No | |
| Duration | form | TimeSpan | No | |
| Status | form | HealthStatus | No | |
| Error | form | string | No |
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-agency-orch-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
}
}