Datadog/security Suppressions
@webframp/datadog/security-suppressionsv2026.07.20.11
01README
Datadog Security Suppressions — suppression rule management
02Release Notes
2026.07.20.11
Added: Initial code-generated release of @webframp/datadog/security-suppressions with 9 methods covering the Datadog security suppressions API surface.
03Models
@webframp/datadog/security-suppressionsv2026.07.20.11datadog/security_suppressions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiKey | string | Datadog API key (DD-API-KEY) |
| appKey | string | Datadog application key (DD-APPLICATION-KEY) |
| site | enum | Datadog site |
fn list_security_monitoring_suppressions(query?: string, sort?: string)
Get all suppression rules
| Argument | Type | Description |
|---|---|---|
| query? | string | Query string. |
| sort? | string | Attribute used to sort the list of suppression rules. Prefix with `-` to sort... |
fn create_security_monitoring_suppression(data_exclusion_query?: string, description?: string, enabled: boolean, expiration_date?: number, name: string, rule_query: string, start_date?: number, suppression_query?: string, tags?: array)
Create a suppression rule
| Argument | Type | Description |
|---|---|---|
| data_exclusion_query? | string | An exclusion query on the input data of the security rules, which could be lo... |
| description? | string | A description for the suppression rule. |
| enabled | boolean | Whether the suppression rule is enabled. |
| expiration_date? | number | A Unix millisecond timestamp giving an expiration date for the suppression ru... |
| name | string | The name of the suppression rule. |
| rule_query | string | The rule query of the suppression rule, with the same syntax as the search ba... |
| start_date? | number | A Unix millisecond timestamp giving the start date for the suppression rule. ... |
| suppression_query? | string | The suppression query of the suppression rule. If a signal matches this query... |
| tags? | array | List of tags associated with the suppression rule. |
fn get_suppressions_affecting_future_rule(calculatedFields?: array, cases: array, filters?: array, groupSignalsBy?: array, hasExtendedTitle?: boolean, isEnabled: boolean, message: string, name: string, options: unknown, queries: array, referenceTables?: array, schedulingOptions?: unknown, tags?: array, thirdPartyCases?: array, type?: unknown)
Get suppressions affecting future rule
| Argument | Type | Description |
|---|---|---|
| calculatedFields? | array | Calculated fields. Only allowed for scheduled rules - in other words, when sc... |
| cases | array | Cases for generating signals. |
| filters? | array | Additional queries to filter matched events before they are processed. This f... |
| groupSignalsBy? | array | Additional grouping to perform on top of the existing groups in the query sec... |
| hasExtendedTitle? | boolean | Whether the notifications include the triggering group-by values in their title. |
| isEnabled | boolean | Whether the rule is enabled. |
| message | string | Message for generated signals. |
| name | string | The name of the rule. |
| options | unknown | |
| queries | array | Queries for selecting logs which are part of the rule. |
| referenceTables? | array | Reference tables for the rule. |
| schedulingOptions? | unknown | |
| tags? | array | Tags for generated signals. |
| thirdPartyCases? | array | Cases for generating signals from third-party rules. Only available for third... |
| type? | unknown |
fn get_suppressions_affecting_rule(rule_id: string)
Get suppressions affecting a specific rule
| Argument | Type | Description |
|---|---|---|
| rule_id | string | The ID of the rule. |
fn validate_security_monitoring_suppression(data_exclusion_query?: string, description?: string, enabled: boolean, expiration_date?: number, name: string, rule_query: string, start_date?: number, suppression_query?: string, tags?: array)
Validate a suppression rule
| Argument | Type | Description |
|---|---|---|
| data_exclusion_query? | string | An exclusion query on the input data of the security rules, which could be lo... |
| description? | string | A description for the suppression rule. |
| enabled | boolean | Whether the suppression rule is enabled. |
| expiration_date? | number | A Unix millisecond timestamp giving an expiration date for the suppression ru... |
| name | string | The name of the suppression rule. |
| rule_query | string | The rule query of the suppression rule, with the same syntax as the search ba... |
| start_date? | number | A Unix millisecond timestamp giving the start date for the suppression rule. ... |
| suppression_query? | string | The suppression query of the suppression rule. If a signal matches this query... |
| tags? | array | List of tags associated with the suppression rule. |
fn get_security_monitoring_suppression(suppression_id: string)
Get a suppression rule
| Argument | Type | Description |
|---|---|---|
| suppression_id | string | The ID of the suppression rule |
fn update_security_monitoring_suppression(suppression_id: string, data_exclusion_query?: string, description?: string, enabled?: boolean, expiration_date?: number, name?: string, rule_query?: string, start_date?: number, suppression_query?: string, tags?: array, version?: number)
Update a suppression rule
| Argument | Type | Description |
|---|---|---|
| suppression_id | string | The ID of the suppression rule |
| data_exclusion_query? | string | An exclusion query on the input data of the security rules, which could be lo... |
| description? | string | A description for the suppression rule. |
| enabled? | boolean | Whether the suppression rule is enabled. |
| expiration_date? | number | A Unix millisecond timestamp giving an expiration date for the suppression ru... |
| name? | string | The name of the suppression rule. |
| rule_query? | string | The rule query of the suppression rule, with the same syntax as the search ba... |
| start_date? | number | A Unix millisecond timestamp giving the start date for the suppression rule. ... |
| suppression_query? | string | The suppression query of the suppression rule. If a signal matches this query... |
| tags? | array | List of tags associated with the suppression rule. |
| version? | number | The current version of the suppression. This is optional, but it can help pre... |
fn delete_security_monitoring_suppression(suppression_id: string)
Delete a suppression rule
| Argument | Type | Description |
|---|---|---|
| suppression_id | string | The ID of the suppression rule |
fn get_suppression_version_history(suppression_id: string)
Get a suppression's version history
| Argument | Type | Description |
|---|---|---|
| suppression_id | string | The ID of the suppression rule |
Resources
security_monitoring_suppressions(infinite)— Get all suppression rules
security_monitoring_suppression(infinite)— Create a suppression rule
suppressions_affecting_future_rule(infinite)— Get suppressions affecting future rule
suppressions_affecting_rule(infinite)— Get suppressions affecting a specific rule
validate_security_monitoring_suppression(infinite)— Validate a suppression rule
suppression_version_history(infinite)— Get a suppression's version history
04Stats
A
100 / 100
Downloads
0
Archive size
16.1 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels