Skip to main content
ZStack
Platform Operations/Platforms

ConfigureHealthCheck

Configure the health check schedule and auto-fix behavior for a platform.

PATCH/api/v1/platforms/{uuid}/health-check

Operation ID

ConfigureHealthCheck

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    UUID of the platform to configure health checks for

Body Fields

  • config
    ObjectRequired

    Health check configuration to apply

    • enabled
      Boolean

      Whether periodic health checks are enabled

      Example: true

    • intervalMinutes
      Integer

      Interval in minutes between consecutive health checks

      Example: 5

    • autoFix
      Boolean

      Whether to automatically attempt fixes on health check failure

      Example: false

    • fixActions
      List

      List of auto-fix action names to execute on failure

      Example: item1,item2

    • alertThreshold
      Integer

      Number of consecutive failures before triggering an alert

      Example: 3

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • message
    String

    Confirmation message for the configuration update

    Example: Health check configuration updated