Skip to content

Commit 25b414a

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 (#991)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 1dd6857 commit 25b414a

File tree

63 files changed

+1097
-1010
lines changed

Some content is hidden

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

63 files changed

+1097
-1010
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.rs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Cancel a threat hunting job returns "OK" response
2+
use datadog_api_client::datadog;
3+
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
4+
5+
#[tokio::main]
6+
async fn main() {
7+
let mut configuration = datadog::Configuration::new();
8+
configuration.set_unstable_operation_enabled("v2.CancelThreatHuntingJob", true);
9+
let api = SecurityMonitoringAPI::with_config(configuration);
10+
let resp = api.cancel_threat_hunting_job("job_id".to_string()).await;
11+
if let Ok(value) = resp {
12+
println!("{:#?}", value);
13+
} else {
14+
println!("{:#?}", resp.unwrap_err());
15+
}
16+
}

‎examples/v2_security-monitoring_CancelHistoricalJob.rs‎ renamed to ‎examples/v2_security-monitoring_CancelThreatHuntingJob_1945505845.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
44

55
#[tokio::main]
66
async fn main() {
7-
// there is a valid "historical_job" in the system
8-
let historical_job_data_id = std::env::var("HISTORICAL_JOB_DATA_ID").unwrap();
7+
// there is a valid "threat_hunting_job" in the system
8+
let threat_hunting_job_data_id = std::env::var("THREAT_HUNTING_JOB_DATA_ID").unwrap();
99
let mut configuration = datadog::Configuration::new();
10-
configuration.set_unstable_operation_enabled("v2.CancelHistoricalJob", true);
11-
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
10+
configuration.set_unstable_operation_enabled("v2.CancelThreatHuntingJob", true);
11+
configuration.set_unstable_operation_enabled("v2.RunThreatHuntingJob", true);
1212
let api = SecurityMonitoringAPI::with_config(configuration);
1313
let resp = api
14-
.cancel_historical_job(historical_job_data_id.clone())
14+
.cancel_threat_hunting_job(threat_hunting_job_data_id.clone())
1515
.await;
1616
if let Ok(value) = resp {
1717
println!("{:#?}", value);

‎examples/v2_security-monitoring_DeleteHistoricalJob.rs‎ renamed to ‎examples/v2_security-monitoring_DeleteThreatHuntingJob.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
55
#[tokio::main]
66
async fn main() {
77
let mut configuration = datadog::Configuration::new();
8-
configuration.set_unstable_operation_enabled("v2.DeleteHistoricalJob", true);
8+
configuration.set_unstable_operation_enabled("v2.DeleteThreatHuntingJob", true);
99
let api = SecurityMonitoringAPI::with_config(configuration);
10-
let resp = api.delete_historical_job("job_id".to_string()).await;
10+
let resp = api.delete_threat_hunting_job("job_id".to_string()).await;
1111
if let Ok(value) = resp {
1212
println!("{:#?}", value);
1313
} else {

‎examples/v2_security-monitoring_GetHistoricalJob.rs‎ renamed to ‎examples/v2_security-monitoring_GetThreatHuntingJob.rs‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
44

55
#[tokio::main]
66
async fn main() {
7-
// there is a valid "historical_job" in the system
8-
let historical_job_data_id = std::env::var("HISTORICAL_JOB_DATA_ID").unwrap();
7+
// there is a valid "threat_hunting_job" in the system
8+
let threat_hunting_job_data_id = std::env::var("THREAT_HUNTING_JOB_DATA_ID").unwrap();
99
let mut configuration = datadog::Configuration::new();
10-
configuration.set_unstable_operation_enabled("v2.GetHistoricalJob", true);
11-
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
10+
configuration.set_unstable_operation_enabled("v2.GetThreatHuntingJob", true);
11+
configuration.set_unstable_operation_enabled("v2.RunThreatHuntingJob", true);
1212
let api = SecurityMonitoringAPI::with_config(configuration);
13-
let resp = api.get_historical_job(historical_job_data_id.clone()).await;
13+
let resp = api
14+
.get_threat_hunting_job(threat_hunting_job_data_id.clone())
15+
.await;
1416
if let Ok(value) = resp {
1517
println!("{:#?}", value);
1618
} else {

‎examples/v2_security-monitoring_ListThreatHuntingJobs.rs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// List threat hunting jobs returns "OK" response
2+
use datadog_api_client::datadog;
3+
use datadog_api_client::datadogV2::api_security_monitoring::ListThreatHuntingJobsOptionalParams;
4+
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
5+
6+
#[tokio::main]
7+
async fn main() {
8+
let mut configuration = datadog::Configuration::new();
9+
configuration.set_unstable_operation_enabled("v2.ListThreatHuntingJobs", true);
10+
let api = SecurityMonitoringAPI::with_config(configuration);
11+
let resp = api
12+
.list_threat_hunting_jobs(ListThreatHuntingJobsOptionalParams::default())
13+
.await;
14+
if let Ok(value) = resp {
15+
println!("{:#?}", value);
16+
} else {
17+
println!("{:#?}", resp.unwrap_err());
18+
}
19+
}

‎examples/v2_security-monitoring_ListHistoricalJobs.rs‎ renamed to ‎examples/v2_security-monitoring_ListThreatHuntingJobs_1365512061.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// List historical jobs returns "OK" response
22
use datadog_api_client::datadog;
3-
use datadog_api_client::datadogV2::api_security_monitoring::ListHistoricalJobsOptionalParams;
3+
use datadog_api_client::datadogV2::api_security_monitoring::ListThreatHuntingJobsOptionalParams;
44
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
55

66
#[tokio::main]
77
async fn main() {
8-
// there is a valid "historical_job" in the system
8+
// there is a valid "threat_hunting_job" in the system
99
let mut configuration = datadog::Configuration::new();
10-
configuration.set_unstable_operation_enabled("v2.ListHistoricalJobs", true);
11-
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
10+
configuration.set_unstable_operation_enabled("v2.ListThreatHuntingJobs", true);
11+
configuration.set_unstable_operation_enabled("v2.RunThreatHuntingJob", true);
1212
let api = SecurityMonitoringAPI::with_config(configuration);
1313
let resp = api
14-
.list_historical_jobs(
15-
ListHistoricalJobsOptionalParams::default().filter_query("id:string".to_string()),
14+
.list_threat_hunting_jobs(
15+
ListThreatHuntingJobsOptionalParams::default().filter_query("id:string".to_string()),
1616
)
1717
.await;
1818
if let Ok(value) = resp {

‎examples/v2_security-monitoring_RunHistoricalJob.rs‎ renamed to ‎examples/v2_security-monitoring_RunThreatHuntingJob.rs‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
// Run a historical job returns "Status created" response
1+
// Run a threat hunting job returns "Status created" response
22
use datadog_api_client::datadog;
33
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
4-
use datadog_api_client::datadogV2::model::HistoricalJobOptions;
5-
use datadog_api_client::datadogV2::model::HistoricalJobQuery;
64
use datadog_api_client::datadogV2::model::JobDefinition;
7-
use datadog_api_client::datadogV2::model::RunHistoricalJobRequest;
8-
use datadog_api_client::datadogV2::model::RunHistoricalJobRequestAttributes;
9-
use datadog_api_client::datadogV2::model::RunHistoricalJobRequestData;
10-
use datadog_api_client::datadogV2::model::RunHistoricalJobRequestDataType;
5+
use datadog_api_client::datadogV2::model::RunThreatHuntingJobRequest;
6+
use datadog_api_client::datadogV2::model::RunThreatHuntingJobRequestAttributes;
7+
use datadog_api_client::datadogV2::model::RunThreatHuntingJobRequestData;
8+
use datadog_api_client::datadogV2::model::RunThreatHuntingJobRequestDataType;
119
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleCaseCreate;
1210
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleEvaluationWindow;
1311
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleKeepAlive;
1412
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleMaxSignalDuration;
1513
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleQueryAggregation;
1614
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleSeverity;
15+
use datadog_api_client::datadogV2::model::ThreatHuntingJobOptions;
16+
use datadog_api_client::datadogV2::model::ThreatHuntingJobQuery;
1717

1818
#[tokio::main]
1919
async fn main() {
20-
let body = RunHistoricalJobRequest::new().data(
21-
RunHistoricalJobRequestData::new()
20+
let body = RunThreatHuntingJobRequest::new().data(
21+
RunThreatHuntingJobRequestData::new()
2222
.attributes(
23-
RunHistoricalJobRequestAttributes::new().job_definition(
23+
RunThreatHuntingJobRequestAttributes::new().job_definition(
2424
JobDefinition::new(
2525
vec![SecurityMonitoringRuleCaseCreate::new(
2626
SecurityMonitoringRuleSeverity::INFO,
@@ -32,15 +32,15 @@ async fn main() {
3232
"main".to_string(),
3333
"A large number of failed login attempts.".to_string(),
3434
"Excessive number of failed attempts.".to_string(),
35-
vec![HistoricalJobQuery::new()
35+
vec![ThreatHuntingJobQuery::new()
3636
.aggregation(SecurityMonitoringRuleQueryAggregation::COUNT)
3737
.distinct_fields(vec![])
3838
.group_by_fields(vec![])
3939
.query("source:non_existing_src_weekend".to_string())],
4040
1730387532611,
4141
)
4242
.options(
43-
HistoricalJobOptions::new()
43+
ThreatHuntingJobOptions::new()
4444
.evaluation_window(
4545
SecurityMonitoringRuleEvaluationWindow::FIFTEEN_MINUTES,
4646
)
@@ -51,12 +51,12 @@ async fn main() {
5151
.type_("log_detection".to_string()),
5252
),
5353
)
54-
.type_(RunHistoricalJobRequestDataType::HISTORICALDETECTIONSJOBCREATE),
54+
.type_(RunThreatHuntingJobRequestDataType::HISTORICALDETECTIONSJOBCREATE),
5555
);
5656
let mut configuration = datadog::Configuration::new();
57-
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
57+
configuration.set_unstable_operation_enabled("v2.RunThreatHuntingJob", true);
5858
let api = SecurityMonitoringAPI::with_config(configuration);
59-
let resp = api.run_historical_job(body).await;
59+
let resp = api.run_threat_hunting_job(body).await;
6060
if let Ok(value) = resp {
6161
println!("{:#?}", value);
6262
} else {

‎src/datadog/configuration.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,27 +131,27 @@ impl Default for Configuration {
131131
("v2.get_open_api".to_owned(), false),
132132
("v2.list_apis".to_owned(), false),
133133
("v2.update_open_api".to_owned(), false),
134-
("v2.cancel_historical_job".to_owned(), false),
134+
("v2.cancel_threat_hunting_job".to_owned(), false),
135135
("v2.convert_job_result_to_signal".to_owned(), false),
136-
("v2.delete_historical_job".to_owned(), false),
136+
("v2.delete_threat_hunting_job".to_owned(), false),
137137
("v2.get_finding".to_owned(), false),
138-
("v2.get_historical_job".to_owned(), false),
139138
("v2.get_rule_version_history".to_owned(), false),
140139
("v2.get_sbom".to_owned(), false),
141140
("v2.get_security_monitoring_histsignal".to_owned(), false),
142141
(
143142
"v2.get_security_monitoring_histsignals_by_job_id".to_owned(),
144143
false,
145144
),
145+
("v2.get_threat_hunting_job".to_owned(), false),
146146
("v2.list_assets_sbo_ms".to_owned(), false),
147147
("v2.list_findings".to_owned(), false),
148-
("v2.list_historical_jobs".to_owned(), false),
149148
("v2.list_scanned_assets_metadata".to_owned(), false),
150149
("v2.list_security_monitoring_histsignals".to_owned(), false),
150+
("v2.list_threat_hunting_jobs".to_owned(), false),
151151
("v2.list_vulnerabilities".to_owned(), false),
152152
("v2.list_vulnerable_assets".to_owned(), false),
153153
("v2.mute_findings".to_owned(), false),
154-
("v2.run_historical_job".to_owned(), false),
154+
("v2.run_threat_hunting_job".to_owned(), false),
155155
(
156156
"v2.search_security_monitoring_histsignals".to_owned(),
157157
false,

0 commit comments

Comments
 (0)