For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ko/api/latest/security-monitoring/test-a-notification-rule.md. A documentation index is available at /llms.txt.
Language
Datadog site

알림 규칙 테스트

POSThttps://api.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.us3.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.datadoghq.eu/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.ap1.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.ap2.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.uk1.datadoghq.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.ddog-gov.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_previewhttps://api.us2.ddog-gov.com/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview

개요

알림 규칙의 대상이 올바르게 구성되었는지 테스트하기 위해 알림 미리보기를 보냅니다.

This endpoint requires the security_monitoring_notification_profiles_write permission.

OAuth apps require the security_monitoring_notification_profiles_write authorization scope to access this endpoint.

요청

Body Data (required)

항목
유형
설명
data
object

알림 규칙 생성 요청의 본문입니다.

응답

OK

Response from the notification preview request.

항목
유형
설명
data [required]
object

The notification preview response data.

코드 예시

Test a notification rule returns "OK" response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": true,
      "name": "Rule 1",
      "selectors": {
        "query": "env:prod",
        "rule_types": [
          "log_detection"
        ],
        "severities": [
          "critical"
        ],
        "trigger_source": "security_signals"
      },
      "targets": [
        "@john.doe@email.com"
      ]
    },
    "type": "notification_rules"
  }
}
EOF