v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Security Monitoring

Get a mute rule

Get the details of a mute rule by ID.

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

Path parameters

rule_idstring uuid required
Example:00000000-0000-0000-0000-000000000000

The ID of the mute rule.

Response

Successfully retrieved the mute rule

Example response

{
  "data": {
    "attributes": {
      "action": {
        "expire_at": 4070908800000,
        "reason": "risk_accepted",
        "reason_description": "Accepted for dev environments only"
      },
      "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": "Mute accepted risks in dev",
      "rule": {
        "finding_types": [
          "misconfiguration"
        ],
        "query": "env:prod team:platform"
      }
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "mute_rules"
  }
}