| GET | /healthcheck | The request for getting health check information. | Depending on the execution mode, you can determine different states of the server. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExecutionMode | query | ExecutionMode | Yes | The mode used to determine what level of health check to perform.Allowable Values
|
| ServerType | query | ServerType | Yes | The type of server that will be used to determine which monitors will be run.Allowable Values
|
| IncludeServerStateInformation | query | boolean | No | Indicates whether or not to include server state information in the response. |
| SuppressErrorCodes | query | boolean | No | Indicates whether or not to suppress returning error codes. This will always return a 200 code to the caller, which is required for PRTG to process the JSON response properly. |
| SuppressDeploymentErrors | query | boolean | No | Indicates whether or not to suppress deployment-related errors. |
| Name | Value | |
|---|---|---|
| Basic | 1 | |
| Standard | 2 | |
| Advanced | 3 |
| Name | Value | |
|---|---|---|
| App | 1 | |
| Sql | 2 | |
| FtpApi | 3 | |
| Ftp | 4 | |
| Batch | 5 | |
| Identity | 6 | |
| Qc | 7 | |
| XcodeV | 8 | |
| XcodeC | 9 | |
| MsgVast | 10 | |
| AsgVast | 11 | |
| Mongo | 12 | |
| Agents | 13 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServerState | form | ServerState | No | |
| Status | form | MonitoringStatus | No | |
| StatusMessage | form | string | No | |
| CorrelationId | form | string | No | |
| FailedMonitorCount | form | int | No | |
| MonitorSummaries | form | List<MonitorSummary> | No | |
| ExecutionMetrics | form | MonitorExecutionMetrics | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServerName | form | string | No | |
| TotalRamInMb | form | decimal? | No | |
| AvailableRamInMb | form | decimal? | No | |
| UsedCpuPercent | form | decimal? | No |
| Name | Value | |
|---|---|---|
| Success | 1 | |
| Failure | 2 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MonitorName | form | string | No | |
| Status | form | MonitoringStatus | No | |
| Results | form | List<MonitoringResult> | No | |
| ErrorMessages | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MonitoringName | form | string | No | |
| Status | form | MonitoringStatus | No | |
| StatusMessage | form | string | No | |
| ErrorMessages | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartDateTime | form | DateTime | No | |
| EndDateTime | form | DateTime | No | |
| Duration | form | TimeSpan | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /healthcheck HTTP/1.1 Host: appcenter.tclclouds.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ServerState":{"ServerName":"String","TotalRamInMb":0,"AvailableRamInMb":0,"UsedCpuPercent":0},"Status":"Success","StatusMessage":"String","CorrelationId":"String","FailedMonitorCount":0,"MonitorSummaries":[{"MonitorName":"String","Status":"Success","Results":[{"MonitoringName":"String","Status":"Success","StatusMessage":"String","ErrorMessages":["String"]}],"ErrorMessages":["String"]}],"ExecutionMetrics":{"StartDateTime":"\/Date(-62135596800000-0000)\/","EndDateTime":"\/Date(-62135596800000-0000)\/","Duration":"PT0S"}}