Skip to content

Commit 4b74dfe

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Rename historical job API endpoints to threat hunting (#3215)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 671d8a8 commit 4b74dfe

File tree

61 files changed

+1468
-1375
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1468
-1375
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 200 additions & 199 deletions
Large diffs are not rendered by default.

‎examples/v2/security-monitoring/CancelThreatHuntingJob.java‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Cancel a threat hunting job returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
7+
public class Example {
8+
public static void main(String[] args) {
9+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
10+
defaultClient.setUnstableOperationEnabled("v2.cancelThreatHuntingJob", true);
11+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
12+
13+
try {
14+
apiInstance.cancelThreatHuntingJob("job_id");
15+
} catch (ApiException e) {
16+
System.err.println("Exception when calling SecurityMonitoringApi#cancelThreatHuntingJob");
17+
System.err.println("Status code: " + e.getCode());
18+
System.err.println("Reason: " + e.getResponseBody());
19+
System.err.println("Response headers: " + e.getResponseHeaders());
20+
e.printStackTrace();
21+
}
22+
}
23+
}

‎examples/v2/security-monitoring/CancelHistoricalJob.java‎ renamed to ‎examples/v2/security-monitoring/CancelThreatHuntingJob_1945505845.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
public class Example {
88
public static void main(String[] args) {
99
ApiClient defaultClient = ApiClient.getDefaultApiClient();
10-
defaultClient.setUnstableOperationEnabled("v2.cancelHistoricalJob", true);
11-
defaultClient.setUnstableOperationEnabled("v2.runHistoricalJob", true);
10+
defaultClient.setUnstableOperationEnabled("v2.cancelThreatHuntingJob", true);
11+
defaultClient.setUnstableOperationEnabled("v2.runThreatHuntingJob", true);
1212
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
1313

14-
// there is a valid "historical_job" in the system
15-
String HISTORICAL_JOB_DATA_ID = System.getenv("HISTORICAL_JOB_DATA_ID");
14+
// there is a valid "threat_hunting_job" in the system
15+
String THREAT_HUNTING_JOB_DATA_ID = System.getenv("THREAT_HUNTING_JOB_DATA_ID");
1616

1717
try {
18-
apiInstance.cancelHistoricalJob(HISTORICAL_JOB_DATA_ID);
18+
apiInstance.cancelThreatHuntingJob(THREAT_HUNTING_JOB_DATA_ID);
1919
} catch (ApiException e) {
20-
System.err.println("Exception when calling SecurityMonitoringApi#cancelHistoricalJob");
20+
System.err.println("Exception when calling SecurityMonitoringApi#cancelThreatHuntingJob");
2121
System.err.println("Status code: " + e.getCode());
2222
System.err.println("Reason: " + e.getResponseBody());
2323
System.err.println("Response headers: " + e.getResponseHeaders());

‎examples/v2/security-monitoring/DeleteHistoricalJob.java‎ renamed to ‎examples/v2/security-monitoring/DeleteThreatHuntingJob.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
public class Example {
88
public static void main(String[] args) {
99
ApiClient defaultClient = ApiClient.getDefaultApiClient();
10-
defaultClient.setUnstableOperationEnabled("v2.deleteHistoricalJob", true);
10+
defaultClient.setUnstableOperationEnabled("v2.deleteThreatHuntingJob", true);
1111
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
1212

1313
try {
14-
apiInstance.deleteHistoricalJob("job_id");
14+
apiInstance.deleteThreatHuntingJob("job_id");
1515
} catch (ApiException e) {
16-
System.err.println("Exception when calling SecurityMonitoringApi#deleteHistoricalJob");
16+
System.err.println("Exception when calling SecurityMonitoringApi#deleteThreatHuntingJob");
1717
System.err.println("Status code: " + e.getCode());
1818
System.err.println("Reason: " + e.getResponseBody());
1919
System.err.println("Response headers: " + e.getResponseHeaders());

‎examples/v2/security-monitoring/GetHistoricalJob.java‎ renamed to ‎examples/v2/security-monitoring/GetThreatHuntingJob.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6-
import com.datadog.api.client.v2.model.HistoricalJobResponse;
6+
import com.datadog.api.client.v2.model.ThreatHuntingJobResponse;
77

88
public class Example {
99
public static void main(String[] args) {
1010
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11-
defaultClient.setUnstableOperationEnabled("v2.getHistoricalJob", true);
12-
defaultClient.setUnstableOperationEnabled("v2.runHistoricalJob", true);
11+
defaultClient.setUnstableOperationEnabled("v2.getThreatHuntingJob", true);
12+
defaultClient.setUnstableOperationEnabled("v2.runThreatHuntingJob", true);
1313
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
1414

15-
// there is a valid "historical_job" in the system
16-
String HISTORICAL_JOB_DATA_ID = System.getenv("HISTORICAL_JOB_DATA_ID");
15+
// there is a valid "threat_hunting_job" in the system
16+
String THREAT_HUNTING_JOB_DATA_ID = System.getenv("THREAT_HUNTING_JOB_DATA_ID");
1717

1818
try {
19-
HistoricalJobResponse result = apiInstance.getHistoricalJob(HISTORICAL_JOB_DATA_ID);
19+
ThreatHuntingJobResponse result = apiInstance.getThreatHuntingJob(THREAT_HUNTING_JOB_DATA_ID);
2020
System.out.println(result);
2121
} catch (ApiException e) {
22-
System.err.println("Exception when calling SecurityMonitoringApi#getHistoricalJob");
22+
System.err.println("Exception when calling SecurityMonitoringApi#getThreatHuntingJob");
2323
System.err.println("Status code: " + e.getCode());
2424
System.err.println("Reason: " + e.getResponseBody());
2525
System.err.println("Response headers: " + e.getResponseHeaders());

‎examples/v2/security-monitoring/ListThreatHuntingJobs.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// List threat hunting jobs returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.model.ListThreatHuntingJobsResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.listThreatHuntingJobs", true);
12+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
13+
14+
try {
15+
ListThreatHuntingJobsResponse result = apiInstance.listThreatHuntingJobs();
16+
System.out.println(result);
17+
} catch (ApiException e) {
18+
System.err.println("Exception when calling SecurityMonitoringApi#listThreatHuntingJobs");
19+
System.err.println("Status code: " + e.getCode());
20+
System.err.println("Reason: " + e.getResponseBody());
21+
System.err.println("Response headers: " + e.getResponseHeaders());
22+
e.printStackTrace();
23+
}
24+
}
25+
}

‎examples/v2/security-monitoring/ListHistoricalJobs.java‎ renamed to ‎examples/v2/security-monitoring/ListThreatHuntingJobs_1365512061.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6-
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListHistoricalJobsOptionalParameters;
7-
import com.datadog.api.client.v2.model.ListHistoricalJobsResponse;
6+
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListThreatHuntingJobsOptionalParameters;
7+
import com.datadog.api.client.v2.model.ListThreatHuntingJobsResponse;
88

99
public class Example {
1010
public static void main(String[] args) {
1111
ApiClient defaultClient = ApiClient.getDefaultApiClient();
12-
defaultClient.setUnstableOperationEnabled("v2.listHistoricalJobs", true);
13-
defaultClient.setUnstableOperationEnabled("v2.runHistoricalJob", true);
12+
defaultClient.setUnstableOperationEnabled("v2.listThreatHuntingJobs", true);
13+
defaultClient.setUnstableOperationEnabled("v2.runThreatHuntingJob", true);
1414
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
1515

16-
// there is a valid "historical_job" in the system
17-
String HISTORICAL_JOB_DATA_ID = System.getenv("HISTORICAL_JOB_DATA_ID");
16+
// there is a valid "threat_hunting_job" in the system
17+
String THREAT_HUNTING_JOB_DATA_ID = System.getenv("THREAT_HUNTING_JOB_DATA_ID");
1818

1919
try {
20-
ListHistoricalJobsResponse result =
21-
apiInstance.listHistoricalJobs(
22-
new ListHistoricalJobsOptionalParameters().filterQuery("id:string"));
20+
ListThreatHuntingJobsResponse result =
21+
apiInstance.listThreatHuntingJobs(
22+
new ListThreatHuntingJobsOptionalParameters().filterQuery("id:string"));
2323
System.out.println(result);
2424
} catch (ApiException e) {
25-
System.err.println("Exception when calling SecurityMonitoringApi#listHistoricalJobs");
25+
System.err.println("Exception when calling SecurityMonitoringApi#listThreatHuntingJobs");
2626
System.err.println("Status code: " + e.getCode());
2727
System.err.println("Reason: " + e.getResponseBody());
2828
System.err.println("Response headers: " + e.getResponseHeaders());

‎examples/v2/security-monitoring/RunHistoricalJob.java‎ renamed to ‎examples/v2/security-monitoring/RunThreatHuntingJob.java‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
1-
// Run a historical job returns "Status created" response
1+
// Run a threat hunting job returns "Status created" response
22

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6-
import com.datadog.api.client.v2.model.HistoricalJobOptions;
7-
import com.datadog.api.client.v2.model.HistoricalJobQuery;
86
import com.datadog.api.client.v2.model.JobCreateResponse;
97
import com.datadog.api.client.v2.model.JobDefinition;
10-
import com.datadog.api.client.v2.model.RunHistoricalJobRequest;
11-
import com.datadog.api.client.v2.model.RunHistoricalJobRequestAttributes;
12-
import com.datadog.api.client.v2.model.RunHistoricalJobRequestData;
13-
import com.datadog.api.client.v2.model.RunHistoricalJobRequestDataType;
8+
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequest;
9+
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestAttributes;
10+
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestData;
11+
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestDataType;
1412
import com.datadog.api.client.v2.model.SecurityMonitoringRuleCaseCreate;
1513
import com.datadog.api.client.v2.model.SecurityMonitoringRuleEvaluationWindow;
1614
import com.datadog.api.client.v2.model.SecurityMonitoringRuleKeepAlive;
1715
import com.datadog.api.client.v2.model.SecurityMonitoringRuleMaxSignalDuration;
1816
import com.datadog.api.client.v2.model.SecurityMonitoringRuleQueryAggregation;
1917
import com.datadog.api.client.v2.model.SecurityMonitoringRuleSeverity;
18+
import com.datadog.api.client.v2.model.ThreatHuntingJobOptions;
19+
import com.datadog.api.client.v2.model.ThreatHuntingJobQuery;
2020
import java.util.Collections;
2121

2222
public class Example {
2323
public static void main(String[] args) {
2424
ApiClient defaultClient = ApiClient.getDefaultApiClient();
25-
defaultClient.setUnstableOperationEnabled("v2.runHistoricalJob", true);
25+
defaultClient.setUnstableOperationEnabled("v2.runThreatHuntingJob", true);
2626
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
2727

28-
RunHistoricalJobRequest body =
29-
new RunHistoricalJobRequest()
28+
RunThreatHuntingJobRequest body =
29+
new RunThreatHuntingJobRequest()
3030
.data(
31-
new RunHistoricalJobRequestData()
32-
.type(RunHistoricalJobRequestDataType.HISTORICALDETECTIONSJOBCREATE)
31+
new RunThreatHuntingJobRequestData()
32+
.type(RunThreatHuntingJobRequestDataType.HISTORICALDETECTIONSJOBCREATE)
3333
.attributes(
34-
new RunHistoricalJobRequestAttributes()
34+
new RunThreatHuntingJobRequestAttributes()
3535
.jobDefinition(
3636
new JobDefinition()
3737
.type("log_detection")
3838
.name("Excessive number of failed attempts.")
3939
.queries(
4040
Collections.singletonList(
41-
new HistoricalJobQuery()
41+
new ThreatHuntingJobQuery()
4242
.query("source:non_existing_src_weekend")
4343
.aggregation(
4444
SecurityMonitoringRuleQueryAggregation.COUNT)))
@@ -49,7 +49,7 @@ public static void main(String[] args) {
4949
.status(SecurityMonitoringRuleSeverity.INFO)
5050
.condition("a > 1")))
5151
.options(
52-
new HistoricalJobOptions()
52+
new ThreatHuntingJobOptions()
5353
.keepAlive(SecurityMonitoringRuleKeepAlive.ONE_HOUR)
5454
.maxSignalDuration(
5555
SecurityMonitoringRuleMaxSignalDuration.ONE_DAY)
@@ -62,10 +62,10 @@ public static void main(String[] args) {
6262
.index("main"))));
6363

6464
try {
65-
JobCreateResponse result = apiInstance.runHistoricalJob(body);
65+
JobCreateResponse result = apiInstance.runThreatHuntingJob(body);
6666
System.out.println(result);
6767
} catch (ApiException e) {
68-
System.err.println("Exception when calling SecurityMonitoringApi#runHistoricalJob");
68+
System.err.println("Exception when calling SecurityMonitoringApi#runThreatHuntingJob");
6969
System.err.println("Status code: " + e.getCode());
7070
System.err.println("Reason: " + e.getResponseBody());
7171
System.err.println("Response headers: " + e.getResponseHeaders());

‎src/main/java/com/datadog/api/client/ApiClient.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -696,24 +696,24 @@ public class ApiClient {
696696
put("v2.getOpenAPI", false);
697697
put("v2.listAPIs", false);
698698
put("v2.updateOpenAPI", false);
699-
put("v2.cancelHistoricalJob", false);
699+
put("v2.cancelThreatHuntingJob", false);
700700
put("v2.convertJobResultToSignal", false);
701-
put("v2.deleteHistoricalJob", false);
701+
put("v2.deleteThreatHuntingJob", false);
702702
put("v2.getFinding", false);
703-
put("v2.getHistoricalJob", false);
704703
put("v2.getRuleVersionHistory", false);
705704
put("v2.getSBOM", false);
706705
put("v2.getSecurityMonitoringHistsignal", false);
707706
put("v2.getSecurityMonitoringHistsignalsByJobId", false);
707+
put("v2.getThreatHuntingJob", false);
708708
put("v2.listAssetsSBOMs", false);
709709
put("v2.listFindings", false);
710-
put("v2.listHistoricalJobs", false);
711710
put("v2.listScannedAssetsMetadata", false);
712711
put("v2.listSecurityMonitoringHistsignals", false);
712+
put("v2.listThreatHuntingJobs", false);
713713
put("v2.listVulnerabilities", false);
714714
put("v2.listVulnerableAssets", false);
715715
put("v2.muteFindings", false);
716-
put("v2.runHistoricalJob", false);
716+
put("v2.runThreatHuntingJob", false);
717717
put("v2.searchSecurityMonitoringHistsignals", false);
718718
put("v2.createDataset", false);
719719
put("v2.deleteDataset", false);

0 commit comments

Comments
 (0)