Settings API - Vulnerability alerting profiles schema table

Vulnerability alerting profiles (builtin:appsec.notification-alerting-profile)

Vulnerability alerting profiles enable you to set up alert-filtering rules that are based on the risk level of detected vulnerabilities. This allows you to control which conditions result in security notifications and which don't.

Schema ID
Schema groups
Scope
builtin:appsec.notification-alerting-profile
  • group:alerting.appsec
  • group:alerting
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:appsec.notification-alerting-profile
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:appsec.notification-alerting-profile
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:appsec.notification-alerting-profile

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property
Type
Description
Required
Enabled
enabled
boolean
-
required
Name
name
text
-
required
Alert for the following events:
enabledTriggerEvents
  • SECURITY_PROBLEM_OPENED
  • NEW_MANAGEMENT_ZONE_AFFECTED
required
Alert only if the following management zone is affected (optional)
managementZone
setting
-
optional
Risk Levels
enabledRiskLevels
  • CRITICAL
  • HIGH
  • MEDIUM
  • LOW
required