HealthMonitors

The following resources are applicable:

/healthMonitors

Mount Point: /v2/healthMonitors

GET

Gets the health check reports ordered by CheckUpDate descending.

Parameters

name description type default
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
limit Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 31
offset Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 0

Response Body

element: healthCheckReportsResult
media types: application/xml
application/json

HealthCheckReportsResult

/healthMonitors/{healthCheckReportId}

Mount Point: /v2/healthMonitors/{healthCheckReportId}

GET

Finds Health Check Report by the given path parameter.

Parameters

name description type default
healthCheckReportId (no documentation provided) path

Response Body

element: healthCheckReport
media types: application/xml
application/json

HealthCheckReport

/healthMonitors/{healthCheckReportId}/healthCheckLogs

Mount Point: /v2/healthMonitors/{healthCheckReportId}/healthCheckLogs

GET

Gets all health check logs related to a health check report.

Parameters

name description type default
healthCheckReportId the health check report for which ask logs path
fetchLogs Sets whether or not retrieve also text log for a Health Check Report, default to false. query false
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0

Response Body

element: healthCheckLogsResult
media types: application/xml
application/json

HealthCheckLogsResult

/healthMonitors/{healthCheckReportId}/healthCheckLogs/{healthCheckLogId}

Mount Point: /v2/healthMonitors/{healthCheckReportId}/healthCheckLogs/{healthCheckLogId}

GET

Gets a specific HealthCheckLog by the given parameters

Parameters

name description type default
healthCheckReportId the HealthCheckReport ID. path
healthCheckLogId the HealthCheckLog ID. path

Response Body

element: healthCheckLog
media types: application/xml
application/json

HealthCheckLog

/healthMonitors/period

Mount Point: /v2/healthMonitors/period

GET

Gets an aggregate health check report for the given period.

Parameters

name description type default
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0

Response Body

element: HealthCheckPeriodReportResult
media types: application/xml
application/json

HealthCheckPeriodReport