Skip to content

Commit 019be4e

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 (#2912)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent e4dd2c5 commit 019be4e

File tree

65 files changed

+867
-801
lines changed

Some content is hidden

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

65 files changed

+867
-801
lines changed

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

Lines changed: 200 additions & 199 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
@@ -9195,55 +9195,6 @@ datadog\_api\_client.v2.model.group\_tags module
91959195
:members:
91969196
:show-inheritance:
91979197

9198-
datadog\_api\_client.v2.model.historical\_job\_data\_type module
9199-
----------------------------------------------------------------
9200-
9201-
.. automodule:: datadog_api_client.v2.model.historical_job_data_type
9202-
:members:
9203-
:show-inheritance:
9204-
9205-
datadog\_api\_client.v2.model.historical\_job\_list\_meta module
9206-
----------------------------------------------------------------
9207-
9208-
.. automodule:: datadog_api_client.v2.model.historical_job_list_meta
9209-
:members:
9210-
:show-inheritance:
9211-
9212-
datadog\_api\_client.v2.model.historical\_job\_options module
9213-
-------------------------------------------------------------
9214-
9215-
.. automodule:: datadog_api_client.v2.model.historical_job_options
9216-
:members:
9217-
:show-inheritance:
9218-
9219-
datadog\_api\_client.v2.model.historical\_job\_query module
9220-
-----------------------------------------------------------
9221-
9222-
.. automodule:: datadog_api_client.v2.model.historical_job_query
9223-
:members:
9224-
:show-inheritance:
9225-
9226-
datadog\_api\_client.v2.model.historical\_job\_response module
9227-
--------------------------------------------------------------
9228-
9229-
.. automodule:: datadog_api_client.v2.model.historical_job_response
9230-
:members:
9231-
:show-inheritance:
9232-
9233-
datadog\_api\_client.v2.model.historical\_job\_response\_attributes module
9234-
--------------------------------------------------------------------------
9235-
9236-
.. automodule:: datadog_api_client.v2.model.historical_job_response_attributes
9237-
:members:
9238-
:show-inheritance:
9239-
9240-
datadog\_api\_client.v2.model.historical\_job\_response\_data module
9241-
--------------------------------------------------------------------
9242-
9243-
.. automodule:: datadog_api_client.v2.model.historical_job_response_data
9244-
:members:
9245-
:show-inheritance:
9246-
92479198
datadog\_api\_client.v2.model.hourly\_usage module
92489199
--------------------------------------------------
92499200

@@ -11617,13 +11568,6 @@ datadog\_api\_client.v2.model.list\_findings\_response module
1161711568
:members:
1161811569
:show-inheritance:
1161911570

11620-
datadog\_api\_client.v2.model.list\_historical\_jobs\_response module
11621-
---------------------------------------------------------------------
11622-
11623-
.. automodule:: datadog_api_client.v2.model.list_historical_jobs_response
11624-
:members:
11625-
:show-inheritance:
11626-
1162711571
datadog\_api\_client.v2.model.list\_kind\_catalog\_response module
1162811572
------------------------------------------------------------------
1162911573

@@ -11722,6 +11666,13 @@ datadog\_api\_client.v2.model.list\_teams\_sort module
1172211666
:members:
1172311667
:show-inheritance:
1172411668

11669+
datadog\_api\_client.v2.model.list\_threat\_hunting\_jobs\_response module
11670+
--------------------------------------------------------------------------
11671+
11672+
.. automodule:: datadog_api_client.v2.model.list_threat_hunting_jobs_response
11673+
:members:
11674+
:show-inheritance:
11675+
1172511676
datadog\_api\_client.v2.model.list\_vulnerabilities\_response module
1172611677
--------------------------------------------------------------------
1172711678

@@ -18358,31 +18309,31 @@ datadog\_api\_client.v2.model.rum\_warning module
1835818309
:members:
1835918310
:show-inheritance:
1836018311

18361-
datadog\_api\_client.v2.model.run\_historical\_job\_request module
18362-
------------------------------------------------------------------
18312+
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request module
18313+
-----------------------------------------------------------------------
1836318314

18364-
.. automodule:: datadog_api_client.v2.model.run_historical_job_request
18315+
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request
1836518316
:members:
1836618317
:show-inheritance:
1836718318

18368-
datadog\_api\_client.v2.model.run\_historical\_job\_request\_attributes module
18369-
------------------------------------------------------------------------------
18319+
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_attributes module
18320+
-----------------------------------------------------------------------------------
1837018321

18371-
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_attributes
18322+
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_attributes
1837218323
:members:
1837318324
:show-inheritance:
1837418325

18375-
datadog\_api\_client.v2.model.run\_historical\_job\_request\_data module
18376-
------------------------------------------------------------------------
18326+
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_data module
18327+
-----------------------------------------------------------------------------
1837718328

18378-
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_data
18329+
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_data
1837918330
:members:
1838018331
:show-inheritance:
1838118332

18382-
datadog\_api\_client.v2.model.run\_historical\_job\_request\_data\_type module
18383-
------------------------------------------------------------------------------
18333+
datadog\_api\_client.v2.model.run\_threat\_hunting\_job\_request\_data\_type module
18334+
-----------------------------------------------------------------------------------
1838418335

18385-
.. automodule:: datadog_api_client.v2.model.run_historical_job_request_data_type
18336+
.. automodule:: datadog_api_client.v2.model.run_threat_hunting_job_request_data_type
1838618337
:members:
1838718338
:show-inheritance:
1838818339

@@ -22229,6 +22180,55 @@ datadog\_api\_client.v2.model.teams\_response\_meta\_pagination module
2222922180
:members:
2223022181
:show-inheritance:
2223122182

22183+
datadog\_api\_client.v2.model.threat\_hunting\_job\_data\_type module
22184+
---------------------------------------------------------------------
22185+
22186+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_data_type
22187+
:members:
22188+
:show-inheritance:
22189+
22190+
datadog\_api\_client.v2.model.threat\_hunting\_job\_list\_meta module
22191+
---------------------------------------------------------------------
22192+
22193+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_list_meta
22194+
:members:
22195+
:show-inheritance:
22196+
22197+
datadog\_api\_client.v2.model.threat\_hunting\_job\_options module
22198+
------------------------------------------------------------------
22199+
22200+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_options
22201+
:members:
22202+
:show-inheritance:
22203+
22204+
datadog\_api\_client.v2.model.threat\_hunting\_job\_query module
22205+
----------------------------------------------------------------
22206+
22207+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_query
22208+
:members:
22209+
:show-inheritance:
22210+
22211+
datadog\_api\_client.v2.model.threat\_hunting\_job\_response module
22212+
-------------------------------------------------------------------
22213+
22214+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response
22215+
:members:
22216+
:show-inheritance:
22217+
22218+
datadog\_api\_client.v2.model.threat\_hunting\_job\_response\_attributes module
22219+
-------------------------------------------------------------------------------
22220+
22221+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response_attributes
22222+
:members:
22223+
:show-inheritance:
22224+
22225+
datadog\_api\_client.v2.model.threat\_hunting\_job\_response\_data module
22226+
-------------------------------------------------------------------------
22227+
22228+
.. automodule:: datadog_api_client.v2.model.threat_hunting_job_response_data
22229+
:members:
22230+
:show-inheritance:
22231+
2223222232
datadog\_api\_client.v2.model.time\_restriction module
2223322233
------------------------------------------------------
2223422234

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Cancel a threat hunting job returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["cancel_threat_hunting_job"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = SecurityMonitoringApi(api_client)
12+
api_instance.cancel_threat_hunting_job(
13+
job_id="job_id",
14+
)

examples/v2/security-monitoring/CancelHistoricalJob.py renamed to examples/v2/security-monitoring/CancelThreatHuntingJob_1945505845.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 "historical_job" in the system
10-
HISTORICAL_JOB_DATA_ID = environ["HISTORICAL_JOB_DATA_ID"]
9+
# there is a valid "threat_hunting_job" in the system
10+
THREAT_HUNTING_JOB_DATA_ID = environ["THREAT_HUNTING_JOB_DATA_ID"]
1111

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

examples/v2/security-monitoring/DeleteHistoricalJob.py renamed to examples/v2/security-monitoring/DeleteThreatHuntingJob.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_historical_job"] = True
9+
configuration.unstable_operations["delete_threat_hunting_job"] = True
1010
with ApiClient(configuration) as api_client:
1111
api_instance = SecurityMonitoringApi(api_client)
12-
api_instance.delete_historical_job(
12+
api_instance.delete_threat_hunting_job(
1313
job_id="job_id",
1414
)

examples/v2/security-monitoring/GetHistoricalJob.py renamed to examples/v2/security-monitoring/GetThreatHuntingJob.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 "historical_job" in the system
10-
HISTORICAL_JOB_DATA_ID = environ["HISTORICAL_JOB_DATA_ID"]
9+
# there is a valid "threat_hunting_job" in the system
10+
THREAT_HUNTING_JOB_DATA_ID = environ["THREAT_HUNTING_JOB_DATA_ID"]
1111

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

2121
print(response)

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
List threat hunting jobs returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_threat_hunting_jobs"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = SecurityMonitoringApi(api_client)
12+
response = api_instance.list_threat_hunting_jobs()
13+
14+
print(response)

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
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 "historical_job" in the system
10-
HISTORICAL_JOB_DATA_ID = environ["HISTORICAL_JOB_DATA_ID"]
9+
# there is a valid "threat_hunting_job" in the system
10+
THREAT_HUNTING_JOB_DATA_ID = environ["THREAT_HUNTING_JOB_DATA_ID"]
1111

1212
configuration = Configuration()
13-
configuration.unstable_operations["list_historical_jobs"] = True
14-
configuration.unstable_operations["run_historical_job"] = True
13+
configuration.unstable_operations["list_threat_hunting_jobs"] = True
14+
configuration.unstable_operations["run_threat_hunting_job"] = True
1515
with ApiClient(configuration) as api_client:
1616
api_instance = SecurityMonitoringApi(api_client)
17-
response = api_instance.list_historical_jobs(
17+
response = api_instance.list_threat_hunting_jobs(
1818
filter_query="id:string",
1919
)
2020

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
"""
2-
Run a historical job returns "Status created" response
2+
Run a threat hunting 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
97
from datadog_api_client.v2.model.job_definition import JobDefinition
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
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
1412
from datadog_api_client.v2.model.security_monitoring_rule_case_create import SecurityMonitoringRuleCaseCreate
1513
from datadog_api_client.v2.model.security_monitoring_rule_evaluation_window import (
1614
SecurityMonitoringRuleEvaluationWindow,
@@ -23,16 +21,18 @@
2321
SecurityMonitoringRuleQueryAggregation,
2422
)
2523
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 = RunHistoricalJobRequest(
28-
data=RunHistoricalJobRequestData(
29-
type=RunHistoricalJobRequestDataType.HISTORICALDETECTIONSJOBCREATE,
30-
attributes=RunHistoricalJobRequestAttributes(
27+
body = RunThreatHuntingJobRequest(
28+
data=RunThreatHuntingJobRequestData(
29+
type=RunThreatHuntingJobRequestDataType.HISTORICALDETECTIONSJOBCREATE,
30+
attributes=RunThreatHuntingJobRequestAttributes(
3131
job_definition=JobDefinition(
3232
type="log_detection",
3333
name="Excessive number of failed attempts.",
3434
queries=[
35-
HistoricalJobQuery(
35+
ThreatHuntingJobQuery(
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=HistoricalJobOptions(
50+
options=ThreatHuntingJobOptions(
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_historical_job"] = True
66+
configuration.unstable_operations["run_threat_hunting_job"] = True
6767
with ApiClient(configuration) as api_client:
6868
api_instance = SecurityMonitoringApi(api_client)
69-
response = api_instance.run_historical_job(body=body)
69+
response = api_instance.run_threat_hunting_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
@@ -245,24 +245,24 @@ def __init__(
245245
"v2.get_open_api": False,
246246
"v2.list_apis": False,
247247
"v2.update_open_api": False,
248-
"v2.cancel_historical_job": False,
248+
"v2.cancel_threat_hunting_job": False,
249249
"v2.convert_job_result_to_signal": False,
250-
"v2.delete_historical_job": False,
250+
"v2.delete_threat_hunting_job": False,
251251
"v2.get_finding": False,
252-
"v2.get_historical_job": False,
253252
"v2.get_rule_version_history": False,
254253
"v2.get_sbom": False,
255254
"v2.get_security_monitoring_histsignal": False,
256255
"v2.get_security_monitoring_histsignals_by_job_id": False,
256+
"v2.get_threat_hunting_job": False,
257257
"v2.list_assets_sbo_ms": False,
258258
"v2.list_findings": False,
259-
"v2.list_historical_jobs": False,
260259
"v2.list_scanned_assets_metadata": False,
261260
"v2.list_security_monitoring_histsignals": False,
261+
"v2.list_threat_hunting_jobs": False,
262262
"v2.list_vulnerabilities": False,
263263
"v2.list_vulnerable_assets": False,
264264
"v2.mute_findings": False,
265-
"v2.run_historical_job": False,
265+
"v2.run_threat_hunting_job": False,
266266
"v2.search_security_monitoring_histsignals": False,
267267
"v2.create_dataset": False,
268268
"v2.delete_dataset": False,

0 commit comments

Comments
 (0)