Skip to content

Commit 68fb26e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add pagination and sorting parameters on suppression list (#3275)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 58a42ad commit 68fb26e

29 files changed

Lines changed: 1351 additions & 96 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49256,6 +49256,18 @@ components:
4925649256
meta:
4925749257
$ref: '#/components/schemas/ResponseMetaAttributes'
4925849258
type: object
49259+
SecurityMonitoringPaginatedSuppressionsResponse:
49260+
description: Response object containing the available suppression rules with
49261+
pagination metadata.
49262+
properties:
49263+
data:
49264+
description: A list of suppressions objects.
49265+
items:
49266+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
49267+
type: array
49268+
meta:
49269+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta'
49270+
type: object
4925949271
SecurityMonitoringReferenceTable:
4926049272
description: Reference tables used in the queries.
4926149273
properties:
@@ -51405,6 +51417,31 @@ components:
5140551417
data:
5140651418
$ref: '#/components/schemas/SecurityMonitoringSuppression'
5140751419
type: object
51420+
SecurityMonitoringSuppressionSort:
51421+
description: The sort parameters used for querying suppression rules.
51422+
enum:
51423+
- name
51424+
- start_date
51425+
- expiration_date
51426+
- update_date
51427+
- enabled
51428+
- -name
51429+
- -start_date
51430+
- -expiration_date
51431+
- -update_date
51432+
- -enabled
51433+
type: string
51434+
x-enum-varnames:
51435+
- NAME
51436+
- START_DATE
51437+
- EXPIRATION_DATE
51438+
- UPDATE_DATE
51439+
- ENABLED
51440+
- NAME_DESCENDING
51441+
- START_DATE_DESCENDING
51442+
- EXPIRATION_DATE_DESCENDING
51443+
- UPDATE_DATE_DESCENDING
51444+
- ENABLED_DESCENDING
5140851445
SecurityMonitoringSuppressionType:
5140951446
default: suppressions
5141051447
description: The type of the resource. The value should always be `suppressions`.
@@ -51500,6 +51537,31 @@ components:
5150051537
required:
5150151538
- data
5150251539
type: object
51540+
SecurityMonitoringSuppressionsMeta:
51541+
description: Metadata for the suppression list response.
51542+
properties:
51543+
page:
51544+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta'
51545+
type: object
51546+
SecurityMonitoringSuppressionsPageMeta:
51547+
description: Pagination metadata.
51548+
properties:
51549+
pageNumber:
51550+
description: Current page number.
51551+
example: 0
51552+
format: int64
51553+
type: integer
51554+
pageSize:
51555+
description: Current page size.
51556+
example: 2
51557+
format: int64
51558+
type: integer
51559+
totalCount:
51560+
description: Total count of suppressions.
51561+
example: 2
51562+
format: int64
51563+
type: integer
51564+
type: object
5150351565
SecurityMonitoringSuppressionsResponse:
5150451566
description: Response object containing the available suppression rules.
5150551567
properties:
@@ -85670,12 +85732,29 @@ paths:
8567085732
required: false
8567185733
schema:
8567285734
type: string
85735+
- description: Attribute used to sort the list of suppression rules. Prefix
85736+
with `-` to sort in descending order.
85737+
in: query
85738+
name: sort
85739+
required: false
85740+
schema:
85741+
$ref: '#/components/schemas/SecurityMonitoringSuppressionSort'
85742+
- description: Size for a given page. Use `-1` to return all items.
85743+
in: query
85744+
name: page[size]
85745+
required: false
85746+
schema:
85747+
default: -1
85748+
example: 10
85749+
format: int64
85750+
type: integer
85751+
- $ref: '#/components/parameters/PageNumber'
8567385752
responses:
8567485753
'200':
8567585754
content:
8567685755
application/json:
8567785756
schema:
85678-
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
85757+
$ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse'
8567985758
description: OK
8568085759
'403':
8568185760
$ref: '#/components/responses/NotAuthorizedResponse'
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-11-07T12:27:26.759Z"
1+
"2026-01-14T17:29:03.168Z"

cassettes/v2/Security-Monitoring_1187227211/Delete-a-suppression-rule-returns-OK-response_1910387314/recording.har

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "f181dcedeb3ebfdd020a40965b7229b2",
11+
"_id": "54e5a3405de48285a606324efbc11f5d",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 334,
15+
"bodySize": 346,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -32,17 +32,17 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"description\":\"Test-Delete_a_suppression_rule_returns_OK_response-1762518446\",\"enabled\":true,\"name\":\"Test-Delete_a_suppression_rule_returns_OK_response-1762518446\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"technique:T1110-brute-force\",\"source:cloudtrail\"]},\"type\":\"suppressions\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"description\":\"Test-Delete_a_suppression_rule_returns_OK_response-1768411743\",\"enabled\":true,\"name\":\"suppression Test-Delete_a_suppression_rule_returns_OK_response-1768411743\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"technique:T1110-brute-force\",\"source:cloudtrail\"]},\"type\":\"suppressions\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions"
3939
},
4040
"response": {
41-
"bodySize": 625,
41+
"bodySize": 637,
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
44-
"size": 625,
45-
"text": "{\"data\":{\"id\":\"uea-lab-big\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1762518447002,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Delete_a_suppression_rule_returns_OK_response-1762518446\",\"editable\":true,\"enabled\":true,\"name\":\"Test-Delete_a_suppression_rule_returns_OK_response-1762518446\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1762518447002,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
44+
"size": 637,
45+
"text": "{\"data\":{\"id\":\"itm-ljs-0qw\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1768411744411,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Delete_a_suppression_rule_returns_OK_response-1768411743\",\"editable\":true,\"enabled\":true,\"name\":\"suppression Test-Delete_a_suppression_rule_returns_OK_response-1768411743\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1768411744411,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -57,11 +57,11 @@
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2025-11-07T12:27:26.761Z",
61-
"time": 302
60+
"startedDateTime": "2026-01-14T17:29:04.128Z",
61+
"time": 327
6262
},
6363
{
64-
"_id": "2b54ce26df1a55f283769da4db5d8f64",
64+
"_id": "e9742d918c62939615fd0a073429f463",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -74,11 +74,11 @@
7474
"value": "*/*"
7575
}
7676
],
77-
"headersSize": 564,
77+
"headersSize": 563,
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/uea-lab-big"
81+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/itm-ljs-0qw"
8282
},
8383
"response": {
8484
"bodySize": 0,
@@ -94,11 +94,11 @@
9494
"status": 204,
9595
"statusText": "No Content"
9696
},
97-
"startedDateTime": "2025-11-07T12:27:27.069Z",
98-
"time": 276
97+
"startedDateTime": "2026-01-14T17:29:04.473Z",
98+
"time": 169
9999
},
100100
{
101-
"_id": "2b54ce26df1a55f283769da4db5d8f64",
101+
"_id": "e9742d918c62939615fd0a073429f463",
102102
"_order": 1,
103103
"cache": {},
104104
"request": {
@@ -115,14 +115,14 @@
115115
"httpVersion": "HTTP/1.1",
116116
"method": "DELETE",
117117
"queryString": [],
118-
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/uea-lab-big"
118+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/itm-ljs-0qw"
119119
},
120120
"response": {
121121
"bodySize": 67,
122122
"content": {
123123
"mimeType": "application/json",
124124
"size": 67,
125-
"text": "{\"errors\":[\"not_found(Suppression with ID uea-lab-big not found)\"]}"
125+
"text": "{\"errors\":[\"not_found(Suppression with ID itm-ljs-0qw not found)\"]}"
126126
},
127127
"cookies": [],
128128
"headers": [
@@ -137,8 +137,8 @@
137137
"status": 404,
138138
"statusText": "Not Found"
139139
},
140-
"startedDateTime": "2025-11-07T12:27:27.350Z",
141-
"time": 274
140+
"startedDateTime": "2026-01-14T17:29:04.649Z",
141+
"time": 154
142142
}
143143
],
144144
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-11-07T12:27:27.654Z"
1+
"2026-01-14T17:29:04.856Z"

cassettes/v2/Security-Monitoring_1187227211/Get-a-suppression-rule-returns-OK-response_1191933161/recording.har

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "de8b198e3f08189dbac58243a23a6c6e",
11+
"_id": "0f0810a4bb6ed06b4e28254f21a399de",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 328,
15+
"bodySize": 340,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -26,23 +26,23 @@
2626
"value": "application/json"
2727
}
2828
],
29-
"headersSize": 616,
29+
"headersSize": 615,
3030
"httpVersion": "HTTP/1.1",
3131
"method": "POST",
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"enabled\":true,\"name\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"technique:T1110-brute-force\",\"source:cloudtrail\"]},\"type\":\"suppressions\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"enabled\":true,\"name\":\"suppression Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"technique:T1110-brute-force\",\"source:cloudtrail\"]},\"type\":\"suppressions\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions"
3939
},
4040
"response": {
41-
"bodySize": 619,
41+
"bodySize": 631,
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
44-
"size": 619,
45-
"text": "{\"data\":{\"id\":\"ylq-igi-icg\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1762518447901,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"editable\":true,\"enabled\":true,\"name\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1762518447901,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
44+
"size": 631,
45+
"text": "{\"data\":{\"id\":\"xno-kwg-8df\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1768411744987,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"editable\":true,\"enabled\":true,\"name\":\"suppression Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1768411744987,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -57,11 +57,11 @@
5757
"status": 200,
5858
"statusText": "OK"
5959
},
60-
"startedDateTime": "2025-11-07T12:27:27.657Z",
61-
"time": 304
60+
"startedDateTime": "2026-01-14T17:29:04.859Z",
61+
"time": 173
6262
},
6363
{
64-
"_id": "e4ea82bb59631f7b73f1b145f01a869a",
64+
"_id": "42e4b15c099bb6082f86850e2b995bfa",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -74,18 +74,18 @@
7474
"value": "application/json"
7575
}
7676
],
77-
"headersSize": 571,
77+
"headersSize": 570,
7878
"httpVersion": "HTTP/1.1",
7979
"method": "GET",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/ylq-igi-icg"
81+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/xno-kwg-8df"
8282
},
8383
"response": {
84-
"bodySize": 619,
84+
"bodySize": 631,
8585
"content": {
8686
"mimeType": "application/vnd.api+json",
87-
"size": 619,
88-
"text": "{\"data\":{\"id\":\"ylq-igi-icg\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1762518447901,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"editable\":true,\"enabled\":true,\"name\":\"Test-Get_a_suppression_rule_returns_OK_response-1762518447\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1762518447901,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
87+
"size": 631,
88+
"text": "{\"data\":{\"id\":\"xno-kwg-8df\",\"type\":\"suppressions\",\"attributes\":{\"creation_date\":1768411744987,\"creator\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"data_exclusion_query\":\"\",\"description\":\"Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"editable\":true,\"enabled\":true,\"name\":\"suppression Test-Get_a_suppression_rule_returns_OK_response-1768411744\",\"rule_query\":\"source:cloudtrail\",\"suppression_query\":\"env:test\",\"tags\":[\"source:cloudtrail\",\"technique:T1110-brute-force\"],\"update_date\":1768411744987,\"updater\":{\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"name\":\"CI Account\"},\"version\":1}}}"
8989
},
9090
"cookies": [],
9191
"headers": [
@@ -100,11 +100,11 @@
100100
"status": 200,
101101
"statusText": "OK"
102102
},
103-
"startedDateTime": "2025-11-07T12:27:27.967Z",
104-
"time": 296
103+
"startedDateTime": "2026-01-14T17:29:05.036Z",
104+
"time": 134
105105
},
106106
{
107-
"_id": "eb9719a899ec7157d4613899c802b2f0",
107+
"_id": "b106773a5ae2b87df8cb461ca79195e7",
108108
"_order": 0,
109109
"cache": {},
110110
"request": {
@@ -121,7 +121,7 @@
121121
"httpVersion": "HTTP/1.1",
122122
"method": "DELETE",
123123
"queryString": [],
124-
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/ylq-igi-icg"
124+
"url": "https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/xno-kwg-8df"
125125
},
126126
"response": {
127127
"bodySize": 0,
@@ -137,8 +137,8 @@
137137
"status": 204,
138138
"statusText": "No Content"
139139
},
140-
"startedDateTime": "2025-11-07T12:27:28.268Z",
141-
"time": 301
140+
"startedDateTime": "2026-01-14T17:29:05.175Z",
141+
"time": 137
142142
}
143143
],
144144
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-11-26T13:33:06.482Z"
1+
"2026-01-14T17:29:05.317Z"

0 commit comments

Comments
 (0)