Skip to content

Add API spec for severity modifiers automation pipelines #4149

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

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.

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

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.AutomationRuleScope;
import com.datadog.api.client.v2.model.SecurityFindingType;
import com.datadog.api.client.v2.model.SeverityModifierRuleAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleAttributesCreate;
import com.datadog.api.client.v2.model.SeverityModifierRuleCreateRequest;
import com.datadog.api.client.v2.model.SeverityModifierRuleDataCreate;
import com.datadog.api.client.v2.model.SeverityModifierRuleResponse;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetActionType;
import com.datadog.api.client.v2.model.SeverityModifierRuleType;
import com.datadog.api.client.v2.model.SeverityModifierSeverity;
import java.util.Collections;

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

SeverityModifierRuleCreateRequest body =
new SeverityModifierRuleCreateRequest()
.data(
new SeverityModifierRuleDataCreate()
.attributes(
new SeverityModifierRuleAttributesCreate()
.action(
new SeverityModifierRuleAction(
new SeverityModifierRuleSetAction()
.description("Lower severity for dev environment noise")
.severity(SeverityModifierSeverity.LOW)
.type(SeverityModifierRuleSetActionType.SET)))
.enabled(true)
.name("Downgrade misconfigurations in dev")
.rule(
new AutomationRuleScope()
.findingTypes(
Collections.singletonList(
SecurityFindingType.MISCONFIGURATION))
.query("env:prod team:platform")))
.type(SeverityModifierRuleType.SEVERITY_MODIFIER_RULES));

try {
SeverityModifierRuleResponse result =
apiInstance.createSecurityFindingsAutomationSeverityModifierRule(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#createSecurityFindingsAutomationSeverityModifierRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
37 changes: 37 additions & 0 deletions examples/v2/security-monitoring/DeleteSecurityFindingsAutomationSeverityModifierRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Delete a severity modifier rule returns "Rule successfully deleted." response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import java.util.UUID;

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

// there is a valid "valid_severity_modifier_rule" in the system
UUID VALID_SEVERITY_MODIFIER_RULE_DATA_ID = null;
try {
VALID_SEVERITY_MODIFIER_RULE_DATA_ID =
UUID.fromString(System.getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
apiInstance.deleteSecurityFindingsAutomationSeverityModifierRule(
VALID_SEVERITY_MODIFIER_RULE_DATA_ID);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#deleteSecurityFindingsAutomationSeverityModifierRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
40 changes: 40 additions & 0 deletions examples/v2/security-monitoring/GetSecurityFindingsAutomationSeverityModifierRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.SeverityModifierRuleResponse;
import java.util.UUID;

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

// there is a valid "valid_severity_modifier_rule" in the system
UUID VALID_SEVERITY_MODIFIER_RULE_DATA_ID = null;
try {
VALID_SEVERITY_MODIFIER_RULE_DATA_ID =
UUID.fromString(System.getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
SeverityModifierRuleResponse result =
apiInstance.getSecurityFindingsAutomationSeverityModifierRule(
VALID_SEVERITY_MODIFIER_RULE_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#getSecurityFindingsAutomationSeverityModifierRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
30 changes: 30 additions & 0 deletions examples/v2/security-monitoring/ListSecurityFindingsAutomationSeverityModifierRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Get all severity modifier rules returns "Successfully retrieved the list of severity modifier
// rules" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.SeverityModifierRulesResponse;

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

try {
SeverityModifierRulesResponse result =
apiInstance.listSecurityFindingsAutomationSeverityModifierRules();
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#listSecurityFindingsAutomationSeverityModifierRules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
51 changes: 51 additions & 0 deletions examples/v2/security-monitoring/ReorderSecurityFindingsAutomationSeverityModifierRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Reorder severity modifier rules returns "Successfully reordered the severity modifier rules"
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.SeverityModifierRuleReorderItem;
import com.datadog.api.client.v2.model.SeverityModifierRuleReorderRequest;
import com.datadog.api.client.v2.model.SeverityModifierRuleType;
import java.util.Collections;
import java.util.UUID;

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

// there is a valid "valid_severity_modifier_rule" in the system
UUID VALID_SEVERITY_MODIFIER_RULE_DATA_ID = null;
try {
VALID_SEVERITY_MODIFIER_RULE_DATA_ID =
UUID.fromString(System.getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

SeverityModifierRuleReorderRequest body =
new SeverityModifierRuleReorderRequest()
.data(
Collections.singletonList(
new SeverityModifierRuleReorderItem()
.id(VALID_SEVERITY_MODIFIER_RULE_DATA_ID)
.type(SeverityModifierRuleType.SEVERITY_MODIFIER_RULES)));

try {
SeverityModifierRuleReorderRequest result =
apiInstance.reorderSecurityFindingsAutomationSeverityModifierRules(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#reorderSecurityFindingsAutomationSeverityModifierRules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
65 changes: 65 additions & 0 deletions examples/v2/security-monitoring/UpdateSecurityFindingsAutomationSeverityModifierRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// Update a severity modifier rule returns "Successfully updated the severity modifier rule"
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.AutomationRuleScope;
import com.datadog.api.client.v2.model.SecurityFindingType;
import com.datadog.api.client.v2.model.SeverityModifierRuleAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleAttributesCreate;
import com.datadog.api.client.v2.model.SeverityModifierRuleDataCreate;
import com.datadog.api.client.v2.model.SeverityModifierRuleResponse;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetActionType;
import com.datadog.api.client.v2.model.SeverityModifierRuleType;
import com.datadog.api.client.v2.model.SeverityModifierRuleUpdateRequest;
import com.datadog.api.client.v2.model.SeverityModifierSeverity;
import java.util.Collections;
import java.util.UUID;

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

SeverityModifierRuleUpdateRequest body =
new SeverityModifierRuleUpdateRequest()
.data(
new SeverityModifierRuleDataCreate()
.attributes(
new SeverityModifierRuleAttributesCreate()
.action(
new SeverityModifierRuleAction(
new SeverityModifierRuleSetAction()
.description("Lower severity for dev environment noise")
.severity(SeverityModifierSeverity.LOW)
.type(SeverityModifierRuleSetActionType.SET)))
.enabled(true)
.name("Downgrade misconfigurations in dev")
.rule(
new AutomationRuleScope()
.findingTypes(
Collections.singletonList(
SecurityFindingType.MISCONFIGURATION))
.query("env:prod team:platform")))
.type(SeverityModifierRuleType.SEVERITY_MODIFIER_RULES));

try {
SeverityModifierRuleResponse result =
apiInstance.updateSecurityFindingsAutomationSeverityModifierRule(
UUID.fromString("00000000-0000-0000-0000-000000000000"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#updateSecurityFindingsAutomationSeverityModifierRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
6 changes: 6 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -887,6 +887,7 @@ public class ApiClient {
put("v2.createSampleLogGenerationSubscription", false);
put("v2.createSecurityFindingsAutomationDueDateRule", false);
put("v2.createSecurityFindingsAutomationMuteRule", false);
put("v2.createSecurityFindingsAutomationSeverityModifierRule", false);
put("v2.createSecurityFindingsAutomationTicketCreationRule", false);
put("v2.createSecurityMonitoringDataset", false);
put("v2.createSecurityMonitoringIntegrationConfig", false);
Expand All @@ -898,6 +899,7 @@ public class ApiClient {
put("v2.deleteSampleLogGenerationSubscription", false);
put("v2.deleteSecurityFindingsAutomationDueDateRule", false);
put("v2.deleteSecurityFindingsAutomationMuteRule", false);
put("v2.deleteSecurityFindingsAutomationSeverityModifierRule", false);
put("v2.deleteSecurityFindingsAutomationTicketCreationRule", false);
put("v2.deleteSecurityMonitoringDataset", false);
put("v2.deleteSecurityMonitoringIntegrationConfig", false);
Expand All @@ -912,6 +914,7 @@ public class ApiClient {
put("v2.getSecretsRules", false);
put("v2.getSecurityFindingsAutomationDueDateRule", false);
put("v2.getSecurityFindingsAutomationMuteRule", false);
put("v2.getSecurityFindingsAutomationSeverityModifierRule", false);
put("v2.getSecurityFindingsAutomationTicketCreationRule", false);
put("v2.getSecurityMonitoringDataset", false);
put("v2.getSecurityMonitoringDatasetByVersion", false);
Expand All @@ -934,6 +937,7 @@ public class ApiClient {
put("v2.listScannedAssetsMetadata", false);
put("v2.listSecurityFindingsAutomationDueDateRules", false);
put("v2.listSecurityFindingsAutomationMuteRules", false);
put("v2.listSecurityFindingsAutomationSeverityModifierRules", false);
put("v2.listSecurityFindingsAutomationTicketCreationRules", false);
put("v2.listSecurityMonitoringDatasets", false);
put("v2.listSecurityMonitoringHistsignals", false);
Expand All @@ -943,13 +947,15 @@ public class ApiClient {
put("v2.listVulnerableAssets", false);
put("v2.reorderSecurityFindingsAutomationDueDateRules", false);
put("v2.reorderSecurityFindingsAutomationMuteRules", false);
put("v2.reorderSecurityFindingsAutomationSeverityModifierRules", false);
put("v2.reorderSecurityFindingsAutomationTicketCreationRules", false);
put("v2.restoreSecurityMonitoringRule", false);
put("v2.runHistoricalJob", false);
put("v2.searchSecurityMonitoringHistsignals", false);
put("v2.updateFindingsAssignee", false);
put("v2.updateSecurityFindingsAutomationDueDateRule", false);
put("v2.updateSecurityFindingsAutomationMuteRule", false);
put("v2.updateSecurityFindingsAutomationSeverityModifierRule", false);
put("v2.updateSecurityFindingsAutomationTicketCreationRule", false);
put("v2.updateSecurityMonitoringDataset", false);
put("v2.updateSecurityMonitoringIntegrationConfig", false);
Expand Down
Loading
Loading