Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Federation
PUTPlatformSince 1.0SynchronousAuth Required

ConfigureStaleAlert

Configure the global stale data alert thresholds and notification channels.

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • configObjectRequired

    Stale alert configuration to apply

    • staleThresholdSecsInteger

      Threshold in seconds after which cluster data is considered stale

      Example: 300

    • affectedClustersPctThreshLong

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

      Example: 0.3

    • severityString

      Alert severity level (critical, warning, info)

      Example: warning

    • notificationChannelsList

      List of notification channel IDs to alert

      Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • configuredBoolean

    Whether the stale alert configuration was applied successfully

    Example: true

Endpoint

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

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

Operation ID

ConfigureStaleAlert

Permalink

Request Example

curl -X PUT '{host}/api/v1/federation/stale-alert/config' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"config":{"staleThresholdSecs":300,"affectedClustersPctThresh":0.3,"severity":"warning","notificationChannels":"item1,item2"}}'

Response Example

200
{
  "configured": true
}

Change History

This API has no change history records yet.

View all change history