GET v1/healthchecks/{type}

Request Information

URI Parameters

Name	Description	Type	Additional information
type		HealthCheckType	Required

Body Parameters

None.

Response Information

Resource Description

HealthCheckResource

Name	Description	Type	Additional information
HealthCheck		HealthCheckDto	None.

Response Formats

application/json, text/json

Sample:

{
  "healthCheck": {
    "level": "basic",
    "status": "unknown",
    "type": "host-services-running",
    "message": "sample string 1",
    "resultData": "sample string 2",
    "executedAt": "2026-05-19T02:26:40.6481485-05:00",
    "serverId": 1,
    "serverName": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<Resource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.DTOs">
  <HealthCheck>
    <ExecutedAt>2026-05-19T02:26:40.6481485-05:00</ExecutedAt>
    <Level>Basic</Level>
    <Message>sample string 1</Message>
    <ResultData>sample string 2</ResultData>
    <ServerId>1</ServerId>
    <ServerName>sample string 3</ServerName>
    <Status>Unknown</Status>
    <Type>HostServicesRunning</Type>
  </HealthCheck>
</Resource>