Skip to content

Rename historical job API endpoints to threat hunting #3215

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Oct 27, 2025
Merged

Rename historical job API endpoints to threat hunting #3215

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

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions examples/v2/security-monitoring/CancelThreatHuntingJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Cancel a threat hunting job returns "OK" response

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

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

try {
apiInstance.cancelThreatHuntingJob("job_id");
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#cancelThreatHuntingJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
12 changes: 6 additions & 6 deletions ...urity-monitoring/CancelHistoricalJob.java → ...ng/CancelThreatHuntingJob_1945505845.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.cancelHistoricalJob", true);
defaultClient.setUnstableOperationEnabled("v2.runHistoricalJob", true);
defaultClient.setUnstableOperationEnabled("v2.cancelThreatHuntingJob", true);
defaultClient.setUnstableOperationEnabled("v2.runThreatHuntingJob", true);
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

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

try {
apiInstance.cancelHistoricalJob(HISTORICAL_JOB_DATA_ID);
apiInstance.cancelThreatHuntingJob(THREAT_HUNTING_JOB_DATA_ID);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#cancelHistoricalJob");
System.err.println("Exception when calling SecurityMonitoringApi#cancelThreatHuntingJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
6 changes: 3 additions & 3 deletions ...urity-monitoring/DeleteHistoricalJob.java → ...ty-monitoring/DeleteThreatHuntingJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteHistoricalJob", true);
defaultClient.setUnstableOperationEnabled("v2.deleteThreatHuntingJob", true);
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

try {
apiInstance.deleteHistoricalJob("job_id");
apiInstance.deleteThreatHuntingJob("job_id");
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#deleteHistoricalJob");
System.err.println("Exception when calling SecurityMonitoringApi#deleteThreatHuntingJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
14 changes: 7 additions & 7 deletions ...security-monitoring/GetHistoricalJob.java → ...urity-monitoring/GetThreatHuntingJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
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.HistoricalJobResponse;
import com.datadog.api.client.v2.model.ThreatHuntingJobResponse;

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

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

try {
HistoricalJobResponse result = apiInstance.getHistoricalJob(HISTORICAL_JOB_DATA_ID);
ThreatHuntingJobResponse result = apiInstance.getThreatHuntingJob(THREAT_HUNTING_JOB_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#getHistoricalJob");
System.err.println("Exception when calling SecurityMonitoringApi#getThreatHuntingJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
25 changes: 25 additions & 0 deletions examples/v2/security-monitoring/ListThreatHuntingJobs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List threat hunting jobs returns "OK" 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.ListThreatHuntingJobsResponse;

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

try {
ListThreatHuntingJobsResponse result = apiInstance.listThreatHuntingJobs();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#listThreatHuntingJobs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
20 changes: 10 additions & 10 deletions ...curity-monitoring/ListHistoricalJobs.java → ...ing/ListThreatHuntingJobs_1365512061.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@
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.api.SecurityMonitoringApi.ListHistoricalJobsOptionalParameters;
import com.datadog.api.client.v2.model.ListHistoricalJobsResponse;
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListThreatHuntingJobsOptionalParameters;
import com.datadog.api.client.v2.model.ListThreatHuntingJobsResponse;

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

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

try {
ListHistoricalJobsResponse result =
apiInstance.listHistoricalJobs(
new ListHistoricalJobsOptionalParameters().filterQuery("id:string"));
ListThreatHuntingJobsResponse result =
apiInstance.listThreatHuntingJobs(
new ListThreatHuntingJobsOptionalParameters().filterQuery("id:string"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#listHistoricalJobs");
System.err.println("Exception when calling SecurityMonitoringApi#listThreatHuntingJobs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
34 changes: 17 additions & 17 deletions ...security-monitoring/RunHistoricalJob.java → ...urity-monitoring/RunThreatHuntingJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
// Run a historical job returns "Status created" response
// Run a threat hunting job returns "Status created" 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.HistoricalJobOptions;
import com.datadog.api.client.v2.model.HistoricalJobQuery;
import com.datadog.api.client.v2.model.JobCreateResponse;
import com.datadog.api.client.v2.model.JobDefinition;
import com.datadog.api.client.v2.model.RunHistoricalJobRequest;
import com.datadog.api.client.v2.model.RunHistoricalJobRequestAttributes;
import com.datadog.api.client.v2.model.RunHistoricalJobRequestData;
import com.datadog.api.client.v2.model.RunHistoricalJobRequestDataType;
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequest;
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestAttributes;
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestData;
import com.datadog.api.client.v2.model.RunThreatHuntingJobRequestDataType;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleCaseCreate;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleEvaluationWindow;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleKeepAlive;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleMaxSignalDuration;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleQueryAggregation;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleSeverity;
import com.datadog.api.client.v2.model.ThreatHuntingJobOptions;
import com.datadog.api.client.v2.model.ThreatHuntingJobQuery;
import java.util.Collections;

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

RunHistoricalJobRequest body =
new RunHistoricalJobRequest()
RunThreatHuntingJobRequest body =
new RunThreatHuntingJobRequest()
.data(
new RunHistoricalJobRequestData()
.type(RunHistoricalJobRequestDataType.HISTORICALDETECTIONSJOBCREATE)
new RunThreatHuntingJobRequestData()
.type(RunThreatHuntingJobRequestDataType.HISTORICALDETECTIONSJOBCREATE)
.attributes(
new RunHistoricalJobRequestAttributes()
new RunThreatHuntingJobRequestAttributes()
.jobDefinition(
new JobDefinition()
.type("log_detection")
.name("Excessive number of failed attempts.")
.queries(
Collections.singletonList(
new HistoricalJobQuery()
new ThreatHuntingJobQuery()
.query("source:non_existing_src_weekend")
.aggregation(
SecurityMonitoringRuleQueryAggregation.COUNT)))
Expand All @@ -49,7 +49,7 @@ public static void main(String[] args) {
.status(SecurityMonitoringRuleSeverity.INFO)
.condition("a > 1")))
.options(
new HistoricalJobOptions()
new ThreatHuntingJobOptions()
.keepAlive(SecurityMonitoringRuleKeepAlive.ONE_HOUR)
.maxSignalDuration(
SecurityMonitoringRuleMaxSignalDuration.ONE_DAY)
Expand All @@ -62,10 +62,10 @@ public static void main(String[] args) {
.index("main"))));

try {
JobCreateResponse result = apiInstance.runHistoricalJob(body);
JobCreateResponse result = apiInstance.runThreatHuntingJob(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#runHistoricalJob");
System.err.println("Exception when calling SecurityMonitoringApi#runThreatHuntingJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
10 changes: 5 additions & 5 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 @@ -696,24 +696,24 @@ public class ApiClient {
put("v2.getOpenAPI", false);
put("v2.listAPIs", false);
put("v2.updateOpenAPI", false);
put("v2.cancelHistoricalJob", false);
put("v2.cancelThreatHuntingJob", false);
put("v2.convertJobResultToSignal", false);
put("v2.deleteHistoricalJob", false);
put("v2.deleteThreatHuntingJob", false);
put("v2.getFinding", false);
put("v2.getHistoricalJob", false);
put("v2.getRuleVersionHistory", false);
put("v2.getSBOM", false);
put("v2.getSecurityMonitoringHistsignal", false);
put("v2.getSecurityMonitoringHistsignalsByJobId", false);
put("v2.getThreatHuntingJob", false);
put("v2.listAssetsSBOMs", false);
put("v2.listFindings", false);
put("v2.listHistoricalJobs", false);
put("v2.listScannedAssetsMetadata", false);
put("v2.listSecurityMonitoringHistsignals", false);
put("v2.listThreatHuntingJobs", false);
put("v2.listVulnerabilities", false);
put("v2.listVulnerableAssets", false);
put("v2.muteFindings", false);
put("v2.runHistoricalJob", false);
put("v2.runThreatHuntingJob", false);
put("v2.searchSecurityMonitoringHistsignals", false);
put("v2.createDataset", false);
put("v2.deleteDataset", false);
Expand Down
Loading
Loading