Skip to content

[security_monitoring] Make Historical Jobs endpoints public #590

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

Closed
api-clients-generation-pipeline wants to merge 1 commit into from
Closed

[security_monitoring] Make Historical Jobs endpoints public #590

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
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-04-04 20:19:30.053070",
"spec_repo_commit": "3909ab62"
"regenerated": "2025-04-06 16:06:34.141513",
"spec_repo_commit": "fe3756c4"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-04-04 20:19:30.068607",
"spec_repo_commit": "3909ab62"
"regenerated": "2025-04-06 16:06:34.157845",
"spec_repo_commit": "fe3756c4"
}
}
}
18 changes: 0 additions & 18 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50645,9 +50645,6 @@ paths:
summary: List historical jobs
tags:
- Security Monitoring
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
post:
description: Run a historical job.
operationId: RunHistoricalJob
Expand Down Expand Up @@ -50687,9 +50684,6 @@ paths:
operator: OR
permissions:
- security_monitoring_rules_write
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
/api/v2/siem-historical-detections/jobs/signal_convert:
post:
description: Convert a job result to a signal.
Expand Down Expand Up @@ -50721,9 +50715,6 @@ paths:
operator: OR
permissions:
- security_monitoring_signals_write
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
/api/v2/siem-historical-detections/jobs/{job_id}:
delete:
description: Delete an existing job.
Expand Down Expand Up @@ -50752,9 +50743,6 @@ paths:
summary: Delete an existing job
tags:
- Security Monitoring
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
get:
description: Get a job's details.
operationId: GetHistoricalJob
Expand Down Expand Up @@ -50787,9 +50775,6 @@ paths:
operator: OR
permissions:
- security_monitoring_rules_read
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
/api/v2/siem-historical-detections/jobs/{job_id}/cancel:
patch:
description: Cancel a historical job.
Expand Down Expand Up @@ -50823,9 +50808,6 @@ paths:
operator: OR
permissions:
- security_monitoring_rules_write
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
/api/v2/slo/report:
post:
description: 'Create a job to generate an SLO report. The report job is processed
Expand Down
4 changes: 1 addition & 3 deletions examples/v2_security-monitoring_CancelHistoricalJob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
async fn main() {
// there is a valid "historical_job" in the system
let historical_job_data_id = std::env::var("HISTORICAL_JOB_DATA_ID").unwrap();
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.CancelHistoricalJob", true);
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api
.cancel_historical_job(historical_job_data_id.clone())
Expand Down
3 changes: 1 addition & 2 deletions examples/v2_security-monitoring_ConvertJobResultToSignal.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ async fn main() {
ConvertJobResultsToSignalsDataType::HISTORICALDETECTIONSJOBRESULTSIGNALCONVERSION,
),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.ConvertJobResultToSignal", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api.convert_job_result_to_signal(body).await;
if let Ok(value) = resp {
Expand Down
3 changes: 1 addition & 2 deletions examples/v2_security-monitoring_DeleteHistoricalJob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP

#[tokio::main]
async fn main() {
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.DeleteHistoricalJob", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api.delete_historical_job("job_id".to_string()).await;
if let Ok(value) = resp {
Expand Down
4 changes: 1 addition & 3 deletions examples/v2_security-monitoring_GetHistoricalJob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
async fn main() {
// there is a valid "historical_job" in the system
let historical_job_data_id = std::env::var("HISTORICAL_JOB_DATA_ID").unwrap();
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.GetHistoricalJob", true);
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api.get_historical_job(historical_job_data_id.clone()).await;
if let Ok(value) = resp {
Expand Down
4 changes: 1 addition & 3 deletions examples/v2_security-monitoring_ListHistoricalJobs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAP
#[tokio::main]
async fn main() {
// there is a valid "historical_job" in the system
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.ListHistoricalJobs", true);
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api
.list_historical_jobs(
Expand Down
3 changes: 1 addition & 2 deletions examples/v2_security-monitoring_RunHistoricalJob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ async fn main() {
)
.type_(RunHistoricalJobRequestDataType::HISTORICALDETECTIONSJOBCREATE),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.RunHistoricalJob", true);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api.run_historical_job(body).await;
if let Ok(value) = resp {
Expand Down
6 changes: 0 additions & 6 deletions src/datadog/configuration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,19 +164,13 @@ impl Default for Configuration {
("v2.update_aws_account".to_owned(), false),
("v2.list_aws_logs_services".to_owned(), false),
("v2.get_aggregated_connections".to_owned(), false),
("v2.cancel_historical_job".to_owned(), false),
("v2.convert_job_result_to_signal".to_owned(), false),
("v2.delete_historical_job".to_owned(), false),
("v2.get_finding".to_owned(), false),
("v2.get_historical_job".to_owned(), false),
("v2.get_rule_version_history".to_owned(), false),
("v2.get_sbom".to_owned(), false),
("v2.list_findings".to_owned(), false),
("v2.list_historical_jobs".to_owned(), false),
("v2.list_vulnerabilities".to_owned(), false),
("v2.list_vulnerable_assets".to_owned(), false),
("v2.mute_findings".to_owned(), false),
("v2.run_historical_job".to_owned(), false),
("v2.create_scorecard_outcomes_batch".to_owned(), false),
("v2.create_scorecard_rule".to_owned(), false),
("v2.delete_scorecard_rule".to_owned(), false),
Expand Down
48 changes: 0 additions & 48 deletions src/datadogV2/api/api_security_monitoring.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1201,14 +1201,6 @@ impl SecurityMonitoringAPI {
) -> Result<datadog::ResponseContent<()>, datadog::Error<CancelHistoricalJobError>> {
let local_configuration = &self.config;
let operation_id = "v2.cancel_historical_job";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.cancel_historical_job' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

let local_client = &self.client;

Expand Down Expand Up @@ -1412,14 +1404,6 @@ impl SecurityMonitoringAPI {
) -> Result<datadog::ResponseContent<()>, datadog::Error<ConvertJobResultToSignalError>> {
let local_configuration = &self.config;
let operation_id = "v2.convert_job_result_to_signal";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.convert_job_result_to_signal' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

let local_client = &self.client;

Expand Down Expand Up @@ -2502,14 +2486,6 @@ impl SecurityMonitoringAPI {
) -> Result<datadog::ResponseContent<()>, datadog::Error<DeleteHistoricalJobError>> {
let local_configuration = &self.config;
let operation_id = "v2.delete_historical_job";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.delete_historical_job' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

let local_client = &self.client;

Expand Down Expand Up @@ -3685,14 +3661,6 @@ impl SecurityMonitoringAPI {
> {
let local_configuration = &self.config;
let operation_id = "v2.get_historical_job";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.get_historical_job' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

let local_client = &self.client;

Expand Down Expand Up @@ -5242,14 +5210,6 @@ impl SecurityMonitoringAPI {
> {
let local_configuration = &self.config;
let operation_id = "v2.list_historical_jobs";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.list_historical_jobs' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

// unbox and build optional parameters
let page_size = params.page_size;
Expand Down Expand Up @@ -7151,14 +7111,6 @@ impl SecurityMonitoringAPI {
> {
let local_configuration = &self.config;
let operation_id = "v2.run_historical_job";
if local_configuration.is_unstable_operation_enabled(operation_id) {
warn!("Using unstable operation {operation_id}");
} else {
let local_error = datadog::UnstableOperationDisabledError {
msg: "Operation 'v2.run_historical_job' is not enabled".to_string(),
};
return Err(datadog::Error::UnstableOperationDisabledError(local_error));
}

let local_client = &self.client;

Expand Down
Loading
Loading