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

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. (suppressions) (default: suppressions, example: suppressions)

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. (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		Get the details of a specific suppression rule.
list_security_monitoring_suppressions	select		query, sort, page[size], page[number]	Get the list of all suppression rules.
create_security_monitoring_suppression	insert	data		Create a new suppression rule.
update_security_monitoring_suppression	update	suppression_id, data		Update a specific suppression rule.
delete_security_monitoring_suppression	delete	suppression_id		Delete a specific suppression rule.
validate_security_monitoring_suppression	exec	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
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
suppression_id	string	The ID of the suppression rule
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Size for a given page. Use -1 to return all items.
query	string	Query string.
sort	string	Attribute used to sort the list of suppression rules. Prefix with - to sort in descending order.

SELECT examples

get_security_monitoring_suppression

Get the details of a specific suppression rule.

SELECT
id,
attributes,
type
FROM datadog.security.monitoring_suppressions
WHERE suppression_id = '{{ suppression_id }}' -- required
;

list_security_monitoring_suppressions

Get the list of all suppression rules.

SELECT
id,
attributes,
type
FROM datadog.security.monitoring_suppressions
WHERE query = '{{ query }}'
AND sort = '{{ sort }}'
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
;

INSERT examples

create_security_monitoring_suppression

Create a new suppression rule.

INSERT INTO datadog.security.monitoring_suppressions (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: monitoring_suppressions
props:
  - name: data
    description: |
      Object for a single suppression rule.
    value:
      attributes:
        data_exclusion_query: "{{ data_exclusion_query }}"
        description: "{{ description }}"
        enabled: {{ enabled }}
        expiration_date: {{ expiration_date }}
        name: "{{ name }}"
        rule_query: "{{ rule_query }}"
        start_date: {{ start_date }}
        suppression_query: "{{ suppression_query }}"
        tags:
          - "{{ tags }}"
      type: "{{ type }}"

UPDATE examples

update_security_monitoring_suppression

Update a specific suppression rule.

UPDATE datadog.security.monitoring_suppressions
SET 
data = '{{ data }}'
WHERE 
suppression_id = '{{ suppression_id }}' --required
AND 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
;

Lifecycle Methods

EXEC variables use wire (API) names.

validate_security_monitoring_suppression

Validate a suppression rule.

EXEC datadog.security.monitoring_suppressions.validate_security_monitoring_suppression 
@@json=
'{
"data": "{{ data }}"
}'
;