API Data Provider - Online Help

Healthchecks

List configured health checks.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Health check identifier

Name String False

Health check name

Description String False

Health check description

Address String False

Target address (IP or hostname)

IsSuspended Boolean False

Whether the health check is currently suspended (true if temporarily disabled)

CheckRegions String False

Array of check regions (WNAM|ENAM|WEU|EEU|NSAM|SSAM|OC|ME|NAF|SAF|IN|SEAS|NEAS|ALL_REGIONS)

Type String False

Health check type

Interval Integer False

Check interval in seconds

Retries Integer False

Number of retries

Timeout Integer False

Timeout in seconds

ConsecutiveSuccesses Integer False

Consecutive successes for healthy

ConsecutiveFails Integer False

Consecutive failures for unhealthy

HttpConfig String False

HTTP configuration object

TcpConfig String False

TCP configuration object

Status String True

Health check operational status

CreatedOn Datetime True

Health check creation timestamp

ModifiedOn Datetime True

Last modification timestamp

FailureReason String True

Reason for health check failure

ZoneId String False

Zones.Id

Required zone id identifier

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0