Skip to content

Add Critical Assets specs to security_monitoring feature #3065

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 Critical Assets specs to security_monitoring feature #3065

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
417 changes: 417 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

84 changes: 84 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 @@ -21382,6 +21382,90 @@ datadog\_api\_client.v2.model.security\_findings\_status module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_attributes module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_create\_attributes module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_create\_data module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_create\_request module
-------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_response module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_severity module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_type module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_update\_attributes module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_update\_data module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_asset\_update\_request module
-------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_critical\_assets\_response module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_filter module
-----------------------------------------------------------------

Expand Down
41 changes: 41 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityMonitoringCriticalAsset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
"""
Create a critical asset returns "OK" 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.security_monitoring_critical_asset_create_attributes import (
SecurityMonitoringCriticalAssetCreateAttributes,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_create_data import (
SecurityMonitoringCriticalAssetCreateData,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_create_request import (
SecurityMonitoringCriticalAssetCreateRequest,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_severity import (
SecurityMonitoringCriticalAssetSeverity,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_type import SecurityMonitoringCriticalAssetType

body = SecurityMonitoringCriticalAssetCreateRequest(
data=SecurityMonitoringCriticalAssetCreateData(
type=SecurityMonitoringCriticalAssetType.CRITICAL_ASSETS,
attributes=SecurityMonitoringCriticalAssetCreateAttributes(
query="host:examplesecuritymonitoring",
rule_query="type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail",
severity=SecurityMonitoringCriticalAssetSeverity.DECREASE,
tags=[
"team:security",
"env:test",
],
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.create_security_monitoring_critical_asset(body=body)

print(response)
17 changes: 17 additions & 0 deletions examples/v2/security-monitoring/DeleteSecurityMonitoringCriticalAsset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Delete a critical asset returns "OK" 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 "critical_asset" in the system
CRITICAL_ASSET_DATA_ID = environ["CRITICAL_ASSET_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.delete_security_monitoring_critical_asset(
critical_asset_id=CRITICAL_ASSET_DATA_ID,
)
19 changes: 19 additions & 0 deletions examples/v2/security-monitoring/GetCriticalAssetsAffectingRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
Get critical assets affecting a specific rule returns "OK" 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 "security_rule" in the system
SECURITY_RULE_ID = environ["SECURITY_RULE_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_critical_assets_affecting_rule(
rule_id=SECURITY_RULE_ID,
)

print(response)
19 changes: 19 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringCriticalAsset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
Get a critical asset returns "OK" 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 "critical_asset" in the system
CRITICAL_ASSET_DATA_ID = environ["CRITICAL_ASSET_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_monitoring_critical_asset(
critical_asset_id=CRITICAL_ASSET_DATA_ID,
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/security-monitoring/ListSecurityMonitoringCriticalAssets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
Get all critical assets returns "OK" response
"""

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

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.list_security_monitoring_critical_assets()

print(response)
48 changes: 48 additions & 0 deletions examples/v2/security-monitoring/UpdateSecurityMonitoringCriticalAsset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
"""
Update a critical asset returns "OK" 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.security_monitoring_critical_asset_severity import (
SecurityMonitoringCriticalAssetSeverity,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_type import SecurityMonitoringCriticalAssetType
from datadog_api_client.v2.model.security_monitoring_critical_asset_update_attributes import (
SecurityMonitoringCriticalAssetUpdateAttributes,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_update_data import (
SecurityMonitoringCriticalAssetUpdateData,
)
from datadog_api_client.v2.model.security_monitoring_critical_asset_update_request import (
SecurityMonitoringCriticalAssetUpdateRequest,
)

# there is a valid "critical_asset" in the system
CRITICAL_ASSET_DATA_ID = environ["CRITICAL_ASSET_DATA_ID"]

body = SecurityMonitoringCriticalAssetUpdateRequest(
data=SecurityMonitoringCriticalAssetUpdateData(
type=SecurityMonitoringCriticalAssetType.CRITICAL_ASSETS,
attributes=SecurityMonitoringCriticalAssetUpdateAttributes(
enabled=False,
query="no:alert",
rule_query="type:(log_detection OR signal_correlation OR workload_security OR application_security) ruleId:djg-ktx-ipq",
severity=SecurityMonitoringCriticalAssetSeverity.DECREASE,
tags=[
"env:production",
],
version=1,
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.update_security_monitoring_critical_asset(
critical_asset_id=CRITICAL_ASSET_DATA_ID, body=body
)

print(response)
Loading