Skip to main content
ZStack
Platform Operations/Platform Federation

ConfigureStaleAlert

Configure the global stale data alert thresholds and notification channels.

PUT/api/v1/federation/stale-alert/config

Operation ID

ConfigureStaleAlert

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

Body Fields

  • config
    ObjectRequired

    Stale alert configuration to apply

    • staleThresholdSecs
      Integer

      Threshold in seconds after which cluster data is considered stale

      Example: 300

    • affectedClustersPctThresh
      Long

      Percentage of affected clusters that triggers an alert (0.0 to 1.0)

      Example: 0.3

    • severity
      String

      Alert severity level (critical, warning, info)

      Example: warning

    • notificationChannels
      List

      List of notification channel IDs to alert

      Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • configured
    Boolean

    Whether the stale alert configuration was applied successfully

    Example: true