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

Enable a default inbox rule

WARNINGNote: This endpoint is in Preview and is subject to change. If you have any feedback, contact Datadog support.
POSThttps://api.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.us3.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.us5.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.datadoghq.eu/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.ap1.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.ap2.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.uk1.datadoghq.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.ddog-gov.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enablehttps://api.us2.ddog-gov.com/api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enable

Overview

Enable a default inbox rule for the current organization.

This endpoint requires the security_pipelines_write permission.

Arguments

Path Parameters

Name
Type
Description
rule_id [required]
string

The ID of the default inbox rule. Known default rule IDs include: identity_risk_default_rule, secret_default_rule, library_vulnerability_default_rule, attack_path_default_rule, host_and_container_vulnerability_default_rule, runtime_code_vulnerability_default_rule, iac_misconfiguration_default_rule, and misconfiguration_default_rule. Datadog can add new default rules over time.

Response

Successfully enabled the default inbox rule

A single default inbox rule response.

Field
Type
Description
data [required]
object

The data object for a default inbox rule returned by the API.

Code Example

Enable a default inbox rule
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export rule_id="secret_default_rule"

# 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/findings/automation/default_inbox_rules/${rule_id}/enable" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"