monitoring_suppressions
Creates, updates, deletes, gets or lists a monitoring_suppressions
resource.
Overview
Name | monitoring_suppressions |
Type | Resource |
Id | datadog.security.monitoring_suppressions |
Fields
The following fields are returned by SELECT
queries:
- get_security_monitoring_suppression
- list_security_monitoring_suppressions
Name | Datatype | Description |
---|---|---|
id | string | The ID of the suppression rule. (example: 3dd-0uc-h1s) |
attributes | object | The attributes of the suppression rule. |
type | string | The type of the resource. The value should always be suppressions . (default: suppressions, example: suppressions) |
Name | Datatype | Description |
---|---|---|
id | string | The ID of the suppression rule. (example: 3dd-0uc-h1s) |
attributes | object | The attributes of the suppression rule. |
type | string | The type of the resource. The value should always be suppressions . (default: suppressions, example: suppressions) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_security_monitoring_suppression | select | suppression_id , region | Get the details of a specific suppression rule. | |
list_security_monitoring_suppressions | select | region | Get the list of all suppression rules. | |
create_security_monitoring_suppression | insert | region , data__data | Create a new suppression rule. | |
update_security_monitoring_suppression | update | suppression_id , region , data__data | Update a specific suppression rule. | |
delete_security_monitoring_suppression | delete | suppression_id , region | Delete a specific suppression rule. | |
validate_security_monitoring_suppression | exec | region , data | Validate a suppression rule. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
region | string | (default: datadoghq.com) |
suppression_id | string | The ID of the suppression rule |
SELECT
examples
- get_security_monitoring_suppression
- list_security_monitoring_suppressions
Get the details of a specific suppression rule.
SELECT
id,
attributes,
type
FROM datadog.security.monitoring_suppressions
WHERE suppression_id = '{{ suppression_id }}' -- required
AND region = '{{ region }}' -- required
;
Get the list of all suppression rules.
SELECT
id,
attributes,
type
FROM datadog.security.monitoring_suppressions
WHERE region = '{{ region }}' -- required
;
INSERT
examples
- create_security_monitoring_suppression
- Manifest
Create a new suppression rule.
INSERT INTO datadog.security.monitoring_suppressions (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: monitoring_suppressions
props:
- name: region
value: string
description: Required parameter for the monitoring_suppressions resource.
- name: data
value: object
description: |
Object for a single suppression rule.
UPDATE
examples
- update_security_monitoring_suppression
Update a specific suppression rule.
UPDATE datadog.security.monitoring_suppressions
SET
data__data = '{{ data }}'
WHERE
suppression_id = '{{ suppression_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;
DELETE
examples
- delete_security_monitoring_suppression
Delete a specific suppression rule.
DELETE FROM datadog.security.monitoring_suppressions
WHERE suppression_id = '{{ suppression_id }}' --required
AND region = '{{ region }}' --required
;
Lifecycle Methods
- validate_security_monitoring_suppression
Validate a suppression rule.
EXEC datadog.security.monitoring_suppressions.validate_security_monitoring_suppression
@region='{{ region }}' --required
@@json=
'{
"data": "{{ data }}"
}'
;