Settings API - Security notifications schema table
Security notifications (builtin:appsec.notification-integration)
Integrate security notifications with your existing incident-management system or team-collaboration channel. Within security integrations, use vulnerability and attack alerting profiles to filter the total number of alerts down to those relevant for your team.
To learn more, visit Security notifications.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:appsec.notification-integration |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:appsec.notification-integration |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:appsec.notification-integration | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:appsec.notification-integration |
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 |
---|---|---|---|
Enabledenabled | boolean | - | required |
Security alert typetrigger | enum |
| required |
Notification typetype | enum |
| required |
Display namedisplayName | text | - | required |
webhookConfiguration | WebhookConfiguration | - | required |
securityProblemBasedWebhookPayload | SecurityProblemBasedWebhookPayload | - | required |
attackCandidateBasedWebhookPayload | AttackCandidateBasedWebhookPayload | - | required |
jiraConfiguration | JiraConfiguration | - | required |
securityProblemBasedJiraPayload | SecurityProblemBasedJiraPayload | - | required |
attackCandidateBasedJiraPayload | AttackCandidateBasedJiraPayload | - | required |
emailConfiguration | EmailConfiguration | - | required |
securityProblemBasedEmailPayload | SecurityProblemBasedEmailPayload | - | required |
attackCandidateBasedEmailPayload | AttackCandidateBasedEmailPayload | - | required |
Alerting profilesecurityProblemBasedAlertingProfile | setting | Select an alerting profile ( | required |
Alerting profileattackCandidateBasedAlertingProfile | setting | Select an alerting profile ( | required |
The WebhookConfiguration
object
Property | Type | Description | Required |
---|---|---|---|
Webhook endpoint URLurl | text | - | required |
Accept any SSL certificate (including self-signed and invalid certificates)acceptAnyCertificate | boolean | - | required |
Additional HTTP headersheaders | Set<WebhookConfigurationHeader> | Use additional HTTP headers to attach any additional information, for example, configuration, authorization, or metadata. Note that JSON-based webhook endpoints require the addition of the Content-Type: application/json header to enable escaping of special characters and to avoid malformed JSON content. | required |
The SecurityProblemBasedWebhookPayload
object
Property | Type | Description | Required |
---|---|---|---|
Custom payloadpayload | text | This is the content your notification message will include when users view it. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the custom payload might leak information to untrusted parties. Available placeholders: | required |
The AttackCandidateBasedWebhookPayload
object
Property | Type | Description | Required |
---|---|---|---|
Custom payloadpayload | text | This is the content your notification message will include when users view it. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the custom payload might leak information to untrusted parties. Available placeholders: | required |
The JiraConfiguration
object
Property | Type | Description | Required |
---|---|---|---|
Jira endpoint URLurl | text | The URL of the Jira API endpoint. | required |
Usernameusername | text | The username of the Jira profile. | required |
API tokenapiToken | secret | The API token for the Jira profile. Using password authentication was deprecated by Jira | required |
Project keyprojectKey | text | The project key of the Jira issue to be created by this notification. | required |
Issue typeissueType | text | The type of the Jira issue to be created by this notification. To find all available issue types or create your own, in Jira, go to Project settings > Issue types. | required |
The SecurityProblemBasedJiraPayload
object
Property | Type | Description | Required |
---|---|---|---|
Summarysummary | text | The summary of the Jira issue to be created by this notification. Note: The Jira summary field must contain less than 255 characters. Any content exceeding this limit after evaluating the placeholders will be discarded. Available placeholders: | required |
Issue descriptiondescription | text | The description of the Jira issue to be created by this notification. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the description might leak information to untrusted parties. Available placeholders: | required |
The AttackCandidateBasedJiraPayload
object
Property | Type | Description | Required |
---|---|---|---|
Summarysummary | text | The summary of the Jira issue to be created by this notification. Note: The Jira summary field must contain less than 255 characters. Any content exceeding this limit after evaluating the placeholders will be discarded. Available placeholders: | required |
Issue descriptiondescription | text | The description of the Jira issue to be created by this notification. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the description might leak information to untrusted parties. Available placeholders: | required |
The EmailConfiguration
object
Property | Type | Description | Required |
---|---|---|---|
Torecipients | set | - | required |
CCccRecipients | set | - | required |
BCCbccRecipients | set | - | required |
The SecurityProblemBasedEmailPayload
object
Property | Type | Description | Required |
---|---|---|---|
Subjectsubject | text | The subject of the email notifications. Available placeholders: | required |
Bodybody | text | The template of the email notifications. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the description might leak information to untrusted parties. Available placeholders: | required |
The AttackCandidateBasedEmailPayload
object
Property | Type | Description | Required |
---|---|---|---|
Subjectsubject | text | The subject of the email notifications. Available placeholders: | required |
Bodybody | text | The template of the email notifications. Note: Security notifications contain sensitive information. Excessive usage of placeholders in the body might leak information to untrusted parties. Available placeholders: | required |
The WebhookConfigurationHeader
object
Property | Type | Description | Required |
---|---|---|---|
Namename | text | - | required |
Secret HTTP header valuesecret | boolean | - | required |
Valuevalue | text | The value of the HTTP header. May contain an empty value. | required |
ValuesecretValue | secret | The secret value of the HTTP header. May contain an empty value. | required |