Skip to content

Add API spec for severity modifiers automation pipelines #3837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add API spec for severity modifiers automation pipelines #3837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
689 changes: 689 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42711,6 +42711,132 @@ datadog\_api\_client.v2.model.session\_id\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_action module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_action
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_attributes\_create module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_attributes_create
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_attributes\_response module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_create\_request module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_data\_create module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_data_create
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_data\_response module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_data_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_reorder\_item module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_reorder_item
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_reorder\_request module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_reorder_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_response module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_set\_action module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_set_action
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_set\_action\_type module
--------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_set_action_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_shift\_action module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_shift_action
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_shift\_action\_type module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_shift_action_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rule\_update\_request module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rule_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_rules\_response module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_rules_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_severity module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_severity
:members:
:show-inheritance:

datadog\_api\_client.v2.model.severity\_modifier\_severity\_delta module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.severity_modifier_severity_delta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.shared\_dashboard\_global\_time module
--------------------------------------------------------------------

Expand Down
44 changes: 44 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityFindingsAutomationSeverityModifierRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
"""
Create a severity modifier rule returns "Successfully created the severity modifier rule" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.automation_rule_scope import AutomationRuleScope
from datadog_api_client.v2.model.security_finding_type import SecurityFindingType
from datadog_api_client.v2.model.severity_modifier_rule_attributes_create import SeverityModifierRuleAttributesCreate
from datadog_api_client.v2.model.severity_modifier_rule_create_request import SeverityModifierRuleCreateRequest
from datadog_api_client.v2.model.severity_modifier_rule_data_create import SeverityModifierRuleDataCreate
from datadog_api_client.v2.model.severity_modifier_rule_set_action import SeverityModifierRuleSetAction
from datadog_api_client.v2.model.severity_modifier_rule_set_action_type import SeverityModifierRuleSetActionType
from datadog_api_client.v2.model.severity_modifier_rule_type import SeverityModifierRuleType
from datadog_api_client.v2.model.severity_modifier_severity import SeverityModifierSeverity

body = SeverityModifierRuleCreateRequest(
data=SeverityModifierRuleDataCreate(
attributes=SeverityModifierRuleAttributesCreate(
action=SeverityModifierRuleSetAction(
description="Lower severity for dev environment noise",
severity=SeverityModifierSeverity.LOW,
type=SeverityModifierRuleSetActionType.SET,
),
enabled=True,
name="Downgrade misconfigurations in dev",
rule=AutomationRuleScope(
finding_types=[
SecurityFindingType.MISCONFIGURATION,
],
query="env:prod team:platform",
),
),
type=SeverityModifierRuleType.SEVERITY_MODIFIER_RULES,
),
)

configuration = Configuration()
configuration.unstable_operations["create_security_findings_automation_severity_modifier_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.create_security_findings_automation_severity_modifier_rule(body=body)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/security-monitoring/DeleteSecurityFindingsAutomationSeverityModifierRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Delete a severity modifier rule returns "Rule successfully deleted." response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

# there is a valid "valid_severity_modifier_rule" in the system
VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["delete_security_findings_automation_severity_modifier_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.delete_security_findings_automation_severity_modifier_rule(
rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
)
20 changes: 20 additions & 0 deletions examples/v2/security-monitoring/GetSecurityFindingsAutomationSeverityModifierRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

# there is a valid "valid_severity_modifier_rule" in the system
VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["get_security_findings_automation_severity_modifier_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_findings_automation_severity_modifier_rule(
rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/security-monitoring/ListSecurityFindingsAutomationSeverityModifierRules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Get all severity modifier rules returns "Successfully retrieved the list of severity modifier rules" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

configuration = Configuration()
configuration.unstable_operations["list_security_findings_automation_severity_modifier_rules"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.list_security_findings_automation_severity_modifier_rules()

print(response)
30 changes: 30 additions & 0 deletions examples/v2/security-monitoring/ReorderSecurityFindingsAutomationSeverityModifierRules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""
Reorder severity modifier rules returns "Successfully reordered the severity modifier rules" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.severity_modifier_rule_reorder_item import SeverityModifierRuleReorderItem
from datadog_api_client.v2.model.severity_modifier_rule_reorder_request import SeverityModifierRuleReorderRequest
from datadog_api_client.v2.model.severity_modifier_rule_type import SeverityModifierRuleType

# there is a valid "valid_severity_modifier_rule" in the system
VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]

body = SeverityModifierRuleReorderRequest(
data=[
SeverityModifierRuleReorderItem(
id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
type=SeverityModifierRuleType.SEVERITY_MODIFIER_RULES,
),
],
)

configuration = Configuration()
configuration.unstable_operations["reorder_security_findings_automation_severity_modifier_rules"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.reorder_security_findings_automation_severity_modifier_rules(body=body)

print(response)
47 changes: 47 additions & 0 deletions examples/v2/security-monitoring/UpdateSecurityFindingsAutomationSeverityModifierRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
"""
Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.automation_rule_scope import AutomationRuleScope
from datadog_api_client.v2.model.security_finding_type import SecurityFindingType
from datadog_api_client.v2.model.severity_modifier_rule_attributes_create import SeverityModifierRuleAttributesCreate
from datadog_api_client.v2.model.severity_modifier_rule_data_create import SeverityModifierRuleDataCreate
from datadog_api_client.v2.model.severity_modifier_rule_set_action import SeverityModifierRuleSetAction
from datadog_api_client.v2.model.severity_modifier_rule_set_action_type import SeverityModifierRuleSetActionType
from datadog_api_client.v2.model.severity_modifier_rule_type import SeverityModifierRuleType
from datadog_api_client.v2.model.severity_modifier_rule_update_request import SeverityModifierRuleUpdateRequest
from datadog_api_client.v2.model.severity_modifier_severity import SeverityModifierSeverity
from uuid import UUID

body = SeverityModifierRuleUpdateRequest(
data=SeverityModifierRuleDataCreate(
attributes=SeverityModifierRuleAttributesCreate(
action=SeverityModifierRuleSetAction(
description="Lower severity for dev environment noise",
severity=SeverityModifierSeverity.LOW,
type=SeverityModifierRuleSetActionType.SET,
),
enabled=True,
name="Downgrade misconfigurations in dev",
rule=AutomationRuleScope(
finding_types=[
SecurityFindingType.MISCONFIGURATION,
],
query="env:prod team:platform",
),
),
type=SeverityModifierRuleType.SEVERITY_MODIFIER_RULES,
),
)

configuration = Configuration()
configuration.unstable_operations["update_security_findings_automation_severity_modifier_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.update_security_findings_automation_severity_modifier_rule(
rule_id=UUID("00000000-0000-0000-0000-000000000000"), body=body
)

print(response)
6 changes: 6 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ def __init__(
"v2.create_sample_log_generation_subscription": False,
"v2.create_security_findings_automation_due_date_rule": False,
"v2.create_security_findings_automation_mute_rule": False,
"v2.create_security_findings_automation_severity_modifier_rule": False,
"v2.create_security_findings_automation_ticket_creation_rule": False,
"v2.create_security_monitoring_dataset": False,
"v2.create_security_monitoring_integration_config": False,
Expand All @@ -384,6 +385,7 @@ def __init__(
"v2.delete_sample_log_generation_subscription": False,
"v2.delete_security_findings_automation_due_date_rule": False,
"v2.delete_security_findings_automation_mute_rule": False,
"v2.delete_security_findings_automation_severity_modifier_rule": False,
"v2.delete_security_findings_automation_ticket_creation_rule": False,
"v2.delete_security_monitoring_dataset": False,
"v2.delete_security_monitoring_integration_config": False,
Expand All @@ -398,6 +400,7 @@ def __init__(
"v2.get_secrets_rules": False,
"v2.get_security_findings_automation_due_date_rule": False,
"v2.get_security_findings_automation_mute_rule": False,
"v2.get_security_findings_automation_severity_modifier_rule": False,
"v2.get_security_findings_automation_ticket_creation_rule": False,
"v2.get_security_monitoring_dataset": False,
"v2.get_security_monitoring_dataset_by_version": False,
Expand All @@ -420,6 +423,7 @@ def __init__(
"v2.list_scanned_assets_metadata": False,
"v2.list_security_findings_automation_due_date_rules": False,
"v2.list_security_findings_automation_mute_rules": False,
"v2.list_security_findings_automation_severity_modifier_rules": False,
"v2.list_security_findings_automation_ticket_creation_rules": False,
"v2.list_security_monitoring_datasets": False,
"v2.list_security_monitoring_histsignals": False,
Expand All @@ -429,13 +433,15 @@ def __init__(
"v2.list_vulnerable_assets": False,
"v2.reorder_security_findings_automation_due_date_rules": False,
"v2.reorder_security_findings_automation_mute_rules": False,
"v2.reorder_security_findings_automation_severity_modifier_rules": False,
"v2.reorder_security_findings_automation_ticket_creation_rules": False,
"v2.restore_security_monitoring_rule": False,
"v2.run_historical_job": False,
"v2.search_security_monitoring_histsignals": False,
"v2.update_findings_assignee": False,
"v2.update_security_findings_automation_due_date_rule": False,
"v2.update_security_findings_automation_mute_rule": False,
"v2.update_security_findings_automation_severity_modifier_rule": False,
"v2.update_security_findings_automation_ticket_creation_rule": False,
"v2.update_security_monitoring_dataset": False,
"v2.update_security_monitoring_integration_config": False,
Expand Down
Loading
Loading