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

Update an inbox rule

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

Descripción general

Update an inbox rule by ID.

This endpoint requires the security_pipelines_write permission.

Argumentos

Parámetros de ruta

Nombre
Type
Descripción
rule_id [required]
string

The ID of the inbox rule.

Solicitud

Body Data (required)

Campo
Type
Descripción
data [required]
object

The data object for an inbox rule update request. The id must match the rule_id path parameter.

Respuesta

Successfully updated the inbox rule

A single inbox rule response.

Campo
Type
Descripción
data [required]
object

The data object for an inbox rule returned by the API.

Ejemplo de código

Update an inbox rule returns "Successfully updated the inbox rule" response
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"

# 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 PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/inbox_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "enabled": false,
      "name": "Example-Security-Monitoring",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:staging"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}
EOF