Security Monitoring

Get an inbox rule

Get the details of an inbox rule by ID.

get/api/v2/security/findings/automation/inbox_rules/{rule_id}

Request

Base URL
https://api.datadoghq.com
Auth
- API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
- or OAuth 2
  Authorization code/oauth2/v1/authorize
  Token URL/oauth2/v1/token
TypeScript
https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/security/findings/automation/inbox_rules/:rule_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

rule_idstring uuid required

Example:00000000-0000-0000-0000-000000000000

The ID of the inbox rule.

Response

Successfully retrieved the inbox rule

Example response

{
  "data": {
    "attributes": {
      "action": {
        "description": "Needs triage"
      },
      "created_at": 1722439510282,
      "created_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Jane Doe",
        "type": "user"
      },
      "enabled": true,
      "modified_at": 1722439510282,
      "modified_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Jane Doe",
        "type": "user"
      },
      "name": "Triage production misconfigurations",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:prod team:platform"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "inbox_rules"
  }
}

Changes

Changes to this operation have not been checked yet.