GET v1/healthchecks?level={level}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
level

HealthCheckLevel

Default value is Basic

Body Parameters

None.

Response Information

Resource Description

HealthReportResource
NameDescriptionTypeAdditional information
HealthReport

HealthReportDto

None.

HealthChecks

Collection of HealthCheckDto

None.

Response Formats

application/json, text/json

Sample:
{
  "healthReport": {
    "id": 1,
    "level": "basic",
    "overallStatus": "unknown",
    "createdAt": "2026-05-19T07:49:41.8748579-05:00",
    "completedAt": "2026-05-19T07:49:41.8748579-05:00",
    "state": "pending",
    "expectedServerCount": 1,
    "completedServerCount": 1
  },
  "healthChecks": [
    {
      "level": "basic",
      "status": "unknown",
      "type": "host-services-running",
      "message": "sample string 1",
      "resultData": "sample string 2",
      "executedAt": "2026-05-19T07:49:41.8748579-05:00",
      "serverId": 1,
      "serverName": "sample string 3"
    },
    {
      "level": "basic",
      "status": "unknown",
      "type": "host-services-running",
      "message": "sample string 1",
      "resultData": "sample string 2",
      "executedAt": "2026-05-19T07:49:41.8748579-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">
  <HealthChecks>
    <HealthCheck>
      <ExecutedAt>2026-05-19T07:49:41.8748579-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>
    <HealthCheck>
      <ExecutedAt>2026-05-19T07:49:41.8748579-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>
  </HealthChecks>
  <HealthReport>
    <CompletedAt>2026-05-19T07:49:41.8748579-05:00</CompletedAt>
    <CompletedServerCount>1</CompletedServerCount>
    <CreatedAt>2026-05-19T07:49:41.8748579-05:00</CreatedAt>
    <ExpectedServerCount>1</ExpectedServerCount>
    <Id>1</Id>
    <Level>Basic</Level>
    <OverallStatus>Unknown</OverallStatus>
    <State>Pending</State>
  </HealthReport>
</Resource>