Skip to content

Add custom/rulesets endpoints #3067

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 custom/rulesets endpoints #3067

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

Large diffs are not rendered by default.

210 changes: 210 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 @@ -1124,6 +1124,13 @@ datadog\_api\_client.v2.model.arbitrary\_rule\_response\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.argument module
---------------------------------------------

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

datadog\_api\_client.v2.model.asana\_access\_token module
---------------------------------------------------------

Expand Down Expand Up @@ -6486,6 +6493,174 @@ datadog\_api\_client.v2.model.custom\_framework\_without\_requirements module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.custom\_rule module
-------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_data\_type module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_request module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_request\_data module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_request\_data\_attributes module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_response module
-----------------------------------------------------------

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

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

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

datadog\_api\_client.v2.model.custom\_rule\_revision module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes\_category module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes\_severity module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_data\_type module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_request module
--------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_request\_data module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_response module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revision\_test module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_rule\_revisions\_response module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset module
----------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_attributes module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_data\_type module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_request module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_request\_data module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_request\_data\_attributes module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_ruleset\_response module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.cvss module
-----------------------------------------

Expand Down Expand Up @@ -12800,6 +12975,13 @@ datadog\_api\_client.v2.model.kind\_response\_meta module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.language module
---------------------------------------------

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

datadog\_api\_client.v2.model.launch\_darkly\_api\_key module
-------------------------------------------------------------

Expand Down Expand Up @@ -19408,6 +19590,34 @@ datadog\_api\_client.v2.model.retry\_strategy\_linear module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_data\_type module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request\_data module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request\_data\_attributes module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.role module
-----------------------------------------

Expand Down
25 changes: 25 additions & 0 deletions examples/v2/static-analysis/CreateCustomRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
"""
Create Custom Rule returns "Successfully created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
from datadog_api_client.v2.model.custom_rule_data_type import CustomRuleDataType
from datadog_api_client.v2.model.custom_rule_request import CustomRuleRequest
from datadog_api_client.v2.model.custom_rule_request_data import CustomRuleRequestData
from datadog_api_client.v2.model.custom_rule_request_data_attributes import CustomRuleRequestDataAttributes

body = CustomRuleRequest(
data=CustomRuleRequestData(
attributes=CustomRuleRequestDataAttributes(),
type=CustomRuleDataType.CUSTOM_RULE,
),
)

configuration = Configuration()
configuration.unstable_operations["create_custom_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = StaticAnalysisApi(api_client)
response = api_instance.create_custom_rule(ruleset_name="ruleset_name", body=body)

print(response)
65 changes: 65 additions & 0 deletions examples/v2/static-analysis/CreateCustomRuleRevision.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
"""
Create Custom Rule Revision returns "Successfully created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
from datadog_api_client.v2.model.argument import Argument
from datadog_api_client.v2.model.custom_rule_revision_attributes import CustomRuleRevisionAttributes
from datadog_api_client.v2.model.custom_rule_revision_attributes_category import CustomRuleRevisionAttributesCategory
from datadog_api_client.v2.model.custom_rule_revision_attributes_severity import CustomRuleRevisionAttributesSeverity
from datadog_api_client.v2.model.custom_rule_revision_data_type import CustomRuleRevisionDataType
from datadog_api_client.v2.model.custom_rule_revision_request import CustomRuleRevisionRequest
from datadog_api_client.v2.model.custom_rule_revision_request_data import CustomRuleRevisionRequestData
from datadog_api_client.v2.model.custom_rule_revision_test import CustomRuleRevisionTest
from datadog_api_client.v2.model.language import Language
from datetime import datetime
from dateutil.tz import tzutc

body = CustomRuleRevisionRequest(
data=CustomRuleRevisionRequestData(
attributes=CustomRuleRevisionAttributes(
arguments=[
Argument(
description="YXJndW1lbnQgZGVzY3JpcHRpb24=",
name="YXJndW1lbnRfbmFtZQ==",
),
],
category=CustomRuleRevisionAttributesCategory.SECURITY,
checksum="8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99",
code="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
created_at=datetime(2026, 1, 9, 13, 0, 57, 473141, tzinfo=tzutc()),
created_by="foobarbaz",
creation_message="Initial revision",
cve="CVE-2024-1234",
cwe="CWE-79",
description="bG9uZyBkZXNjcmlwdGlvbg==",
documentation_url="https://docs.example.com/rules/my-rule",
is_published=False,
is_testing=False,
language=Language.PYTHON,
severity=CustomRuleRevisionAttributesSeverity.ERROR,
short_description="c2hvcnQgZGVzY3JpcHRpb24=",
should_use_ai_fix=False,
tags=[
"security",
"custom",
],
tests=[
CustomRuleRevisionTest(
annotation_count=1,
code="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
filename="test.yaml",
),
],
tree_sitter_query="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
),
type=CustomRuleRevisionDataType.CUSTOM_RULE_REVISION,
),
)

configuration = Configuration()
configuration.unstable_operations["create_custom_rule_revision"] = True
with ApiClient(configuration) as api_client:
api_instance = StaticAnalysisApi(api_client)
api_instance.create_custom_rule_revision(ruleset_name="ruleset_name", rule_name="rule_name", body=body)
15 changes: 15 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete Custom Rule returns "Successfully deleted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi

configuration = Configuration()
configuration.unstable_operations["delete_custom_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = StaticAnalysisApi(api_client)
api_instance.delete_custom_rule(
ruleset_name="ruleset_name",
rule_name="rule_name",
)
14 changes: 14 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRuleset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Delete Custom Ruleset returns "Successfully deleted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi

configuration = Configuration()
configuration.unstable_operations["delete_custom_ruleset"] = True
with ApiClient(configuration) as api_client:
api_instance = StaticAnalysisApi(api_client)
api_instance.delete_custom_ruleset(
ruleset_name="ruleset_name",
)
17 changes: 17 additions & 0 deletions examples/v2/static-analysis/ListCustomRuleRevisions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
List Custom Rule Revisions returns "Successful response" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi

configuration = Configuration()
configuration.unstable_operations["list_custom_rule_revisions"] = True
with ApiClient(configuration) as api_client:
api_instance = StaticAnalysisApi(api_client)
response = api_instance.list_custom_rule_revisions(
ruleset_name="ruleset_name",
rule_name="rule_name",
)

print(response)
Loading