filters

Creates, updates, deletes, gets or lists a filters resource.

Overview

Name	filters
Type	Resource
Id	datadog.security.filters

Fields

The following fields are returned by SELECT queries:

get_security_filter

Name	Datatype	Description
id	string	The ID of the security filter. (example: 3dd-0uc-h1s)
attributes	object	The object describing a security filter.
type	string	The type of the resource. The value should always be security_filters. (security_filters) (default: security_filters, example: security_filters)

list_security_filters

Name	Datatype	Description
id	string	The ID of the security filter. (example: 3dd-0uc-h1s)
attributes	object	The object describing a security filter.
type	string	The type of the resource. The value should always be security_filters. (security_filters) (default: security_filters, example: security_filters)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_security_filter	select	security_filter_id		Get the details of a specific security filter.<br /><br />See the [security filter guide](https:​//docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)<br />for more examples.
list_security_filters	select			Get the list of configured security filters with their definitions.
create_security_filter	insert	data		Create a security filter.<br /><br />See the [security filter guide](https:​//docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)<br />for more examples.
update_security_filter	update	security_filter_id, data		Update a specific security filter.<br />Returns the security filter object when the request is successful.
delete_security_filter	delete	security_filter_id		Delete a specific security filter.

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
security_filter_id	string	The ID of the security filter.
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.

SELECT examples

get_security_filter

Get the details of a specific security filter.<br /><br />See the [security filter guide](https:​//docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)<br />for more examples.

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

list_security_filters

Get the list of configured security filters with their definitions.

SELECT
id,
attributes,
type
FROM datadog.security.filters
;

INSERT examples

create_security_filter

Create a security filter.<br /><br />See the [security filter guide](https:​//docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)<br />for more examples.

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

Manifest

# Description fields are for documentation purposes
- name: filters
props:
  - name: data
    description: |
      Object for a single security filter.
    value:
      attributes:
        exclusion_filters:
          - name: "{{ name }}"
            query: "{{ query }}"
        filtered_data_type: "{{ filtered_data_type }}"
        is_enabled: {{ is_enabled }}
        name: "{{ name }}"
        query: "{{ query }}"
      type: "{{ type }}"

UPDATE examples

update_security_filter

Update a specific security filter.<br />Returns the security filter object when the request is successful.

UPDATE datadog.security.filters
SET 
data = '{{ data }}'
WHERE 
security_filter_id = '{{ security_filter_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
meta;

DELETE examples

delete_security_filter

Delete a specific security filter.

DELETE FROM datadog.security.filters
WHERE security_filter_id = '{{ security_filter_id }}' --required
;