POST
/v1/notification/ruleUpdate a notification rule
Updates an existing notification rule using its UUID. Supply uuid, name, level, and scope, and include optional notification, filtering, publisher, or scheduling settings as needed. You need SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Notification rule properties to update. level, name, scope, and uuid are required.
enabledbooleanoptional
Whether the notification rule is enabled.
filterExpressionstringoptional
A filter expression used to select notifications. Must be between 0 and 2048 characters.
levelstringrequired
Notification severity: `INFORMATIONAL`, `WARNING`, or `ERROR`.
logSuccessfulPublishbooleanoptional
Whether to log successful notification publishing.
namestringrequired
The notification rule name. Must contain at least one character.
notifyChildrenbooleanoptional
Whether notifications also apply to child projects.
notifyOnarray<string>optional
Unique event types that trigger notifications. Documented values include `CONFIGURATION`, `DATASOURCE_MIRRORING`, `REPOSITORY`, `INTEGRATION`, `FILE_SYSTEM`, `ANALYZER`, `NEW_VULNERABILITY`, `NEW_VULNERABLE_DEPENDENCY`, `VULNERABILITY_RETRACTED`, `PROJECT_AUDIT_CHANGE`, `BOM_CONSUMED`, and `BOM_PROCESSED`; the schema indicates additional accepted values.
publisherConfigstringoptional
Configuration for the notification publisher.
scheduleCronstringoptional
The cron expression used to schedule notifications.
scheduleSkipUnchangedbooleanoptional
Whether to skip scheduled notifications when there have been no changes since the previous emission.
scopestringrequired
The rule scope: `SYSTEM` or `PORTFOLIO`.
tagsarray<object>optional
Unique tags for the rule. Each tag must have a `name` of 1 to 255 characters containing whitespace, letters, marks, symbols, numbers, or punctuation.
uuidstringrequired
The rule's UUID in UUID format.
200Returns the updated notification rule, including its name, scope, trigger type, notification settings, publisher configuration, and scheduling details.
enabledbooleanoptional
filterExpressionstringoptional
logSuccessfulPublishbooleanoptional
messagestringoptional
namestringrequired
notificationLevelstringoptional
notifyChildrenbooleanoptional
notifyOnarray<string>optional
projectsarray<object>optional
publisherobjectoptional
publisherConfigstringoptional
scheduleCronstringoptional
Schedule of this rule as cron expression. Must not be set for rules with trigger type EVENT.
scheduleLastTriggeredAtintegeroptional
When the schedule last triggered, as UNIX epoch timestamp in milliseconds
scheduleNextTriggerAtintegeroptional
When the schedule triggers next, as UNIX epoch timestamp in milliseconds
scheduleSkipUnchangedbooleanoptional
Whether to skip emitting a scheduled notification if it doesn't contain any changes since its last emission. Must not be set for rules with trigger type EVENT.
scopestringrequired
tagsarray<object>optional
teamsarray<object>optional
triggerTypestringrequired
uuidstringrequired
400Returned when the filter expression is invalid.
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type
errorsarray<object>optional
Errors identified during CEL expression compilation
401Returned when the request is unauthorized.
404Returned when the UUID of the notification rule cannot be found.
Error handling
A 400 is returned when filterExpression is invalid; a 401 is returned when you lack SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission; and a 404 is returned when the rule identified by uuid cannot be found. level must be INFORMATIONAL, WARNING, or ERROR, scope must be SYSTEM or PORTFOLIO, and name must contain at least one character.