Skip to content

Commit 4a66de4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Document signals triage update endpoints (#3742)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 1139196 commit 4a66de4

File tree

11 files changed

+1577
-0
lines changed

11 files changed

+1577
-0
lines changed

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

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64574,6 +64574,38 @@ components:
6457464574
type: string
6457564575
x-enum-varnames:
6457664576
- SIGNAL
64577+
SecurityMonitoringSignalUpdateAttributes:
64578+
description: Attributes for updating the triage state or assignee of a security signal.
64579+
properties:
64580+
archive_comment:
64581+
$ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment"
64582+
archive_reason:
64583+
$ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason"
64584+
assignee:
64585+
$ref: "#/components/schemas/SecurityMonitoringTriageUser"
64586+
state:
64587+
$ref: "#/components/schemas/SecurityMonitoringSignalState"
64588+
version:
64589+
$ref: "#/components/schemas/SecurityMonitoringSignalVersion"
64590+
type: object
64591+
SecurityMonitoringSignalUpdateData:
64592+
description: Data containing the triage state or assignee update for a security signal.
64593+
properties:
64594+
attributes:
64595+
$ref: "#/components/schemas/SecurityMonitoringSignalUpdateAttributes"
64596+
type:
64597+
$ref: "#/components/schemas/SecurityMonitoringSignalMetadataType"
64598+
required:
64599+
- attributes
64600+
type: object
64601+
SecurityMonitoringSignalUpdateRequest:
64602+
description: Request body for updating the triage state or assignee of a security signal.
64603+
properties:
64604+
data:
64605+
$ref: "#/components/schemas/SecurityMonitoringSignalUpdateData"
64606+
required:
64607+
- data
64608+
type: object
6457764609
SecurityMonitoringSignalVersion:
6457864610
description: Version of the updated signal. If server side version is higher, update will be rejected.
6457964611
format: int64
@@ -64727,6 +64759,33 @@ components:
6472764759
- count
6472864760
- events
6472964761
type: object
64762+
SecurityMonitoringSignalsBulkUpdateData:
64763+
description: Data for updating a single security signal in a bulk update operation.
64764+
properties:
64765+
attributes:
64766+
$ref: "#/components/schemas/SecurityMonitoringSignalUpdateAttributes"
64767+
id:
64768+
description: The unique ID of the security signal.
64769+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
64770+
type: string
64771+
type:
64772+
$ref: "#/components/schemas/SecurityMonitoringSignalType"
64773+
required:
64774+
- id
64775+
- attributes
64776+
type: object
64777+
SecurityMonitoringSignalsBulkUpdateRequest:
64778+
description: Request body for updating multiple attributes of multiple security signals.
64779+
properties:
64780+
data:
64781+
description: An array of signal updates.
64782+
items:
64783+
$ref: "#/components/schemas/SecurityMonitoringSignalsBulkUpdateData"
64784+
maxItems: 199
64785+
type: array
64786+
required:
64787+
- data
64788+
type: object
6473064789
SecurityMonitoringSignalsListResponse:
6473164790
description: "The response object with all security signals matching the request\nand pagination information."
6473264791
properties:
@@ -119533,6 +119592,51 @@ paths:
119533119592
operator: OR
119534119593
permissions:
119535119594
- security_monitoring_signals_write
119595+
/api/v2/security_monitoring/signals/bulk/update:
119596+
patch:
119597+
description: |-
119598+
Update the triage state or assignee of multiple security signals at once.
119599+
The maximum number of signals that can be updated in a single request is 199.
119600+
operationId: BulkEditSecurityMonitoringSignals
119601+
requestBody:
119602+
content:
119603+
application/json:
119604+
schema:
119605+
$ref: "#/components/schemas/SecurityMonitoringSignalsBulkUpdateRequest"
119606+
description: Attributes describing the signal updates.
119607+
required: true
119608+
responses:
119609+
"200":
119610+
content:
119611+
application/json:
119612+
schema:
119613+
$ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse"
119614+
description: OK
119615+
"400":
119616+
content:
119617+
application/json:
119618+
schema:
119619+
$ref: "#/components/schemas/JSONAPIErrorResponse"
119620+
description: Bad Request
119621+
"403":
119622+
content:
119623+
application/json:
119624+
schema:
119625+
$ref: "#/components/schemas/JSONAPIErrorResponse"
119626+
description: Forbidden
119627+
"429":
119628+
$ref: "#/components/responses/TooManyRequestsResponse"
119629+
security:
119630+
- apiKeyAuth: []
119631+
appKeyAuth: []
119632+
- AuthZ: []
119633+
summary: Bulk update security signals
119634+
tags: ["Security Monitoring"]
119635+
x-codegen-request-body-name: body
119636+
"x-permission":
119637+
operator: OR
119638+
permissions:
119639+
- security_monitoring_signals_write
119536119640
/api/v2/security_monitoring/signals/search:
119537119641
post:
119538119642
description: |-
@@ -119855,6 +119959,58 @@ paths:
119855119959
permissions:
119856119960
- security_monitoring_rules_read
119857119961
- security_monitoring_signals_read
119962+
/api/v2/security_monitoring/signals/{signal_id}/update:
119963+
patch:
119964+
description: |-
119965+
Update the triage state or assignee of a security signal.
119966+
operationId: EditSecurityMonitoringSignal
119967+
parameters:
119968+
- $ref: "#/components/parameters/SignalID"
119969+
requestBody:
119970+
content:
119971+
application/json:
119972+
schema:
119973+
$ref: "#/components/schemas/SecurityMonitoringSignalUpdateRequest"
119974+
description: Attributes describing the signal triage state or assignee update.
119975+
required: true
119976+
responses:
119977+
"200":
119978+
content:
119979+
application/json:
119980+
schema:
119981+
$ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse"
119982+
description: OK
119983+
"400":
119984+
content:
119985+
application/json:
119986+
schema:
119987+
$ref: "#/components/schemas/JSONAPIErrorResponse"
119988+
description: Bad Request
119989+
"403":
119990+
content:
119991+
application/json:
119992+
schema:
119993+
$ref: "#/components/schemas/JSONAPIErrorResponse"
119994+
description: Forbidden
119995+
"404":
119996+
content:
119997+
application/json:
119998+
schema:
119999+
$ref: "#/components/schemas/JSONAPIErrorResponse"
120000+
description: Not Found
120001+
"429":
120002+
$ref: "#/components/responses/TooManyRequestsResponse"
120003+
security:
120004+
- apiKeyAuth: []
120005+
appKeyAuth: []
120006+
- AuthZ: []
120007+
summary: Update security signal triage state or assignee
120008+
tags: ["Security Monitoring"]
120009+
x-codegen-request-body-name: body
120010+
"x-permission":
120011+
operator: OR
120012+
permissions:
120013+
- security_monitoring_signals_write
119858120014
/api/v2/security_monitoring/terraform/{resource_type}/bulk:
119859120015
post:
119860120016
description: |-

‎examples/v2/security-monitoring/BulkEditSecurityMonitoringSignals.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Bulk update security signals returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalArchiveReason;
7+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalState;
8+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalType;
9+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalUpdateAttributes;
10+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalsBulkTriageUpdateResponse;
11+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalsBulkUpdateData;
12+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalsBulkUpdateRequest;
13+
import com.datadog.api.client.v2.model.SecurityMonitoringTriageUser;
14+
import java.util.Collections;
15+
16+
public class Example {
17+
public static void main(String[] args) {
18+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
19+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
20+
21+
SecurityMonitoringSignalsBulkUpdateRequest body =
22+
new SecurityMonitoringSignalsBulkUpdateRequest()
23+
.data(
24+
Collections.singletonList(
25+
new SecurityMonitoringSignalsBulkUpdateData()
26+
.attributes(
27+
new SecurityMonitoringSignalUpdateAttributes()
28+
.archiveReason(SecurityMonitoringSignalArchiveReason.NONE)
29+
.assignee(
30+
new SecurityMonitoringTriageUser()
31+
.uuid("773b045d-ccf8-4808-bd3b-955ef6a8c940"))
32+
.state(SecurityMonitoringSignalState.OPEN))
33+
.id("AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA")
34+
.type(SecurityMonitoringSignalType.SIGNAL)));
35+
36+
try {
37+
SecurityMonitoringSignalsBulkTriageUpdateResponse result =
38+
apiInstance.bulkEditSecurityMonitoringSignals(body);
39+
System.out.println(result);
40+
} catch (ApiException e) {
41+
System.err.println(
42+
"Exception when calling SecurityMonitoringApi#bulkEditSecurityMonitoringSignals");
43+
System.err.println("Status code: " + e.getCode());
44+
System.err.println("Reason: " + e.getResponseBody());
45+
System.err.println("Response headers: " + e.getResponseHeaders());
46+
e.printStackTrace();
47+
}
48+
}
49+
}

‎examples/v2/security-monitoring/EditSecurityMonitoringSignal.java‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Update security signal triage state or assignee returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalArchiveReason;
7+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalMetadataType;
8+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalState;
9+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalTriageUpdateResponse;
10+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalUpdateAttributes;
11+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalUpdateData;
12+
import com.datadog.api.client.v2.model.SecurityMonitoringSignalUpdateRequest;
13+
import com.datadog.api.client.v2.model.SecurityMonitoringTriageUser;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
19+
20+
SecurityMonitoringSignalUpdateRequest body =
21+
new SecurityMonitoringSignalUpdateRequest()
22+
.data(
23+
new SecurityMonitoringSignalUpdateData()
24+
.attributes(
25+
new SecurityMonitoringSignalUpdateAttributes()
26+
.archiveReason(SecurityMonitoringSignalArchiveReason.NONE)
27+
.assignee(
28+
new SecurityMonitoringTriageUser()
29+
.uuid("773b045d-ccf8-4808-bd3b-955ef6a8c940"))
30+
.state(SecurityMonitoringSignalState.OPEN))
31+
.type(SecurityMonitoringSignalMetadataType.SIGNAL_METADATA));
32+
33+
try {
34+
SecurityMonitoringSignalTriageUpdateResponse result =
35+
apiInstance.editSecurityMonitoringSignal("signal_id", body);
36+
System.out.println(result);
37+
} catch (ApiException e) {
38+
System.err.println(
39+
"Exception when calling SecurityMonitoringApi#editSecurityMonitoringSignal");
40+
System.err.println("Status code: " + e.getCode());
41+
System.err.println("Reason: " + e.getResponseBody());
42+
System.err.println("Response headers: " + e.getResponseHeaders());
43+
e.printStackTrace();
44+
}
45+
}
46+
}

0 commit comments

Comments
 (0)