Skip to content
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.

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

Add support for retrieving a security signal by ID #1175

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.4",
"regenerated": "2022-09-23 09:09:11.716130",
"spec_repo_commit": "7f715655"
"regenerated": "2022-09-26 07:50:59.044671",
"spec_repo_commit": "af78fdc4"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2022-09-23 09:09:11.728594",
"spec_repo_commit": "7f715655"
"regenerated": "2022-09-26 07:50:59.064886",
"spec_repo_commit": "af78fdc4"
}
}
}
25 changes: 25 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12863,6 +12863,31 @@ paths:
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
/api/v2/security_monitoring/signals/{signal_id}:
get:
description: Get a signal's details.
operationId: GetSecurityMonitoringSignal
parameters:
- $ref: '#/components/parameters/SignalID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityMonitoringSignal'
description: OK
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- security_monitoring_rules_read
summary: Get a signal's details
tags:
- Security Monitoring
/api/v2/security_monitoring/signals/{signal_id}/assignee:
patch:
description: Modify the triage assignee of a security signal.
Expand Down
15 changes: 15 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringSignal.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Get a signal's details returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_monitoring_signal(
signal_id="AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptMDdQUnF3QUE",
)

print(response)
42 changes: 42 additions & 0 deletions src/datadog_api_client/v2/api/security_monitoring_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,31 @@ def __init__(self, api_client=None):
api_client=api_client,
)

self._get_security_monitoring_signal_endpoint = _Endpoint(
settings={
"response_type": (SecurityMonitoringSignal,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/security_monitoring/signals/{signal_id}",
"operation_id": "get_security_monitoring_signal",
"http_method": "GET",
"version": "v2",
"servers": None,
},
params_map={
"signal_id": {
"required": True,
"openapi_types": (str,),
"attribute": "signal_id",
"location": "path",
},
},
headers_map={
"accept": ["application/json"],
"content_type": [],
},
api_client=api_client,
)

self._list_security_filters_endpoint = _Endpoint(
settings={
"response_type": (SecurityFiltersResponse,),
Expand Down Expand Up @@ -620,6 +645,23 @@ def get_security_monitoring_rule(

return self._get_security_monitoring_rule_endpoint.call_with_http_info(**kwargs)

def get_security_monitoring_signal(
self,
signal_id: str,
) -> SecurityMonitoringSignal:
"""Get a signal's details.

Get a signal's details.

:param signal_id: The ID of the signal.
:type signal_id: str
:rtype: SecurityMonitoringSignal
"""
kwargs: Dict[str, Any] = {}
kwargs["signal_id"] = signal_id

return self._get_security_monitoring_signal_endpoint.call_with_http_info(**kwargs)

def list_security_filters(
self,
) -> SecurityFiltersResponse:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2022-09-23T14:12:23.353Z
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
interactions:
- request:
body: null
headers:
accept:
- application/json
method: GET
uri: https://api.datadoghq.com/api/v2/security_monitoring/signals/AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptCL3QUEm3nt2
response:
body:
string: '{"errors":["Signal not found"]}'
headers:
content-type:
- application/json
status:
code: 404
message: Not Found
version: 1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2022-09-23T14:12:23.776Z
Loading