From 746895dd2b75756a58ae7465ff1fb1922eda3f66 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 17 Jun 2026 08:54:48 +0000 Subject: [PATCH] Regenerate client from commit 9bf3fc5 of spec repo --- config/_default/menus/api.en.yaml | 234 ++ .../create-a-due-date-rule/index.md | 3 + .../create-a-mute-rule/index.md | 3 + .../create-a-ticket-creation-rule/index.md | 3 + .../delete-a-due-date-rule/index.md | 3 + .../delete-a-mute-rule/index.md | 3 + .../delete-a-ticket-creation-rule/index.md | 3 + .../get-a-due-date-rule/index.md | 3 + .../get-a-mute-rule/index.md | 3 + .../get-a-ticket-creation-rule/index.md | 3 + .../get-all-due-date-rules/index.md | 3 + .../get-all-mute-rules/index.md | 3 + .../get-all-ticket-creation-rules/index.md | 3 + .../reorder-due-date-rules/index.md | 3 + .../reorder-mute-rules/index.md | 3 + .../reorder-ticket-creation-rules/index.md | 3 + .../update-a-due-date-rule/index.md | 3 + .../update-a-mute-rule/index.md | 3 + .../update-a-ticket-creation-rule/index.md | 3 + .../api/v2/security-monitoring/examples.json | 1688 +++++++++++++ ...SecurityFindingsAutomationDueDateRule.json | 24 + ...ateSecurityFindingsAutomationMuteRule.json | 18 + ...yFindingsAutomationTicketCreationRule.json | 20 + ...ecurityFindingsAutomationDueDateRules.json | 8 + ...erSecurityFindingsAutomationMuteRules.json | 8 + ...FindingsAutomationTicketCreationRules.json | 8 + ...SecurityFindingsAutomationDueDateRule.json | 24 + ...ateSecurityFindingsAutomationMuteRule.json | 18 + ...yFindingsAutomationTicketCreationRule.json | 20 + data/api/v2/CodeExamples.json | 63 + data/api/v2/full_spec.yaml | 2086 +++++++++++++++++ data/api/v2/translate_actions.json | 90 + 32 files changed, 4363 insertions(+) create mode 100644 content/en/api/latest/security-monitoring/create-a-due-date-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/create-a-mute-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/create-a-ticket-creation-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/delete-a-due-date-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/delete-a-mute-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/delete-a-ticket-creation-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/get-a-due-date-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/get-a-mute-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/get-a-ticket-creation-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/get-all-due-date-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/get-all-mute-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/get-all-ticket-creation-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/reorder-due-date-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/reorder-mute-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/reorder-ticket-creation-rules/index.md create mode 100644 content/en/api/latest/security-monitoring/update-a-due-date-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/update-a-mute-rule/index.md create mode 100644 content/en/api/latest/security-monitoring/update-a-ticket-creation-rule/index.md create mode 100644 content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationDueDateRule.json create mode 100644 content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationMuteRule.json create mode 100644 content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationTicketCreationRule.json create mode 100644 content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationDueDateRules.json create mode 100644 content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationMuteRules.json create mode 100644 content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationTicketCreationRules.json create mode 100644 content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationDueDateRule.json create mode 100644 content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationMuteRule.json create mode 100644 content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationTicketCreationRule.json diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 0b45ac9d304..da07a996b21 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -4276,6 +4276,240 @@ menu: - DetachCase unstable: [] order: 17 + - name: Update a ticket creation rule + url: /api/latest/security-monitoring/update-a-ticket-creation-rule/ + identifier: security-monitoring-update-a-ticket-creation-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - UpdateSecurityFindingsAutomationTicketCreationRule + unstable: + - v2 + order: 149 + - name: Get a ticket creation rule + url: /api/latest/security-monitoring/get-a-ticket-creation-rule/ + identifier: security-monitoring-get-a-ticket-creation-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - GetSecurityFindingsAutomationTicketCreationRule + unstable: + - v2 + order: 148 + - name: Delete a ticket creation rule + url: /api/latest/security-monitoring/delete-a-ticket-creation-rule/ + identifier: security-monitoring-delete-a-ticket-creation-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - DeleteSecurityFindingsAutomationTicketCreationRule + unstable: + - v2 + order: 150 + - name: Reorder ticket creation rules + url: /api/latest/security-monitoring/reorder-ticket-creation-rules/ + identifier: security-monitoring-reorder-ticket-creation-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ReorderSecurityFindingsAutomationTicketCreationRules + unstable: + - v2 + order: 147 + - name: Create a ticket creation rule + url: /api/latest/security-monitoring/create-a-ticket-creation-rule/ + identifier: security-monitoring-create-a-ticket-creation-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - CreateSecurityFindingsAutomationTicketCreationRule + unstable: + - v2 + order: 146 + - name: Get all ticket creation rules + url: /api/latest/security-monitoring/get-all-ticket-creation-rules/ + identifier: security-monitoring-get-all-ticket-creation-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ListSecurityFindingsAutomationTicketCreationRules + unstable: + - v2 + order: 145 + - name: Update a mute rule + url: /api/latest/security-monitoring/update-a-mute-rule/ + identifier: security-monitoring-update-a-mute-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - UpdateSecurityFindingsAutomationMuteRule + unstable: + - v2 + order: 137 + - name: Get a mute rule + url: /api/latest/security-monitoring/get-a-mute-rule/ + identifier: security-monitoring-get-a-mute-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - GetSecurityFindingsAutomationMuteRule + unstable: + - v2 + order: 136 + - name: Delete a mute rule + url: /api/latest/security-monitoring/delete-a-mute-rule/ + identifier: security-monitoring-delete-a-mute-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - DeleteSecurityFindingsAutomationMuteRule + unstable: + - v2 + order: 138 + - name: Reorder mute rules + url: /api/latest/security-monitoring/reorder-mute-rules/ + identifier: security-monitoring-reorder-mute-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ReorderSecurityFindingsAutomationMuteRules + unstable: + - v2 + order: 135 + - name: Create a mute rule + url: /api/latest/security-monitoring/create-a-mute-rule/ + identifier: security-monitoring-create-a-mute-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - CreateSecurityFindingsAutomationMuteRule + unstable: + - v2 + order: 134 + - name: Get all mute rules + url: /api/latest/security-monitoring/get-all-mute-rules/ + identifier: security-monitoring-get-all-mute-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ListSecurityFindingsAutomationMuteRules + unstable: + - v2 + order: 133 + - name: Update a due date rule + url: /api/latest/security-monitoring/update-a-due-date-rule/ + identifier: security-monitoring-update-a-due-date-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - UpdateSecurityFindingsAutomationDueDateRule + unstable: + - v2 + order: 143 + - name: Get a due date rule + url: /api/latest/security-monitoring/get-a-due-date-rule/ + identifier: security-monitoring-get-a-due-date-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - GetSecurityFindingsAutomationDueDateRule + unstable: + - v2 + order: 142 + - name: Delete a due date rule + url: /api/latest/security-monitoring/delete-a-due-date-rule/ + identifier: security-monitoring-delete-a-due-date-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - DeleteSecurityFindingsAutomationDueDateRule + unstable: + - v2 + order: 144 + - name: Reorder due date rules + url: /api/latest/security-monitoring/reorder-due-date-rules/ + identifier: security-monitoring-reorder-due-date-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ReorderSecurityFindingsAutomationDueDateRules + unstable: + - v2 + order: 141 + - name: Create a due date rule + url: /api/latest/security-monitoring/create-a-due-date-rule/ + identifier: security-monitoring-create-a-due-date-rule + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - CreateSecurityFindingsAutomationDueDateRule + unstable: + - v2 + order: 140 + - name: Get all due date rules + url: /api/latest/security-monitoring/get-all-due-date-rules/ + identifier: security-monitoring-get-all-due-date-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ListSecurityFindingsAutomationDueDateRules + unstable: + - v2 + order: 139 - name: Assign or unassign security findings url: /api/latest/security-monitoring/assign-or-unassign-security-findings/ identifier: security-monitoring-assign-or-unassign-security-findings diff --git a/content/en/api/latest/security-monitoring/create-a-due-date-rule/index.md b/content/en/api/latest/security-monitoring/create-a-due-date-rule/index.md new file mode 100644 index 00000000000..24e4ba06701 --- /dev/null +++ b/content/en/api/latest/security-monitoring/create-a-due-date-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Create a due date rule +--- diff --git a/content/en/api/latest/security-monitoring/create-a-mute-rule/index.md b/content/en/api/latest/security-monitoring/create-a-mute-rule/index.md new file mode 100644 index 00000000000..856d0d609e8 --- /dev/null +++ b/content/en/api/latest/security-monitoring/create-a-mute-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Create a mute rule +--- diff --git a/content/en/api/latest/security-monitoring/create-a-ticket-creation-rule/index.md b/content/en/api/latest/security-monitoring/create-a-ticket-creation-rule/index.md new file mode 100644 index 00000000000..781c6d3e786 --- /dev/null +++ b/content/en/api/latest/security-monitoring/create-a-ticket-creation-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Create a ticket creation rule +--- diff --git a/content/en/api/latest/security-monitoring/delete-a-due-date-rule/index.md b/content/en/api/latest/security-monitoring/delete-a-due-date-rule/index.md new file mode 100644 index 00000000000..ca95bcb6ac9 --- /dev/null +++ b/content/en/api/latest/security-monitoring/delete-a-due-date-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a due date rule +--- diff --git a/content/en/api/latest/security-monitoring/delete-a-mute-rule/index.md b/content/en/api/latest/security-monitoring/delete-a-mute-rule/index.md new file mode 100644 index 00000000000..8cc929dd056 --- /dev/null +++ b/content/en/api/latest/security-monitoring/delete-a-mute-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a mute rule +--- diff --git a/content/en/api/latest/security-monitoring/delete-a-ticket-creation-rule/index.md b/content/en/api/latest/security-monitoring/delete-a-ticket-creation-rule/index.md new file mode 100644 index 00000000000..f55215bd816 --- /dev/null +++ b/content/en/api/latest/security-monitoring/delete-a-ticket-creation-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a ticket creation rule +--- diff --git a/content/en/api/latest/security-monitoring/get-a-due-date-rule/index.md b/content/en/api/latest/security-monitoring/get-a-due-date-rule/index.md new file mode 100644 index 00000000000..ea92993f64c --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-a-due-date-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Get a due date rule +--- diff --git a/content/en/api/latest/security-monitoring/get-a-mute-rule/index.md b/content/en/api/latest/security-monitoring/get-a-mute-rule/index.md new file mode 100644 index 00000000000..24a81b14cc9 --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-a-mute-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Get a mute rule +--- diff --git a/content/en/api/latest/security-monitoring/get-a-ticket-creation-rule/index.md b/content/en/api/latest/security-monitoring/get-a-ticket-creation-rule/index.md new file mode 100644 index 00000000000..fa3056653e9 --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-a-ticket-creation-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Get a ticket creation rule +--- diff --git a/content/en/api/latest/security-monitoring/get-all-due-date-rules/index.md b/content/en/api/latest/security-monitoring/get-all-due-date-rules/index.md new file mode 100644 index 00000000000..2d417fae4d2 --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-all-due-date-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Get all due date rules +--- diff --git a/content/en/api/latest/security-monitoring/get-all-mute-rules/index.md b/content/en/api/latest/security-monitoring/get-all-mute-rules/index.md new file mode 100644 index 00000000000..285258896b8 --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-all-mute-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Get all mute rules +--- diff --git a/content/en/api/latest/security-monitoring/get-all-ticket-creation-rules/index.md b/content/en/api/latest/security-monitoring/get-all-ticket-creation-rules/index.md new file mode 100644 index 00000000000..566305dbd4e --- /dev/null +++ b/content/en/api/latest/security-monitoring/get-all-ticket-creation-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Get all ticket creation rules +--- diff --git a/content/en/api/latest/security-monitoring/reorder-due-date-rules/index.md b/content/en/api/latest/security-monitoring/reorder-due-date-rules/index.md new file mode 100644 index 00000000000..c96fc5ba7f5 --- /dev/null +++ b/content/en/api/latest/security-monitoring/reorder-due-date-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Reorder due date rules +--- diff --git a/content/en/api/latest/security-monitoring/reorder-mute-rules/index.md b/content/en/api/latest/security-monitoring/reorder-mute-rules/index.md new file mode 100644 index 00000000000..7a21eb8b5f6 --- /dev/null +++ b/content/en/api/latest/security-monitoring/reorder-mute-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Reorder mute rules +--- diff --git a/content/en/api/latest/security-monitoring/reorder-ticket-creation-rules/index.md b/content/en/api/latest/security-monitoring/reorder-ticket-creation-rules/index.md new file mode 100644 index 00000000000..fdd71b36e0c --- /dev/null +++ b/content/en/api/latest/security-monitoring/reorder-ticket-creation-rules/index.md @@ -0,0 +1,3 @@ +--- +title: Reorder ticket creation rules +--- diff --git a/content/en/api/latest/security-monitoring/update-a-due-date-rule/index.md b/content/en/api/latest/security-monitoring/update-a-due-date-rule/index.md new file mode 100644 index 00000000000..7ce7f58db04 --- /dev/null +++ b/content/en/api/latest/security-monitoring/update-a-due-date-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Update a due date rule +--- diff --git a/content/en/api/latest/security-monitoring/update-a-mute-rule/index.md b/content/en/api/latest/security-monitoring/update-a-mute-rule/index.md new file mode 100644 index 00000000000..9154df2ffad --- /dev/null +++ b/content/en/api/latest/security-monitoring/update-a-mute-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Update a mute rule +--- diff --git a/content/en/api/latest/security-monitoring/update-a-ticket-creation-rule/index.md b/content/en/api/latest/security-monitoring/update-a-ticket-creation-rule/index.md new file mode 100644 index 00000000000..a674f9681ca --- /dev/null +++ b/content/en/api/latest/security-monitoring/update-a-ticket-creation-rule/index.md @@ -0,0 +1,3 @@ +--- +title: Update a ticket creation rule +--- diff --git a/content/en/api/v2/security-monitoring/examples.json b/content/en/api/v2/security-monitoring/examples.json index 71b0a5e951d..e1ca98a7b7f 100644 --- a/content/en/api/v2/security-monitoring/examples.json +++ b/content/en/api/v2/security-monitoring/examples.json @@ -831,6 +831,1694 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data of the assignee request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the assignee request.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

string

\n

Unique identifier of the Datadog user to assign the security findings to. If this field is not provided, the security findings are unassigned.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier of the assignee request.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of the assignee request.

\n
\n
\n
\n
\n
\n

findings [required]

\n
\n

object

\n

Security findings to assign or unassign.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of security finding data objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the security finding.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Security findings resource type. \nAllowed enum values: findings

default: findings

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Assignee resource type. \nAllowed enum values: assignee

default: assignee

\n
\n \n
\n
\n
\n
" } }, + "ListSecurityFindingsAutomationDueDateRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings 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": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "due_date_rules" + } + ], + "links": { + "first": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0", + "last": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=5", + "next": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=2", + "prev": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0" + }, + "meta": { + "page": { + "total_filtered_count": 42 + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of due date rule data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links [required]

\n
\n

object

\n

Pagination links for the list of automation rules.

\n
\n
\n
\n
\n
\n

first [required]

\n
\n

string

\n

Link to the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last [required]

\n
\n

string

\n

Link to the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Metadata for the list of automation rules.

\n
\n
\n
\n
\n
\n

page [required]

\n
\n

object

\n

Pagination information for the list of automation rules.

\n
\n
\n
\n
\n
\n

total_filtered_count [required]

\n
\n

int64

\n

The total number of rules matching the current filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateSecurityFindingsAutomationDueDateRule": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings 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": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "due_date_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen" + }, + "enabled": true, + "name": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "due_date_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings only" + }, + "enabled": true, + "name": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "due_date_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a due date rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a due date rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
" + } + }, + "ReorderSecurityFindingsAutomationDueDateRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteSecurityFindingsAutomationDueDateRule": { + "responses": { + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetSecurityFindingsAutomationDueDateRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings 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": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "due_date_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateSecurityFindingsAutomationDueDateRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings 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": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "due_date_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a due date rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen" + }, + "enabled": true, + "name": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "due_date_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen", + "reason_description": "Applied for production findings only" + }, + "enabled": true, + "name": "Critical findings due in 7 days", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "due_date_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a due date rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a due date rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the due date rule matches a finding.

\n
\n
\n
\n
\n
\n

due_days_per_severity [required]

\n
\n

[object]

\n

A list of severity-to-due-date mappings. Each severity may appear at most once.

\n
\n
\n
\n
\n
\n

due_in_days [required]

\n
\n

int64

\n

The number of days from the reference point until the finding is due.

\n
\n \n
\n
\n
\n
\n
\n

severity [required]

\n
\n

enum

\n

A severity level used to configure due date thresholds. \nAllowed enum values: critical,high,medium,low,info,none,unknown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

due_from [required]

\n
\n

enum

\n

The reference point from which the due date is calculated. When fix_available is selected but not applicable to the finding type, first_seen is used instead. \nAllowed enum values: first_seen,fix_available

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the due date assignment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the due date rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the due date rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for due date rules. \nAllowed enum values: due_date_rules

\n
\n \n
\n
\n
\n
" + } + }, + "ListSecurityFindingsAutomationMuteRules": { + "responses": { + "200": { + "json": { + "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" + } + ], + "links": { + "first": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0", + "last": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=5", + "next": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=2", + "prev": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0" + }, + "meta": { + "page": { + "total_filtered_count": 42 + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of mute rule data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links [required]

\n
\n

object

\n

Pagination links for the list of automation rules.

\n
\n
\n
\n
\n
\n

first [required]

\n
\n

string

\n

Link to the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last [required]

\n
\n

string

\n

Link to the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Metadata for the list of automation rules.

\n
\n
\n
\n
\n
\n

page [required]

\n
\n

object

\n

Pagination information for the list of automation rules.

\n
\n
\n
\n
\n
\n

total_filtered_count [required]

\n
\n

int64

\n

The total number of rules matching the current filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateSecurityFindingsAutomationMuteRule": { + "responses": { + "201": { + "json": { + "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" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "reason": "risk_accepted" + }, + "enabled": true, + "name": "Mute accepted risks in dev", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "mute_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "expire_at": 4070908800000, + "reason": "risk_accepted", + "reason_description": "Accepted for dev environments only" + }, + "enabled": true, + "name": "Mute accepted risks in dev", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "mute_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a mute rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a mute rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
" + } + }, + "ReorderSecurityFindingsAutomationMuteRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteSecurityFindingsAutomationMuteRule": { + "responses": { + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetSecurityFindingsAutomationMuteRule": { + "responses": { + "200": { + "json": { + "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" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateSecurityFindingsAutomationMuteRule": { + "responses": { + "200": { + "json": { + "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" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a mute rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "reason": "risk_accepted" + }, + "enabled": true, + "name": "Mute accepted risks in dev", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "mute_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "expire_at": 4070908800000, + "reason": "risk_accepted", + "reason_description": "Accepted for dev environments only" + }, + "enabled": true, + "name": "Mute accepted risks in dev", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "mute_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a mute rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a mute rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the mute rule matches a finding.

\n
\n
\n
\n
\n
\n

expire_at

\n
\n

int64

\n

The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.

\n
\n \n
\n
\n
\n
\n
\n

reason [required]

\n
\n

enum

\n

The reason for muting a security finding. \nAllowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted

\n
\n \n
\n
\n
\n
\n
\n

reason_description

\n
\n

string

\n

An optional description providing more context for the mute reason.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the mute rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the mute rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for mute rules. \nAllowed enum values: mute_rules

\n
\n \n
\n
\n
\n
" + } + }, + "ListSecurityFindingsAutomationTicketCreationRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "auto_disabled_reason": "Daily ticket creation limit exceeded", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "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": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "ticket_creation_rules" + } + ], + "links": { + "first": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0", + "last": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=5", + "next": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=2", + "prev": "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0" + }, + "meta": { + "page": { + "total_filtered_count": 42 + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of ticket creation rule data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links [required]

\n
\n

object

\n

Pagination links for the list of automation rules.

\n
\n
\n
\n
\n
\n

first [required]

\n
\n

string

\n

Link to the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last [required]

\n
\n

string

\n

Link to the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Metadata for the list of automation rules.

\n
\n
\n
\n
\n
\n

page [required]

\n
\n

object

\n

Pagination information for the list of automation rules.

\n
\n
\n
\n
\n
\n

total_filtered_count [required]

\n
\n

int64

\n

The total number of rules matching the current filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateSecurityFindingsAutomationTicketCreationRule": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "auto_disabled_reason": "Daily ticket creation limit exceeded", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "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": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "ticket_creation_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": true, + "name": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "ticket_creation_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": true, + "name": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "ticket_creation_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" + } + }, + "ReorderSecurityFindingsAutomationTicketCreationRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The ordered list of all rules; every rule must be included.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the automation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the automation rule.

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteSecurityFindingsAutomationTicketCreationRule": { + "responses": { + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetSecurityFindingsAutomationTicketCreationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "auto_disabled_reason": "Daily ticket creation limit exceeded", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "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": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "ticket_creation_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateSecurityFindingsAutomationTicketCreationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "auto_disabled_reason": "Daily ticket creation limit exceeded", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "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": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "ticket_creation_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

The user who created or last modified the rule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of actor who created or modified the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "action": { + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": true, + "name": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ] + } + }, + "type": "ticket_creation_rules" + } + }, + "json": { + "data": { + "attributes": { + "action": { + "assignee_id": "22222222-2222-2222-2222-222222222222", + "fields": { + "labels": [ + "security" + ] + }, + "max_tickets_per_day": 100, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": true, + "name": "Auto-create Jira tickets for critical findings", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:prod team:platform" + } + }, + "type": "ticket_creation_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

\n
\n
\n
\n
\n
\n

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

\n
\n
\n
\n
\n
\n

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

\n
\n \n
\n
\n
\n
\n
\n

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

\n
\n \n
\n
\n
\n
\n
\n

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

\n
\n \n
\n
\n
\n
\n
\n

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

\n
\n
\n
\n
\n
\n

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace, and the @is_in_security_inbox and @status fields, are not permitted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" + } + }, "DetachCase": { "responses": { "400": { diff --git a/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationDueDateRule.json b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationDueDateRule.json new file mode 100644 index 00000000000..4193bc57627 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationDueDateRule.json @@ -0,0 +1,24 @@ +{ + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 7, + "severity": "critical" + } + ], + "due_from": "first_seen" + }, + "enabled": true, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "due_date_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationMuteRule.json b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationMuteRule.json new file mode 100644 index 00000000000..dd069288ad1 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationMuteRule.json @@ -0,0 +1,18 @@ +{ + "data": { + "attributes": { + "action": { + "reason": "risk_accepted" + }, + "enabled": true, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "mute_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationTicketCreationRule.json b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationTicketCreationRule.json new file mode 100644 index 00000000000..ea13327cc87 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.CreateSecurityFindingsAutomationTicketCreationRule.json @@ -0,0 +1,20 @@ +{ + "data": { + "attributes": { + "action": { + "max_tickets_per_day": 10, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": true, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "ticket_creation_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationDueDateRules.json b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationDueDateRules.json new file mode 100644 index 00000000000..80b1fe04f8e --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationDueDateRules.json @@ -0,0 +1,8 @@ +{ + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "due_date_rules" + } + ] +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationMuteRules.json b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationMuteRules.json new file mode 100644 index 00000000000..6bd3ba5337c --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationMuteRules.json @@ -0,0 +1,8 @@ +{ + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "mute_rules" + } + ] +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationTicketCreationRules.json b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationTicketCreationRules.json new file mode 100644 index 00000000000..37a1cf1653b --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.ReorderSecurityFindingsAutomationTicketCreationRules.json @@ -0,0 +1,8 @@ +{ + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "ticket_creation_rules" + } + ] +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationDueDateRule.json b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationDueDateRule.json new file mode 100644 index 00000000000..8502f15b83e --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationDueDateRule.json @@ -0,0 +1,24 @@ +{ + "data": { + "attributes": { + "action": { + "due_days_per_severity": [ + { + "due_in_days": 14, + "severity": "critical" + } + ], + "due_from": "first_seen" + }, + "enabled": false, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "due_date_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationMuteRule.json b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationMuteRule.json new file mode 100644 index 00000000000..fa4f3002a06 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationMuteRule.json @@ -0,0 +1,18 @@ +{ + "data": { + "attributes": { + "action": { + "reason": "false_positive" + }, + "enabled": false, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "mute_rules" + } +} \ No newline at end of file diff --git a/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationTicketCreationRule.json b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationTicketCreationRule.json new file mode 100644 index 00000000000..c5bd079be69 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.UpdateSecurityFindingsAutomationTicketCreationRule.json @@ -0,0 +1,20 @@ +{ + "data": { + "attributes": { + "action": { + "max_tickets_per_day": 5, + "project_id": "11111111-1111-1111-1111-111111111111", + "target": "jira" + }, + "enabled": false, + "name": "Example-Security-Monitoring", + "rule": { + "finding_types": [ + "misconfiguration" + ], + "query": "env:staging" + } + }, + "type": "ticket_creation_rules" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index f7ce4ba6817..6314b893ec5 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -2139,6 +2139,20 @@ "description": "Create a custom framework returns \"OK\" response" } ], + "CreateSecurityFindingsAutomationDueDateRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Create a due date rule returns \"Successfully created the due date rule\" response" + } + ], + "CreateSecurityFindingsAutomationMuteRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Create a mute rule returns \"Successfully created the mute rule\" response" + } + ], "CreateSignalNotificationRule": [ { "group": "security_monitoring", @@ -2177,6 +2191,13 @@ "description": "Create a suppression rule with an exclusion query returns \"OK\" response" } ], + "CreateSecurityFindingsAutomationTicketCreationRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Create a ticket creation rule returns \"Successfully created the ticket creation rule\" response" + } + ], "CreateCases": [ { "group": "security_monitoring", @@ -2255,6 +2276,27 @@ "description": "Patch a vulnerability-based notification rule returns \"Notification rule successfully patched.\" response" } ], + "ReorderSecurityFindingsAutomationDueDateRules": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Reorder due date rules returns \"Successfully reordered the due date rules\" response" + } + ], + "ReorderSecurityFindingsAutomationMuteRules": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Reorder mute rules returns \"Successfully reordered the mute rules\" response" + } + ], + "ReorderSecurityFindingsAutomationTicketCreationRules": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Reorder ticket creation rules returns \"Successfully reordered the ticket creation rules\" response" + } + ], "RunHistoricalJob": [ { "group": "security_monitoring", @@ -2314,6 +2356,20 @@ "description": "Update a custom framework returns \"OK\" response" } ], + "UpdateSecurityFindingsAutomationDueDateRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Update a due date rule returns \"Successfully updated the due date rule\" response" + } + ], + "UpdateSecurityFindingsAutomationMuteRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Update a mute rule returns \"Successfully updated the mute rule\" response" + } + ], "UpdateSecurityFilter": [ { "group": "security_monitoring", @@ -2328,6 +2384,13 @@ "description": "Update a suppression rule returns \"OK\" response" } ], + "UpdateSecurityFindingsAutomationTicketCreationRule": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Update a ticket creation rule returns \"Successfully updated the ticket creation rule\" response" + } + ], "UpdateResourceEvaluationFilters": [ { "group": "security_monitoring", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index e9f521f7014..5e01bf37845 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -11480,6 +11480,27 @@ components: required: - data type: object + AutomationRuleCreator: + description: The user who created or last modified the rule. + properties: + id: + description: The ID of the user who created or modified the rule. + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + name: + description: The name of the user who created or modified the rule. + example: "Jane Doe" + type: string + type: + description: The type of actor who created or modified the rule. + example: user + type: string + required: + - type + - id + - name + type: object AutomationRuleRelationships: description: Related resources for the automation rule, including the users who created and last modified it. properties: @@ -11496,6 +11517,19 @@ components: required: - data type: object + AutomationRuleScope: + description: Defines the scope of findings to which the automation rule applies. + properties: + finding_types: + $ref: "#/components/schemas/SecurityFindingTypes" + query: + description: A search query to further filter the findings matched by this rule. The `@workflow.*` namespace, and the `@is_in_security_inbox` and `@status` fields, are not permitted. + example: "env:prod team:platform" + maxLength: 30000 + type: string + required: + - finding_types + type: object AutomationRuleTrigger: description: Defines when the rule activates. Combines a trigger type (the case event to listen for) with optional trigger data (conditions that narrow when the trigger fires). properties: @@ -31485,6 +31519,213 @@ components: - type - attributes type: object + DueDateFrom: + description: The reference point from which the due date is calculated. When `fix_available` is selected but not applicable to the finding type, `first_seen` is used instead. + enum: + - first_seen + - fix_available + example: first_seen + type: string + x-enum-varnames: + - FIRST_SEEN + - FIX_AVAILABLE + DueDatePerSeverityItem: + description: A mapping of a severity level to the number of days until a finding is due. + properties: + due_in_days: + description: The number of days from the reference point until the finding is due. + example: 7 + format: int64 + minimum: 1 + type: integer + severity: + $ref: "#/components/schemas/DueDateSeverity" + required: + - severity + - due_in_days + type: object + DueDatePerSeverityList: + description: A list of severity-to-due-date mappings. Each severity may appear at most once. + items: + $ref: "#/components/schemas/DueDatePerSeverityItem" + type: array + DueDateRuleAction: + description: The action to take when the due date rule matches a finding. + properties: + due_days_per_severity: + $ref: "#/components/schemas/DueDatePerSeverityList" + due_from: + $ref: "#/components/schemas/DueDateFrom" + reason_description: + description: An optional description providing more context for the due date assignment. + example: "Applied for production findings only" + maxLength: 20000 + type: string + required: + - due_days_per_severity + - due_from + type: object + DueDateRuleAttributesCreate: + description: Attributes for creating or updating a due date rule. + properties: + action: + $ref: "#/components/schemas/DueDateRuleAction" + enabled: + description: Whether the due date rule is enabled. + example: true + type: boolean + name: + description: The name of the due date rule. + example: "Critical findings due in 7 days" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + type: object + DueDateRuleAttributesResponse: + description: Attributes of a due date rule returned by the API. + properties: + action: + $ref: "#/components/schemas/DueDateRuleAction" + created_at: + description: The Unix timestamp in milliseconds when the rule was created. + example: 1722439510282 + format: int64 + type: integer + created_by: + $ref: "#/components/schemas/AutomationRuleCreator" + enabled: + description: Whether the due date rule is enabled. + example: true + type: boolean + modified_at: + description: The Unix timestamp in milliseconds when the rule was last modified. + example: 1722439510282 + format: int64 + type: integer + modified_by: + $ref: "#/components/schemas/AutomationRuleCreator" + name: + description: The name of the due date rule. + example: "Critical findings due in 7 days" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + - created_at + - created_by + - modified_at + - modified_by + type: object + DueDateRuleCreateRequest: + description: The body of a due date rule create request. + properties: + data: + $ref: "#/components/schemas/DueDateRuleDataCreate" + required: + - data + type: object + DueDateRuleDataCreate: + description: The data object for a due date rule create or update request. + properties: + attributes: + $ref: "#/components/schemas/DueDateRuleAttributesCreate" + type: + $ref: "#/components/schemas/DueDateRuleType" + required: + - type + - attributes + type: object + DueDateRuleDataResponse: + description: The data object for a due date rule returned by the API. + properties: + attributes: + $ref: "#/components/schemas/DueDateRuleAttributesResponse" + id: + description: The ID of the due date rule. + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + type: + $ref: "#/components/schemas/DueDateRuleType" + required: + - id + - type + - attributes + type: object + DueDateRuleResponse: + description: A single due date rule response. + properties: + data: + $ref: "#/components/schemas/DueDateRuleDataResponse" + required: + - data + type: object + DueDateRuleType: + description: The JSON:API type for due date rules. + enum: + - due_date_rules + example: due_date_rules + type: string + x-enum-varnames: + - DUE_DATE_RULES + DueDateRuleUpdateRequest: + description: The body of a due date rule update request. + properties: + data: + $ref: "#/components/schemas/DueDateRuleDataCreate" + required: + - data + type: object + DueDateRulesDataList: + description: A list of due date rule data objects. + items: + $ref: "#/components/schemas/DueDateRuleDataResponse" + type: array + DueDateRulesResponse: + description: A list of due date rules with pagination metadata. + properties: + data: + $ref: "#/components/schemas/DueDateRulesDataList" + links: + $ref: "#/components/schemas/SecurityAutomationRulesLinks" + meta: + $ref: "#/components/schemas/SecurityAutomationRulesMeta" + required: + - data + - meta + - links + type: object + DueDateSeverity: + description: A severity level used to configure due date thresholds. + enum: + - critical + - high + - medium + - low + - info + - none + - unknown + example: critical + type: string + x-enum-varnames: + - CRITICAL + - HIGH + - MEDIUM + - LOW + - INFO + - NONE + - UNKNOWN ELFSourcemapAttributes: description: Attributes of an ELF symbol file. properties: @@ -61341,6 +61582,183 @@ components: - type - id type: object + MuteReason: + description: The reason for muting a security finding. + enum: + - duplicate + - false_positive + - no_fix + - other + - pending_fix + - risk_accepted + example: risk_accepted + type: string + x-enum-varnames: + - DUPLICATE + - FALSE_POSITIVE + - NO_FIX + - OTHER + - PENDING_FIX + - RISK_ACCEPTED + MuteRuleAction: + description: The action to take when the mute rule matches a finding. + properties: + expire_at: + description: The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire. + example: 4070908800000 + format: int64 + type: integer + reason: + $ref: "#/components/schemas/MuteReason" + reason_description: + description: An optional description providing more context for the mute reason. + example: "Accepted for dev environments only" + maxLength: 20000 + type: string + required: + - reason + type: object + MuteRuleAttributesCreate: + description: Attributes for creating or updating a mute rule. + properties: + action: + $ref: "#/components/schemas/MuteRuleAction" + enabled: + description: Whether the mute rule is enabled. + example: true + type: boolean + name: + description: The name of the mute rule. + example: "Mute accepted risks in dev" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + type: object + MuteRuleAttributesResponse: + description: Attributes of a mute rule returned by the API. + properties: + action: + $ref: "#/components/schemas/MuteRuleAction" + created_at: + description: The Unix timestamp in milliseconds when the rule was created. + example: 1722439510282 + format: int64 + type: integer + created_by: + $ref: "#/components/schemas/AutomationRuleCreator" + enabled: + description: Whether the mute rule is enabled. + example: true + type: boolean + modified_at: + description: The Unix timestamp in milliseconds when the rule was last modified. + example: 1722439510282 + format: int64 + type: integer + modified_by: + $ref: "#/components/schemas/AutomationRuleCreator" + name: + description: The name of the mute rule. + example: "Mute accepted risks in dev" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + - created_at + - created_by + - modified_at + - modified_by + type: object + MuteRuleCreateRequest: + description: The body of a mute rule create request. + properties: + data: + $ref: "#/components/schemas/MuteRuleDataCreate" + required: + - data + type: object + MuteRuleDataCreate: + description: The data object for a mute rule create or update request. + properties: + attributes: + $ref: "#/components/schemas/MuteRuleAttributesCreate" + type: + $ref: "#/components/schemas/MuteRuleType" + required: + - type + - attributes + type: object + MuteRuleDataResponse: + description: The data object for a mute rule returned by the API. + properties: + attributes: + $ref: "#/components/schemas/MuteRuleAttributesResponse" + id: + description: The ID of the mute rule. + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + type: + $ref: "#/components/schemas/MuteRuleType" + required: + - id + - type + - attributes + type: object + MuteRuleResponse: + description: A single mute rule response. + properties: + data: + $ref: "#/components/schemas/MuteRuleDataResponse" + required: + - data + type: object + MuteRuleType: + description: The JSON:API type for mute rules. + enum: + - mute_rules + example: mute_rules + type: string + x-enum-varnames: + - MUTE_RULES + MuteRuleUpdateRequest: + description: The body of a mute rule update request. + properties: + data: + $ref: "#/components/schemas/MuteRuleDataCreate" + required: + - data + type: object + MuteRulesDataList: + description: A list of mute rule data objects. + items: + $ref: "#/components/schemas/MuteRuleDataResponse" + type: array + MuteRulesResponse: + description: A list of mute rules with pagination metadata. + properties: + data: + $ref: "#/components/schemas/MuteRulesDataList" + links: + $ref: "#/components/schemas/SecurityAutomationRulesLinks" + meta: + $ref: "#/components/schemas/SecurityAutomationRulesMeta" + required: + - data + - meta + - links + type: object NDKSourcemapAttributes: description: Attributes of an Android NDK symbol file. properties: @@ -83435,6 +83853,77 @@ components: - SYSTEM - LIGHT - DARK + SecurityAutomationRuleReorderData: + description: The ordered list of all rules; every rule must be included. + items: + $ref: "#/components/schemas/SecurityAutomationRuleReorderItem" + type: array + SecurityAutomationRuleReorderItem: + description: A reference to an automation rule used for reordering. + properties: + id: + description: The ID of the automation rule. + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + type: + description: The type of the automation rule. + example: mute_rules + type: string + required: + - type + - id + type: object + SecurityAutomationRuleReorderRequest: + description: The body of the reorder request. + properties: + data: + $ref: "#/components/schemas/SecurityAutomationRuleReorderData" + required: + - data + type: object + SecurityAutomationRulesLinks: + description: Pagination links for the list of automation rules. + properties: + first: + description: Link to the first page of results. + example: "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0" + type: string + last: + description: Link to the last page of results. + example: "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=5" + type: string + next: + description: Link to the next page of results. + example: "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=2" + type: string + prev: + description: Link to the previous page of results. + example: "/api/v2/security/findings/automation/mute_rules?page[size]=10&page[number]=0" + type: string + required: + - first + - last + type: object + SecurityAutomationRulesMeta: + description: Metadata for the list of automation rules. + properties: + page: + $ref: "#/components/schemas/SecurityAutomationRulesPageInfo" + required: + - page + type: object + SecurityAutomationRulesPageInfo: + description: Pagination information for the list of automation rules. + properties: + total_filtered_count: + description: The total number of rules matching the current filter. + example: 42 + format: int64 + type: integer + required: + - total_filtered_count + type: object SecurityEntityConfigRisks: description: Configuration risks associated with the entity properties: @@ -84039,6 +84528,41 @@ components: meta: $ref: "#/components/schemas/SecurityFilterMeta" type: object + SecurityFindingType: + description: The type of security finding that the automation rule applies to. + enum: + - api_security + - attack_path + - host_and_container_vulnerability + - iac_misconfiguration + - identity_risk + - library_vulnerability + - misconfiguration + - runtime_code_vulnerability + - secret + - static_code_vulnerability + - workload_activity + example: misconfiguration + type: string + x-enum-varnames: + - API_SECURITY + - ATTACK_PATH + - HOST_AND_CONTAINER_VULNERABILITY + - IAC_MISCONFIGURATION + - IDENTITY_RISK + - LIBRARY_VULNERABILITY + - MISCONFIGURATION + - RUNTIME_CODE_VULNERABILITY + - SECRET + - STATIC_CODE_VULNERABILITY + - WORKLOAD_ACTIVITY + SecurityFindingTypes: + description: The list of security finding types that the automation rule applies to. + example: + - misconfiguration + items: + $ref: "#/components/schemas/SecurityFindingType" + type: array SecurityFindingsAttributes: description: The JSON object containing all attributes of the security finding. properties: @@ -102566,6 +103090,227 @@ components: type: string x-enum-varnames: - TEST_OPTIMIZATION_UPDATE_SERVICE_SETTINGS_REQUEST + TicketCreationRuleAction: + description: The action to take when the ticket creation rule matches a finding. + properties: + assignee_id: + description: The UUID of the default assignee for created tickets. + example: "22222222-2222-2222-2222-222222222222" + format: uuid + type: string + fields: + description: Custom fields of the Jira issue to create. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + example: + labels: + - security + type: object + max_tickets_per_day: + description: The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule. + example: 100 + format: int64 + maximum: 500 + minimum: 1 + type: integer + project_id: + description: The UUID of the case management project. + example: "11111111-1111-1111-1111-111111111111" + format: uuid + type: string + target: + $ref: "#/components/schemas/TicketCreationTarget" + required: + - project_id + - target + - max_tickets_per_day + type: object + TicketCreationRuleActionResponse: + description: The action to take when the ticket creation rule matches a finding. + properties: + assignee_id: + description: The UUID of the default assignee for created tickets. + example: "22222222-2222-2222-2222-222222222222" + format: uuid + type: string + auto_disabled_reason: + description: The reason the rule was automatically disabled by the system due to a ticketing integration error. + example: "Daily ticket creation limit exceeded" + type: string + fields: + description: Custom fields of the Jira issue to create. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + example: + labels: + - security + type: object + max_tickets_per_day: + description: The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule. + example: 100 + format: int64 + maximum: 500 + minimum: 1 + type: integer + project_id: + description: The UUID of the case management project. + example: "11111111-1111-1111-1111-111111111111" + format: uuid + type: string + target: + $ref: "#/components/schemas/TicketCreationTarget" + required: + - project_id + - target + - max_tickets_per_day + type: object + TicketCreationRuleAttributesCreate: + description: Attributes for creating or updating a ticket creation rule. + properties: + action: + $ref: "#/components/schemas/TicketCreationRuleAction" + enabled: + description: Whether the ticket creation rule is enabled. + example: true + type: boolean + name: + description: The name of the ticket creation rule. + example: "Auto-create Jira tickets for critical findings" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + type: object + TicketCreationRuleAttributesResponse: + description: Attributes of a ticket creation rule returned by the API. + properties: + action: + $ref: "#/components/schemas/TicketCreationRuleActionResponse" + created_at: + description: The Unix timestamp in milliseconds when the rule was created. + example: 1722439510282 + format: int64 + type: integer + created_by: + $ref: "#/components/schemas/AutomationRuleCreator" + enabled: + description: Whether the ticket creation rule is enabled. + example: true + type: boolean + modified_at: + description: The Unix timestamp in milliseconds when the rule was last modified. + example: 1722439510282 + format: int64 + type: integer + modified_by: + $ref: "#/components/schemas/AutomationRuleCreator" + name: + description: The name of the ticket creation rule. + example: "Auto-create Jira tickets for critical findings" + maxLength: 255 + type: string + rule: + $ref: "#/components/schemas/AutomationRuleScope" + required: + - name + - enabled + - rule + - action + - created_at + - created_by + - modified_at + - modified_by + type: object + TicketCreationRuleCreateRequest: + description: The body of a ticket creation rule create request. + properties: + data: + $ref: "#/components/schemas/TicketCreationRuleDataCreate" + required: + - data + type: object + TicketCreationRuleDataCreate: + description: The data object for a ticket creation rule create or update request. + properties: + attributes: + $ref: "#/components/schemas/TicketCreationRuleAttributesCreate" + type: + $ref: "#/components/schemas/TicketCreationRuleType" + required: + - type + - attributes + type: object + TicketCreationRuleDataResponse: + description: The data object for a ticket creation rule returned by the API. + properties: + attributes: + $ref: "#/components/schemas/TicketCreationRuleAttributesResponse" + id: + description: The ID of the ticket creation rule. + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + type: + $ref: "#/components/schemas/TicketCreationRuleType" + required: + - id + - type + - attributes + type: object + TicketCreationRuleResponse: + description: A single ticket creation rule response. + properties: + data: + $ref: "#/components/schemas/TicketCreationRuleDataResponse" + required: + - data + type: object + TicketCreationRuleType: + description: The JSON:API type for ticket creation rules. + enum: + - ticket_creation_rules + example: ticket_creation_rules + type: string + x-enum-varnames: + - TICKET_CREATION_RULES + TicketCreationRuleUpdateRequest: + description: The body of a ticket creation rule update request. + properties: + data: + $ref: "#/components/schemas/TicketCreationRuleDataCreate" + required: + - data + type: object + TicketCreationRulesDataList: + description: A list of ticket creation rule data objects. + items: + $ref: "#/components/schemas/TicketCreationRuleDataResponse" + type: array + TicketCreationRulesResponse: + description: A list of ticket creation rules with pagination metadata. + properties: + data: + $ref: "#/components/schemas/TicketCreationRulesDataList" + links: + $ref: "#/components/schemas/SecurityAutomationRulesLinks" + meta: + $ref: "#/components/schemas/SecurityAutomationRulesMeta" + required: + - data + - meta + - links + type: object + TicketCreationTarget: + description: The ticketing system to create tickets in. + enum: + - jira + - case_management + example: jira + type: string + x-enum-varnames: + - JIRA + - CASE_MANAGEMENT TimeAggregation: description: |- Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. @@ -169217,6 +169962,1347 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/due_date_rules: + get: + description: Get all due date rules for the current organization. + operationId: ListSecurityFindingsAutomationDueDateRules + parameters: + - description: The number of rules per page. Maximum is 1000. + in: query + name: page[size] + required: false + schema: + default: 1000 + example: 10 + format: int64 + maximum: 1000 + minimum: 1 + type: integer + - description: The page number to return. + in: query + name: page[number] + required: false + schema: + default: 0 + example: 0 + format: int64 + minimum: 0 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + due_from: first_seen + 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: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + links: + first: "/api/v2/security/findings/automation/due_date_rules?page[size]=1000&page[number]=0" + last: "/api/v2/security/findings/automation/due_date_rules?page[size]=1000&page[number]=0" + meta: + page: + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/DueDateRulesResponse" + description: Successfully retrieved the list of due date rules + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get all due date rules + tags: + - Security Monitoring + x-menu-order: 139 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new due date rule for the current organization. + operationId: CreateSecurityFindingsAutomationDueDateRule + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + due_from: first_seen + enabled: true + name: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + type: due_date_rules + schema: + $ref: "#/components/schemas/DueDateRuleCreateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + due_from: first_seen + 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: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + schema: + $ref: "#/components/schemas/DueDateRuleResponse" + description: Successfully created the due date rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Create a due date rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 140 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/due_date_rules/reorder: + post: + description: Reorder the list of due date rules for the current organization. + operationId: ReorderSecurityFindingsAutomationDueDateRules + requestBody: + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + - id: "11111111-1111-1111-1111-111111111111" + type: due_date_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + - id: "11111111-1111-1111-1111-111111111111" + type: due_date_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + description: Successfully reordered the due date rules + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Reorder due date rules + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 141 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/due_date_rules/{rule_id}: + delete: + description: Delete an existing due date rule by ID. + operationId: DeleteSecurityFindingsAutomationDueDateRule + parameters: + - description: The ID of the due date rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "204": + description: "Rule successfully deleted." + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Delete a due date rule + tags: + - Security Monitoring + x-menu-order: 144 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get the details of a due date rule by ID. + operationId: GetSecurityFindingsAutomationDueDateRule + parameters: + - description: The ID of the due date rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + due_from: first_seen + 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: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + schema: + $ref: "#/components/schemas/DueDateRuleResponse" + description: Successfully retrieved the due date rule + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get a due date rule + tags: + - Security Monitoring + x-menu-order: 142 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Update an existing due date rule by ID. + operationId: UpdateSecurityFindingsAutomationDueDateRule + parameters: + - description: The ID of the due date rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + - due_in_days: 90 + severity: medium + due_from: fix_available + enabled: true + name: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + type: due_date_rules + schema: + $ref: "#/components/schemas/DueDateRuleUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + due_days_per_severity: + - due_in_days: 7 + severity: critical + - due_in_days: 30 + severity: high + - due_in_days: 90 + severity: medium + due_from: fix_available + created_at: 1722439510282 + created_by: + id: "00000000-0000-0000-0000-000000000000" + name: "Jane Doe" + type: user + enabled: true + modified_at: 1722439510999 + modified_by: + id: "00000000-0000-0000-0000-000000000000" + name: "Jane Doe" + type: user + name: "Critical findings due in 7 days" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: due_date_rules + schema: + $ref: "#/components/schemas/DueDateRuleResponse" + description: Successfully updated the due date rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Update a due date rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 143 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/mute_rules: + get: + description: Get all mute rules for the current organization. + operationId: ListSecurityFindingsAutomationMuteRules + parameters: + - description: The number of rules per page. Maximum is 1000. + in: query + name: page[size] + required: false + schema: + default: 1000 + example: 10 + format: int64 + maximum: 1000 + minimum: 1 + type: integer + - description: The page number to return. + in: query + name: page[number] + required: false + schema: + default: 0 + example: 0 + format: int64 + minimum: 0 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + 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:dev team:platform @severity:low" + id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + links: + first: "/api/v2/security/findings/automation/mute_rules?page[size]=1000&page[number]=0" + last: "/api/v2/security/findings/automation/mute_rules?page[size]=1000&page[number]=0" + meta: + page: + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/MuteRulesResponse" + description: Successfully retrieved the list of mute rules + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get all mute rules + tags: + - Security Monitoring + x-menu-order: 133 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new mute rule for the current organization. + operationId: CreateSecurityFindingsAutomationMuteRule + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + expire_at: 4070908800000 + reason: risk_accepted + reason_description: "Accepted for dev environments only" + enabled: true + name: "Mute accepted risks in dev" + rule: + finding_types: + - misconfiguration + query: "env:dev team:platform @severity:low" + type: mute_rules + schema: + $ref: "#/components/schemas/MuteRuleCreateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + 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:dev team:platform @severity:low" + id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + schema: + $ref: "#/components/schemas/MuteRuleResponse" + description: Successfully created the mute rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Create a mute rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 134 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/mute_rules/reorder: + post: + description: Reorder the list of mute rules for the current organization. + operationId: ReorderSecurityFindingsAutomationMuteRules + requestBody: + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + - id: "11111111-1111-1111-1111-111111111111" + type: mute_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + - id: "11111111-1111-1111-1111-111111111111" + type: mute_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + description: Successfully reordered the mute rules + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Reorder mute rules + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 135 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/mute_rules/{rule_id}: + delete: + description: Delete an existing mute rule by ID. + operationId: DeleteSecurityFindingsAutomationMuteRule + parameters: + - description: The ID of the mute rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "204": + description: "Rule successfully deleted." + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Delete a mute rule + tags: + - Security Monitoring + x-menu-order: 138 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get the details of a mute rule by ID. + operationId: GetSecurityFindingsAutomationMuteRule + parameters: + - description: The ID of the mute rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + 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:dev team:platform @severity:low" + id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + schema: + $ref: "#/components/schemas/MuteRuleResponse" + description: Successfully retrieved the mute rule + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get a mute rule + tags: + - Security Monitoring + x-menu-order: 136 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Update an existing mute rule by ID. + operationId: UpdateSecurityFindingsAutomationMuteRule + parameters: + - description: The ID of the mute rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + reason: risk_accepted + enabled: false + name: "Mute accepted risks in dev" + rule: + finding_types: + - misconfiguration + query: "env:dev" + type: mute_rules + schema: + $ref: "#/components/schemas/MuteRuleUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + reason: risk_accepted + created_at: 1722439510282 + created_by: + id: "00000000-0000-0000-0000-000000000000" + name: "Jane Doe" + type: user + enabled: false + modified_at: 1722439510999 + 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:dev" + id: "00000000-0000-0000-0000-000000000000" + type: mute_rules + schema: + $ref: "#/components/schemas/MuteRuleResponse" + description: Successfully updated the mute rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Update a mute rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 137 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/ticket_creation_rules: + get: + description: Get all ticket creation rules for the current organization. + operationId: ListSecurityFindingsAutomationTicketCreationRules + parameters: + - description: The number of rules per page. Maximum is 1000. + in: query + name: page[size] + required: false + schema: + default: 1000 + example: 10 + format: int64 + maximum: 1000 + minimum: 1 + type: integer + - description: The page number to return. + in: query + name: page[number] + required: false + schema: + default: 0 + example: 0 + format: int64 + minimum: 0 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + action: + max_tickets_per_day: 100 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + 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: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + links: + first: "/api/v2/security/findings/automation/ticket_creation_rules?page[size]=1000&page[number]=0" + last: "/api/v2/security/findings/automation/ticket_creation_rules?page[size]=1000&page[number]=0" + meta: + page: + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/TicketCreationRulesResponse" + description: Successfully retrieved the list of ticket creation rules + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get all ticket creation rules + tags: + - Security Monitoring + x-menu-order: 145 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new ticket creation rule for the current organization. + operationId: CreateSecurityFindingsAutomationTicketCreationRule + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + max_tickets_per_day: 100 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + enabled: true + name: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/TicketCreationRuleCreateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + max_tickets_per_day: 100 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + 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: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/TicketCreationRuleResponse" + description: Successfully created the ticket creation rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Create a ticket creation rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 146 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/ticket_creation_rules/reorder: + post: + description: Reorder the list of ticket creation rules for the current organization. + operationId: ReorderSecurityFindingsAutomationTicketCreationRules + requestBody: + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + - id: "11111111-1111-1111-1111-111111111111" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + - id: "11111111-1111-1111-1111-111111111111" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/SecurityAutomationRuleReorderRequest" + description: Successfully reordered the ticket creation rules + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Reorder ticket creation rules + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 147 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/security/findings/automation/ticket_creation_rules/{rule_id}: + delete: + description: Delete an existing ticket creation rule by ID. + operationId: DeleteSecurityFindingsAutomationTicketCreationRule + parameters: + - description: The ID of the ticket creation rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "204": + description: "Rule successfully deleted." + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Delete a ticket creation rule + tags: + - Security Monitoring + x-menu-order: 150 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get the details of a ticket creation rule by ID. + operationId: GetSecurityFindingsAutomationTicketCreationRule + parameters: + - description: The ID of the ticket creation rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + max_tickets_per_day: 100 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + 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: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/TicketCreationRuleResponse" + description: Successfully retrieved the ticket creation rule + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get a ticket creation rule + tags: + - Security Monitoring + x-menu-order: 148 + x-permission: + operator: OR + permissions: + - security_pipelines_read + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Update an existing ticket creation rule by ID. + operationId: UpdateSecurityFindingsAutomationTicketCreationRule + parameters: + - description: The ID of the ticket creation rule. + in: path + name: rule_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + format: uuid + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + max_tickets_per_day: 50 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + enabled: true + name: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/TicketCreationRuleUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action: + max_tickets_per_day: 50 + project_id: "11111111-1111-1111-1111-111111111111" + target: jira + created_at: 1722439510282 + created_by: + id: "00000000-0000-0000-0000-000000000000" + name: "Jane Doe" + type: user + enabled: true + modified_at: 1722439510999 + modified_by: + id: "00000000-0000-0000-0000-000000000000" + name: "Jane Doe" + type: user + name: "Auto-create Jira tickets for critical findings" + rule: + finding_types: + - misconfiguration + query: "env:prod" + id: "00000000-0000-0000-0000-000000000000" + type: ticket_creation_rules + schema: + $ref: "#/components/schemas/TicketCreationRuleResponse" + description: Successfully updated the ticket creation rule + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Update a ticket creation rule + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-menu-order: 149 + x-permission: + operator: OR + permissions: + - security_pipelines_write + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/security/findings/cases: delete: description: >- diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 9f099f1329c..fcd7451ada7 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -4851,6 +4851,96 @@ "request_description": "", "request_schema_description": "Request to assign or unassign security findings." }, + "ListSecurityFindingsAutomationDueDateRules": { + "description": "Get all due date rules for the current organization.", + "summary": "Get all due date rules" + }, + "CreateSecurityFindingsAutomationDueDateRule": { + "description": "Create a new due date rule for the current organization.", + "summary": "Create a due date rule", + "request_description": "", + "request_schema_description": "The body of a due date rule create request." + }, + "ReorderSecurityFindingsAutomationDueDateRules": { + "description": "Reorder the list of due date rules for the current organization.", + "summary": "Reorder due date rules", + "request_description": "", + "request_schema_description": "The body of the reorder request." + }, + "DeleteSecurityFindingsAutomationDueDateRule": { + "description": "Delete an existing due date rule by ID.", + "summary": "Delete a due date rule" + }, + "GetSecurityFindingsAutomationDueDateRule": { + "description": "Get the details of a due date rule by ID.", + "summary": "Get a due date rule" + }, + "UpdateSecurityFindingsAutomationDueDateRule": { + "description": "Update an existing due date rule by ID.", + "summary": "Update a due date rule", + "request_description": "", + "request_schema_description": "The body of a due date rule update request." + }, + "ListSecurityFindingsAutomationMuteRules": { + "description": "Get all mute rules for the current organization.", + "summary": "Get all mute rules" + }, + "CreateSecurityFindingsAutomationMuteRule": { + "description": "Create a new mute rule for the current organization.", + "summary": "Create a mute rule", + "request_description": "", + "request_schema_description": "The body of a mute rule create request." + }, + "ReorderSecurityFindingsAutomationMuteRules": { + "description": "Reorder the list of mute rules for the current organization.", + "summary": "Reorder mute rules", + "request_description": "", + "request_schema_description": "The body of the reorder request." + }, + "DeleteSecurityFindingsAutomationMuteRule": { + "description": "Delete an existing mute rule by ID.", + "summary": "Delete a mute rule" + }, + "GetSecurityFindingsAutomationMuteRule": { + "description": "Get the details of a mute rule by ID.", + "summary": "Get a mute rule" + }, + "UpdateSecurityFindingsAutomationMuteRule": { + "description": "Update an existing mute rule by ID.", + "summary": "Update a mute rule", + "request_description": "", + "request_schema_description": "The body of a mute rule update request." + }, + "ListSecurityFindingsAutomationTicketCreationRules": { + "description": "Get all ticket creation rules for the current organization.", + "summary": "Get all ticket creation rules" + }, + "CreateSecurityFindingsAutomationTicketCreationRule": { + "description": "Create a new ticket creation rule for the current organization.", + "summary": "Create a ticket creation rule", + "request_description": "", + "request_schema_description": "The body of a ticket creation rule create request." + }, + "ReorderSecurityFindingsAutomationTicketCreationRules": { + "description": "Reorder the list of ticket creation rules for the current organization.", + "summary": "Reorder ticket creation rules", + "request_description": "", + "request_schema_description": "The body of the reorder request." + }, + "DeleteSecurityFindingsAutomationTicketCreationRule": { + "description": "Delete an existing ticket creation rule by ID.", + "summary": "Delete a ticket creation rule" + }, + "GetSecurityFindingsAutomationTicketCreationRule": { + "description": "Get the details of a ticket creation rule by ID.", + "summary": "Get a ticket creation rule" + }, + "UpdateSecurityFindingsAutomationTicketCreationRule": { + "description": "Update an existing ticket creation rule by ID.", + "summary": "Update a ticket creation rule", + "request_description": "", + "request_schema_description": "The body of a ticket creation rule update request." + }, "DetachCase": { "description": "Detach security findings from their case.\nThis operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.", "summary": "Detach security findings from their case",