Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
PATCHPlatformSince 1.0SynchronousAuth Required

ConfigureHealthCheck

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform to configure health checks for

Body Fields

  • configObjectRequired

    Health check configuration to apply

    • enabledBoolean

      Whether periodic health checks are enabled

      Example: true

    • intervalMinutesInteger

      Interval in minutes between consecutive health checks

      Example: 5

    • autoFixBoolean

      Whether to automatically attempt fixes on health check failure

      Example: false

    • fixActionsList

      List of auto-fix action names to execute on failure

      Example: item1,item2

    • alertThresholdInteger

      Number of consecutive failures before triggering an alert

      Example: 3

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Confirmation message for the configuration update

    Example: Health check configuration updated

Endpoint

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

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

Operation ID

ConfigureHealthCheck

Permalink

Request Example

curl -X PATCH '{host}/api/v1/platforms/{uuid}/health-check' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{
  "message": "Health check configuration updated"
}

Change History

This API has no change history records yet.

View all change history