waf_exclusion_filters
Creates, updates, deletes, gets or lists a waf_exclusion_filters resource.
Overview
| Name | waf_exclusion_filters |
| Type | Resource |
| Id | datadog.remote_config.waf_exclusion_filters |
Fields
The following fields are returned by SELECT queries:
- get_application_security_waf_exclusion_filter
- list_application_security_waf_exclusion_filters
| Name | Datatype | Description |
|---|---|---|
id | string | The identifier of the WAF exclusion filter. (example: 3dd-0uc-h1s) |
attributes | object | Attributes describing a WAF exclusion filter. |
type | string | Type of the resource. The value should always be exclusion_filter. (exclusion_filter) (default: exclusion_filter, example: exclusion_filter) |
| Name | Datatype | Description |
|---|---|---|
id | string | The identifier of the WAF exclusion filter. (example: 3dd-0uc-h1s) |
attributes | object | Attributes describing a WAF exclusion filter. |
type | string | Type of the resource. The value should always be exclusion_filter. (exclusion_filter) (default: exclusion_filter, example: exclusion_filter) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_application_security_waf_exclusion_filter | select | exclusion_filter_id | Retrieve a specific WAF exclusion filter using its identifier. | |
list_application_security_waf_exclusion_filters | select | Retrieve a list of WAF exclusion filters. | ||
create_application_security_waf_exclusion_filter | insert | data | Create a new WAF exclusion filter with the given parameters.<br /><br />A request matched by an exclusion filter will be ignored by the Application Security WAF product.<br />Go to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries). | |
update_application_security_waf_exclusion_filter | replace | exclusion_filter_id, data | Update a specific WAF exclusion filter using its identifier.<br />Returns the exclusion filter object when the request is successful. | |
delete_application_security_waf_exclusion_filter | delete | exclusion_filter_id | Delete a specific WAF exclusion filter using its identifier. |
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 |
|---|---|---|
exclusion_filter_id | string | The identifier of the WAF exclusion filter. (example: 3b5-v82-ns6) |
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_application_security_waf_exclusion_filter
- list_application_security_waf_exclusion_filters
Retrieve a specific WAF exclusion filter using its identifier.
SELECT
id,
attributes,
type
FROM datadog.remote_config.waf_exclusion_filters
WHERE exclusion_filter_id = '{{ exclusion_filter_id }}' -- required
;
Retrieve a list of WAF exclusion filters.
SELECT
id,
attributes,
type
FROM datadog.remote_config.waf_exclusion_filters
;
INSERT examples
- create_application_security_waf_exclusion_filter
- Manifest
Create a new WAF exclusion filter with the given parameters.<br /><br />A request matched by an exclusion filter will be ignored by the Application Security WAF product.<br />Go to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries).
INSERT INTO datadog.remote_config.waf_exclusion_filters (
data
)
SELECT
'{{ data }}' /* required */
RETURNING
data
;
# Description fields are for documentation purposes
- name: waf_exclusion_filters
props:
- name: data
description: |
Object for creating a single WAF exclusion filter.
value:
attributes:
description: "{{ description }}"
enabled: {{ enabled }}
ip_list:
- "{{ ip_list }}"
on_match: "{{ on_match }}"
parameters:
- "{{ parameters }}"
path_glob: "{{ path_glob }}"
rules_target:
- rule_id: "{{ rule_id }}"
tags:
category: "{{ category }}"
type: "{{ type }}"
scope:
- env: "{{ env }}"
service: "{{ service }}"
type: "{{ type }}"
REPLACE examples
- update_application_security_waf_exclusion_filter
Update a specific WAF exclusion filter using its identifier.<br />Returns the exclusion filter object when the request is successful.
REPLACE datadog.remote_config.waf_exclusion_filters
SET
data = '{{ data }}'
WHERE
exclusion_filter_id = '{{ exclusion_filter_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;
DELETE examples
- delete_application_security_waf_exclusion_filter
Delete a specific WAF exclusion filter using its identifier.
DELETE FROM datadog.remote_config.waf_exclusion_filters
WHERE exclusion_filter_id = '{{ exclusion_filter_id }}' --required
;