Fleet Intelligence — ReferenceAPI Explorernotification_preferences

Update a notification preference

View as Markdown

Update the preference addressed by id. Uses the same body shape as create; components, notifiedOn, scope, and targets replace the stored configuration, while omitted active preserves the existing pause/resume toggle.

Path parameters

idstringRequired

Preference id (UUID)

Request

Notification preference configuration
componentslist of stringsRequired

Components this preference applies to (e.g. GPU, CPU, NVLink, agent_liveness). At least one; all settings below apply equally to every listed component.

notificationTargetslist of objectsRequired

At least one notification target is required. Config structure depends on channel — see EmailNotificationConfig, SlackNotificationConfig, WebhookNotificationConfig.

activebooleanOptional

Active flag: when false, this preference is temporarily paused (other preferences covering the same component still fire). If omitted on create, defaults to true. If omitted on update, the existing value is preserved.

notifiedOnlist of stringsOptional

Alert statuses to notify on. Valid values: Critical, Warning, Resolved. If empty or omitted, defaults to all three: [Critical, Warning, Resolved].

scopeobjectOptional
Optional scope to narrow which nodes trigger notifications. If omitted or null, all nodes for this component trigger notifications.

Response

No Content - Preference updated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error