GET v1/healthreports?include={include}&status={status}&from={from}&to={to}&limit={limit}&offset={offset}

Request Information

URI Parameters

Name	Type	Additional information
include	string	None.
status	HealthCheckStatus	None.
from	date	None.
to	date	None.
limit	integer	Default value is 50
offset	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

HealthReportsResource

Name	Description	Type	Additional information
HealthReports		Collection of HealthReportWithChecksDto	None.
Total		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "healthReports": [
    {
      "healthChecks": [
        {
          "level": "basic",
          "status": "unknown",
          "type": "host-services-running",
          "message": "sample string 1",
          "resultData": "sample string 2",
          "executedAt": "2026-05-19T07:50:11.1033031-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:50:11.1033031-05:00",
          "serverId": 1,
          "serverName": "sample string 3"
        }
      ],
      "serverResults": [
        {
          "serverId": 1,
          "serverName": "sample string 2",
          "status": "unknown",
          "timedOut": true,
          "errorMessage": "sample string 4"
        },
        {
          "serverId": 1,
          "serverName": "sample string 2",
          "status": "unknown",
          "timedOut": true,
          "errorMessage": "sample string 4"
        }
      ],
      "id": 1,
      "level": "basic",
      "overallStatus": "unknown",
      "createdAt": "2026-05-19T07:50:11.1033031-05:00",
      "completedAt": "2026-05-19T07:50:11.1033031-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:50:11.1033031-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:50:11.1033031-05:00",
          "serverId": 1,
          "serverName": "sample string 3"
        }
      ],
      "serverResults": [
        {
          "serverId": 1,
          "serverName": "sample string 2",
          "status": "unknown",
          "timedOut": true,
          "errorMessage": "sample string 4"
        },
        {
          "serverId": 1,
          "serverName": "sample string 2",
          "status": "unknown",
          "timedOut": true,
          "errorMessage": "sample string 4"
        }
      ],
      "id": 1,
      "level": "basic",
      "overallStatus": "unknown",
      "createdAt": "2026-05-19T07:50:11.1033031-05:00",
      "completedAt": "2026-05-19T07:50:11.1033031-05:00",
      "state": "pending",
      "expectedServerCount": 1,
      "completedServerCount": 1
    }
  ],
  "total": 1
}

application/xml, text/xml

Sample:

<Resources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.DTOs">
  <HealthReports>
    <HealthReportWithChecks>
      <CompletedAt>2026-05-19T07:50:11.1033031-05:00</CompletedAt>
      <CompletedServerCount>1</CompletedServerCount>
      <CreatedAt>2026-05-19T07:50:11.1033031-05:00</CreatedAt>
      <ExpectedServerCount>1</ExpectedServerCount>
      <Id>1</Id>
      <Level>Basic</Level>
      <OverallStatus>Unknown</OverallStatus>
      <State>Pending</State>
      <HealthChecks>
        <HealthCheck>
          <ExecutedAt>2026-05-19T07:50:11.1033031-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:50:11.1033031-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>
      <ServerResults>
        <ServerHealthResult>
          <ErrorMessage>sample string 4</ErrorMessage>
          <ServerId>1</ServerId>
          <ServerName>sample string 2</ServerName>
          <Status>Unknown</Status>
          <TimedOut>true</TimedOut>
        </ServerHealthResult>
        <ServerHealthResult>
          <ErrorMessage>sample string 4</ErrorMessage>
          <ServerId>1</ServerId>
          <ServerName>sample string 2</ServerName>
          <Status>Unknown</Status>
          <TimedOut>true</TimedOut>
        </ServerHealthResult>
      </ServerResults>
    </HealthReportWithChecks>
    <HealthReportWithChecks>
      <CompletedAt>2026-05-19T07:50:11.1033031-05:00</CompletedAt>
      <CompletedServerCount>1</CompletedServerCount>
      <CreatedAt>2026-05-19T07:50:11.1033031-05:00</CreatedAt>
      <ExpectedServerCount>1</ExpectedServerCount>
      <Id>1</Id>
      <Level>Basic</Level>
      <OverallStatus>Unknown</OverallStatus>
      <State>Pending</State>
      <HealthChecks>
        <HealthCheck>
          <ExecutedAt>2026-05-19T07:50:11.1033031-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:50:11.1033031-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>
      <ServerResults>
        <ServerHealthResult>
          <ErrorMessage>sample string 4</ErrorMessage>
          <ServerId>1</ServerId>
          <ServerName>sample string 2</ServerName>
          <Status>Unknown</Status>
          <TimedOut>true</TimedOut>
        </ServerHealthResult>
        <ServerHealthResult>
          <ErrorMessage>sample string 4</ErrorMessage>
          <ServerId>1</ServerId>
          <ServerName>sample string 2</ServerName>
          <Status>Unknown</Status>
          <TimedOut>true</TimedOut>
        </ServerHealthResult>
      </ServerResults>
    </HealthReportWithChecks>
  </HealthReports>
  <Total>1</Total>
</Resources>