Skip to content

Add custom/rulesets endpoints #3372

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 #3372

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.

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

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.CustomRuleDataType;
import com.datadog.api.client.v2.model.CustomRuleRequest;
import com.datadog.api.client.v2.model.CustomRuleRequestData;
import com.datadog.api.client.v2.model.CustomRuleRequestDataAttributes;
import com.datadog.api.client.v2.model.CustomRuleResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createCustomRule", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

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

try {
CustomRuleResponse result = apiInstance.createCustomRule("ruleset_name", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#createCustomRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
73 changes: 73 additions & 0 deletions examples/v2/static-analysis/CreateCustomRuleRevision.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// Create Custom Rule Revision returns "Successfully created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.Argument;
import com.datadog.api.client.v2.model.CustomRuleRevisionAttributes;
import com.datadog.api.client.v2.model.CustomRuleRevisionAttributesCategory;
import com.datadog.api.client.v2.model.CustomRuleRevisionAttributesSeverity;
import com.datadog.api.client.v2.model.CustomRuleRevisionDataType;
import com.datadog.api.client.v2.model.CustomRuleRevisionRequest;
import com.datadog.api.client.v2.model.CustomRuleRevisionRequestData;
import com.datadog.api.client.v2.model.CustomRuleRevisionTest;
import com.datadog.api.client.v2.model.Language;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createCustomRuleRevision", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

CustomRuleRevisionRequest body =
new CustomRuleRevisionRequest()
.data(
new CustomRuleRevisionRequestData()
.attributes(
new CustomRuleRevisionAttributes()
.arguments(
Collections.singletonList(
new Argument()
.description("YXJndW1lbnQgZGVzY3JpcHRpb24=")
.name("YXJndW1lbnRfbmFtZQ==")))
.category(CustomRuleRevisionAttributesCategory.SECURITY)
.checksum(
"8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99")
.code("Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==")
.createdAt(OffsetDateTime.parse("2026-01-09T13:00:57.473141Z"))
.createdBy("foobarbaz")
.creationMessage("Initial revision")
.cve("CVE-2024-1234")
.cwe("CWE-79")
.description("bG9uZyBkZXNjcmlwdGlvbg==")
.documentationUrl("https://docs.example.com/rules/my-rule")
.isPublished(false)
.isTesting(false)
.language(Language.PYTHON)
.severity(CustomRuleRevisionAttributesSeverity.ERROR)
.shortDescription("c2hvcnQgZGVzY3JpcHRpb24=")
.shouldUseAiFix(false)
.tags(Arrays.asList("security", "custom"))
.tests(
Collections.singletonList(
new CustomRuleRevisionTest()
.annotationCount(1L)
.code("Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==")
.filename("test.yaml")))
.treeSitterQuery("Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ=="))
.type(CustomRuleRevisionDataType.CUSTOM_RULE_REVISION));

try {
apiInstance.createCustomRuleRevision("ruleset_name", "rule_name", body);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#createCustomRuleRevision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
23 changes: 23 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Delete Custom Rule returns "Successfully deleted" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteCustomRule", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
apiInstance.deleteCustomRule("ruleset_name", "rule_name");
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#deleteCustomRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
23 changes: 23 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRuleset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Delete Custom Ruleset returns "Successfully deleted" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteCustomRuleset", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
apiInstance.deleteCustomRuleset("ruleset_name");
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#deleteCustomRuleset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/static-analysis/ListCustomRuleRevisions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// List Custom Rule Revisions returns "Successful response" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.CustomRuleRevisionsResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.listCustomRuleRevisions", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
CustomRuleRevisionsResponse result =
apiInstance.listCustomRuleRevisions("ruleset_name", "rule_name");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#listCustomRuleRevisions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
34 changes: 34 additions & 0 deletions examples/v2/static-analysis/RevertCustomRuleRevision.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Revert Custom Rule Revision returns "Successfully reverted" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.RevertCustomRuleRevisionDataType;
import com.datadog.api.client.v2.model.RevertCustomRuleRevisionRequest;
import com.datadog.api.client.v2.model.RevertCustomRuleRevisionRequestData;
import com.datadog.api.client.v2.model.RevertCustomRuleRevisionRequestDataAttributes;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.revertCustomRuleRevision", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

RevertCustomRuleRevisionRequest body =
new RevertCustomRuleRevisionRequest()
.data(
new RevertCustomRuleRevisionRequestData()
.attributes(new RevertCustomRuleRevisionRequestDataAttributes())
.type(RevertCustomRuleRevisionDataType.REVERT_CUSTOM_RULE_REVISION_REQUEST));

try {
apiInstance.revertCustomRuleRevision("ruleset_name", "rule_name", body);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#revertCustomRuleRevision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/static-analysis/ShowCustomRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Show Custom Rule returns "Successful response" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.CustomRuleResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.showCustomRule", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
CustomRuleResponse result = apiInstance.showCustomRule("ruleset_name", "rule_name");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#showCustomRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/static-analysis/ShowCustomRuleRevision.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Show Custom Rule Revision returns "Successful response" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.CustomRuleRevisionResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.showCustomRuleRevision", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
CustomRuleRevisionResponse result =
apiInstance.showCustomRuleRevision("ruleset_name", "rule_name", "id");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#showCustomRuleRevision");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/static-analysis/ShowCustomRuleset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Show Custom Ruleset returns "Successful response" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StaticAnalysisApi;
import com.datadog.api.client.v2.model.CustomRulesetResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.showCustomRuleset", true);
StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient);

try {
CustomRulesetResponse result = apiInstance.showCustomRuleset("ruleset_name");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StaticAnalysisApi#showCustomRuleset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading