Skip to content

Commit 23779a8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Security Monitoring - Revert rename of historical job API endpoints to threat hunting (#3411)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent c949db8 commit 23779a8

64 files changed

Lines changed: 785 additions & 861 deletions

File tree

Some content is hidden

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

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

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

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -13290,6 +13290,55 @@ datadog\_api\_client.v2.model.hamr\_org\_connection\_type module
1329013290
:members:
1329113291
:show-inheritance:
1329213292

13293+
datadog\_api\_client.v2.model.historical\_job\_data\_type module
13294+
----------------------------------------------------------------
13295+
13296+
.. automodule:: datadog_api_client.v2.model.historical_job_data_type
13297+
:members:
13298+
:show-inheritance:
13299+
13300+
datadog\_api\_client.v2.model.historical\_job\_list\_meta module
13301+
----------------------------------------------------------------
13302+
13303+
.. automodule:: datadog_api_client.v2.model.historical_job_list_meta
13304+
:members:
13305+
:show-inheritance:
13306+
13307+
datadog\_api\_client.v2.model.historical\_job\_options module
13308+
-------------------------------------------------------------
13309+
13310+
.. automodule:: datadog_api_client.v2.model.historical_job_options
13311+
:members:
13312+
:show-inheritance:
13313+
13314+
datadog\_api\_client.v2.model.historical\_job\_query module
13315+
-----------------------------------------------------------
13316+
13317+
.. automodule:: datadog_api_client.v2.model.historical_job_query
13318+
:members:
13319+
:show-inheritance:
13320+
13321+
datadog\_api\_client.v2.model.historical\_job\_response module
13322+
--------------------------------------------------------------
13323+
13324+
.. automodule:: datadog_api_client.v2.model.historical_job_response
13325+
:members:
13326+
:show-inheritance:
13327+
13328+
datadog\_api\_client.v2.model.historical\_job\_response\_attributes module
13329+
--------------------------------------------------------------------------
13330+
13331+
.. automodule:: datadog_api_client.v2.model.historical_job_response_attributes
13332+
:members:
13333+
:show-inheritance:
13334+
13335+
datadog\_api\_client.v2.model.historical\_job\_response\_data module
13336+
--------------------------------------------------------------------
13337+
13338+
.. automodule:: datadog_api_client.v2.model.historical_job_response_data
13339+
:members:
13340+
:show-inheritance:
13341+
1329313342
datadog\_api\_client.v2.model.hourly\_usage module
1329413343
--------------------------------------------------
1329513344

@@ -16454,6 +16503,13 @@ datadog\_api\_client.v2.model.list\_findings\_response module
1645416503
:members:
1645516504
:show-inheritance:
1645616505

16506+
datadog\_api\_client.v2.model.list\_historical\_jobs\_response module
16507+
---------------------------------------------------------------------
16508+
16509+
.. automodule:: datadog_api_client.v2.model.list_historical_jobs_response
16510+
:members:
16511+
:show-inheritance:
16512+
1645716513
datadog\_api\_client.v2.model.list\_integrations\_response module
1645816514
-----------------------------------------------------------------
1645916515

@@ -16650,13 +16706,6 @@ datadog\_api\_client.v2.model.list\_teams\_sort module
1665016706
:members:
1665116707
:show-inheritance:
1665216708

16653-
datadog\_api\_client.v2.model.list\_threat\_hunting\_jobs\_response module
16654-
--------------------------------------------------------------------------
16655-
16656-
.. automodule:: datadog_api_client.v2.model.list_threat_hunting_jobs_response
16657-
:members:
16658-
:show-inheritance:
16659-
1666016709
datadog\_api\_client.v2.model.list\_vulnerabilities\_response module
1666116710
--------------------------------------------------------------------
1666216711

@@ -26513,31 +26562,31 @@ datadog\_api\_client.v2.model.rum\_warning module
2651326562
:members:
2651426563
:show-inheritance:
2651526564

26516-
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request module
26517-
-----------------------------------------------------------------------
26565+
datadog\_api\_client.v2.model.run\_historical\_job\_request module
26566+
------------------------------------------------------------------
2651826567

26519-
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request
26568+
.. automodule:: datadog_api_client.v2.model.run_historical_job_request
2652026569
:members:
2652126570
:show-inheritance:
2652226571

26523-
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_attributes module
26524-
-----------------------------------------------------------------------------------
26572+
datadog\_api\_client.v2.model.run\_historical\_job\_request\_attributes module
26573+
------------------------------------------------------------------------------
2652526574

26526-
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_attributes
26575+
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_attributes
2652726576
:members:
2652826577
:show-inheritance:
2652926578

26530-
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_data module
26531-
-----------------------------------------------------------------------------
26579+
datadog\_api\_client.v2.model.run\_historical\_job\_request\_data module
26580+
------------------------------------------------------------------------
2653226581

26533-
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_data
26582+
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_data
2653426583
:members:
2653526584
:show-inheritance:
2653626585

26537-
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_data\_type module
26538-
-----------------------------------------------------------------------------------
26586+
datadog\_api\_client.v2.model.run\_historical\_job\_request\_data\_type module
26587+
------------------------------------------------------------------------------
2653926588

26540-
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_data_type
26589+
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_data_type
2654126590
:members:
2654226591
:show-inheritance:
2654326592

@@ -33506,55 +33555,6 @@ datadog\_api\_client.v2.model.test\_optimization\_update\_service\_settings\_req
3350633555
:members:
3350733556
:show-inheritance:
3350833557

33509-
datadog\_api\_client.v2.model.threat\_hunting\_job\_data\_type module
33510-
---------------------------------------------------------------------
33511-
33512-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_data_type
33513-
:members:
33514-
:show-inheritance:
33515-
33516-
datadog\_api\_client.v2.model.threat\_hunting\_job\_list\_meta module
33517-
---------------------------------------------------------------------
33518-
33519-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_list_meta
33520-
:members:
33521-
:show-inheritance:
33522-
33523-
datadog\_api\_client.v2.model.threat\_hunting\_job\_options module
33524-
------------------------------------------------------------------
33525-
33526-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_options
33527-
:members:
33528-
:show-inheritance:
33529-
33530-
datadog\_api\_client.v2.model.threat\_hunting\_job\_query module
33531-
----------------------------------------------------------------
33532-
33533-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_query
33534-
:members:
33535-
:show-inheritance:
33536-
33537-
datadog\_api\_client.v2.model.threat\_hunting\_job\_response module
33538-
-------------------------------------------------------------------
33539-
33540-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response
33541-
:members:
33542-
:show-inheritance:
33543-
33544-
datadog\_api\_client.v2.model.threat\_hunting\_job\_response\_attributes module
33545-
-------------------------------------------------------------------------------
33546-
33547-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response_attributes
33548-
:members:
33549-
:show-inheritance:
33550-
33551-
datadog\_api\_client.v2.model.threat\_hunting\_job\_response\_data module
33552-
-------------------------------------------------------------------------
33553-
33554-
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response_data
33555-
:members:
33556-
:show-inheritance:
33557-
3355833558
datadog\_api\_client.v2.model.time\_restriction module
3355933559
------------------------------------------------------
3356033560

examples/v2/security-monitoring/CancelThreatHuntingJob_1945505845.py renamed to examples/v2/security-monitoring/CancelHistoricalJob.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
from datadog_api_client import ApiClient, Configuration
77
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
88

9-
# there is a valid "threat_hunting_job" in the system
10-
THREAT_HUNTING_JOB_DATA_ID = environ["THREAT_HUNTING_JOB_DATA_ID"]
9+
# there is a valid "historical_job" in the system
10+
HISTORICAL_JOB_DATA_ID = environ["HISTORICAL_JOB_DATA_ID"]
1111

1212
configuration = Configuration()
13-
configuration.unstable_operations["cancel_threat_hunting_job"] = True
14-
configuration.unstable_operations["run_threat_hunting_job"] = True
13+
configuration.unstable_operations["cancel_historical_job"] = True
14+
configuration.unstable_operations["run_historical_job"] = True
1515
with ApiClient(configuration) as api_client:
1616
api_instance = SecurityMonitoringApi(api_client)
17-
api_instance.cancel_threat_hunting_job(
18-
job_id=THREAT_HUNTING_JOB_DATA_ID,
17+
api_instance.cancel_historical_job(
18+
job_id=HISTORICAL_JOB_DATA_ID,
1919
)

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

Lines changed: 0 additions & 14 deletions
This file was deleted.

examples/v2/security-monitoring/DeleteThreatHuntingJob.py renamed to examples/v2/security-monitoring/DeleteHistoricalJob.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
77

88
configuration = Configuration()
9-
configuration.unstable_operations["delete_threat_hunting_job"] = True
9+
configuration.unstable_operations["delete_historical_job"] = True
1010
with ApiClient(configuration) as api_client:
1111
api_instance = SecurityMonitoringApi(api_client)
12-
api_instance.delete_threat_hunting_job(
12+
api_instance.delete_historical_job(
1313
job_id="job_id",
1414
)

examples/v2/security-monitoring/GetThreatHuntingJob.py renamed to examples/v2/security-monitoring/GetHistoricalJob.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
from datadog_api_client import ApiClient, Configuration
77
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
88

9-
# there is a valid "threat_hunting_job" in the system
10-
THREAT_HUNTING_JOB_DATA_ID = environ["THREAT_HUNTING_JOB_DATA_ID"]
9+
# there is a valid "historical_job" in the system
10+
HISTORICAL_JOB_DATA_ID = environ["HISTORICAL_JOB_DATA_ID"]
1111

1212
configuration = Configuration()
13-
configuration.unstable_operations["get_threat_hunting_job"] = True
14-
configuration.unstable_operations["run_threat_hunting_job"] = True
13+
configuration.unstable_operations["get_historical_job"] = True
14+
configuration.unstable_operations["run_historical_job"] = True
1515
with ApiClient(configuration) as api_client:
1616
api_instance = SecurityMonitoringApi(api_client)
17-
response = api_instance.get_threat_hunting_job(
18-
job_id=THREAT_HUNTING_JOB_DATA_ID,
17+
response = api_instance.get_historical_job(
18+
job_id=HISTORICAL_JOB_DATA_ID,
1919
)
2020

2121
print(response)

examples/v2/security-monitoring/ListThreatHuntingJobs.py renamed to examples/v2/security-monitoring/ListHistoricalJobs.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
"""
2-
List threat hunting jobs returns "OK" response
2+
List historical jobs returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration
66
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
77

88
configuration = Configuration()
9-
configuration.unstable_operations["list_threat_hunting_jobs"] = True
9+
configuration.unstable_operations["list_historical_jobs"] = True
1010
with ApiClient(configuration) as api_client:
1111
api_instance = SecurityMonitoringApi(api_client)
12-
response = api_instance.list_threat_hunting_jobs()
12+
response = api_instance.list_historical_jobs()
1313

1414
print(response)

‎examples/v2/security-monitoring/ListThreatHuntingJobs_1365512061.py‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

examples/v2/security-monitoring/RunThreatHuntingJob.py renamed to examples/v2/security-monitoring/RunHistoricalJob.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
"""
2-
Run a threat hunting job returns "Status created" response
2+
Run a historical job returns "Status created" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration
66
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
7+
from datadog_api_client.v2.model.historical_job_options import HistoricalJobOptions
8+
from datadog_api_client.v2.model.historical_job_query import HistoricalJobQuery
79
from datadog_api_client.v2.model.job_definition import JobDefinition
8-
from datadog_api_client.v2.model.run_threat_hunting_job_request import RunThreatHuntingJobRequest
9-
from datadog_api_client.v2.model.run_threat_hunting_job_request_attributes import RunThreatHuntingJobRequestAttributes
10-
from datadog_api_client.v2.model.run_threat_hunting_job_request_data import RunThreatHuntingJobRequestData
11-
from datadog_api_client.v2.model.run_threat_hunting_job_request_data_type import RunThreatHuntingJobRequestDataType
10+
from datadog_api_client.v2.model.run_historical_job_request import RunHistoricalJobRequest
11+
from datadog_api_client.v2.model.run_historical_job_request_attributes import RunHistoricalJobRequestAttributes
12+
from datadog_api_client.v2.model.run_historical_job_request_data import RunHistoricalJobRequestData
13+
from datadog_api_client.v2.model.run_historical_job_request_data_type import RunHistoricalJobRequestDataType
1214
from datadog_api_client.v2.model.security_monitoring_rule_case_create import SecurityMonitoringRuleCaseCreate
1315
from datadog_api_client.v2.model.security_monitoring_rule_evaluation_window import (
1416
SecurityMonitoringRuleEvaluationWindow,
@@ -21,18 +23,16 @@
2123
SecurityMonitoringRuleQueryAggregation,
2224
)
2325
from datadog_api_client.v2.model.security_monitoring_rule_severity import SecurityMonitoringRuleSeverity
24-
from datadog_api_client.v2.model.threat_hunting_job_options import ThreatHuntingJobOptions
25-
from datadog_api_client.v2.model.threat_hunting_job_query import ThreatHuntingJobQuery
2626

27-
body = RunThreatHuntingJobRequest(
28-
data=RunThreatHuntingJobRequestData(
29-
type=RunThreatHuntingJobRequestDataType.HISTORICALDETECTIONSJOBCREATE,
30-
attributes=RunThreatHuntingJobRequestAttributes(
27+
body = RunHistoricalJobRequest(
28+
data=RunHistoricalJobRequestData(
29+
type=RunHistoricalJobRequestDataType.HISTORICALDETECTIONSJOBCREATE,
30+
attributes=RunHistoricalJobRequestAttributes(
3131
job_definition=JobDefinition(
3232
type="log_detection",
3333
name="Excessive number of failed attempts.",
3434
queries=[
35-
ThreatHuntingJobQuery(
35+
HistoricalJobQuery(
3636
query="source:non_existing_src_weekend",
3737
aggregation=SecurityMonitoringRuleQueryAggregation.COUNT,
3838
group_by_fields=[],
@@ -47,7 +47,7 @@
4747
condition="a > 1",
4848
),
4949
],
50-
options=ThreatHuntingJobOptions(
50+
options=HistoricalJobOptions(
5151
keep_alive=SecurityMonitoringRuleKeepAlive.ONE_HOUR,
5252
max_signal_duration=SecurityMonitoringRuleMaxSignalDuration.ONE_DAY,
5353
evaluation_window=SecurityMonitoringRuleEvaluationWindow.FIFTEEN_MINUTES,
@@ -63,9 +63,9 @@
6363
)
6464

6565
configuration = Configuration()
66-
configuration.unstable_operations["run_threat_hunting_job"] = True
66+
configuration.unstable_operations["run_historical_job"] = True
6767
with ApiClient(configuration) as api_client:
6868
api_instance = SecurityMonitoringApi(api_client)
69-
response = api_instance.run_threat_hunting_job(body=body)
69+
response = api_instance.run_historical_job(body=body)
7070

7171
print(response)

‎src/datadog_api_client/configuration.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -299,30 +299,30 @@ def __init__(
299299
"v2.list_aws_cloud_auth_persona_mappings": False,
300300
"v2.activate_content_pack": False,
301301
"v2.bulk_export_security_monitoring_terraform_resources": False,
302-
"v2.cancel_threat_hunting_job": False,
302+
"v2.cancel_historical_job": False,
303303
"v2.convert_job_result_to_signal": False,
304304
"v2.convert_security_monitoring_terraform_resource": False,
305305
"v2.deactivate_content_pack": False,
306-
"v2.delete_threat_hunting_job": False,
306+
"v2.delete_historical_job": False,
307307
"v2.export_security_monitoring_terraform_resource": False,
308308
"v2.get_content_packs_states": False,
309309
"v2.get_finding": False,
310+
"v2.get_historical_job": False,
310311
"v2.get_indicator_of_compromise": False,
311312
"v2.get_rule_version_history": False,
312313
"v2.get_secrets_rules": False,
313314
"v2.get_security_monitoring_histsignal": False,
314315
"v2.get_security_monitoring_histsignals_by_job_id": False,
315-
"v2.get_threat_hunting_job": False,
316316
"v2.list_findings": False,
317+
"v2.list_historical_jobs": False,
317318
"v2.list_indicators_of_compromise": False,
318319
"v2.list_multiple_rulesets": False,
319320
"v2.list_scanned_assets_metadata": False,
320321
"v2.list_security_monitoring_histsignals": False,
321-
"v2.list_threat_hunting_jobs": False,
322322
"v2.list_vulnerabilities": False,
323323
"v2.list_vulnerable_assets": False,
324324
"v2.mute_findings": False,
325-
"v2.run_threat_hunting_job": False,
325+
"v2.run_historical_job": False,
326326
"v2.search_security_monitoring_histsignals": False,
327327
"v2.get_code_coverage_branch_summary": False,
328328
"v2.get_code_coverage_commit_summary": False,

0 commit comments

Comments
 (0)