--- title: Actualizar un filtro de exclusión WAF description: Actualiza un filtro de exclusión WAF específico utilizando su identificador. Devuelve el objeto de filtro de exclusión cuando la solicitud tiene éxito. breadcrumbs: Documentación > API > Actualizar un filtro de exclusión WAF --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Actualizar un filtro de exclusión WAF ## v2 (latest) | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------------------------------- | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | uk1.datadoghq.com | PUT https://api.uk1.datadoghq.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id} | ### Overview Actualiza un filtro de exclusión WAF específico utilizando su identificador. Devuelve el objeto de filtro de exclusión cuando la solicitud tiene éxito. This endpoint requires the `appsec_protect_write` permission. ### Arguments #### Path Parameters | Field | Type | Description | | -------------------------------- | ------ | ------------------------------------------- | | exclusion_filter_id [*required*] | string | The identifier of the WAF exclusion filter. | ### Request #### Body Data (required) El filtro de exclusión a actualizar. {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Objeto de solicitud para actualizar un único filtro de exclusión WAF. | | data | attributes [*required*] | object | Attributes for updating a WAF exclusion filter. | | attributes | description [*required*] | string | A description for the exclusion filter. | | attributes | enabled [*required*] | boolean | Indicates whether the exclusion filter is enabled. | | attributes | ip_list | [string] | The client IP addresses matched by the exclusion filter (CIDR notation is supported). | | attributes | on_match | enum | The action taken when the exclusion filter matches. When set to `monitor`, security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked. Allowed enum values: `monitor`. | | attributes | parameters | [string] | A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. | | attributes | path_glob | string | The HTTP path glob expression matched by the exclusion filter. | | attributes | rules_target | [object] | The WAF rules targeted by the exclusion filter. | | rules_target | rule_id | string | Target a single WAF rule based on its identifier. | | rules_target | tags | object | Target multiple WAF rules based on their tags. | | tags | category | string | The category of the targeted WAF rules. | | tags | type | string | The type of the targeted WAF rules. | | attributes | scope | [object] | The services where the exclusion filter is deployed. | | scope | env | string | Deploy on this environment. | | scope | service | string | Deploy on this service. | | data | type [*required*] | enum | Type of the resource. The value should always be `exclusion_filter`. Allowed enum values: `exclusion_filter`. Default: `exclusion_filter`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "description": "Exclude false positives on a path", "enabled": false, "ip_list": [ "198.51.100.72" ], "on_match": "monitor" }, "type": "exclusion_filter" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response object for a single WAF exclusion filter. | Parent field | Field | Type | Description | | ------------ | ---------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data | object | A JSON:API resource for an WAF exclusion filter. | | data | attributes | object | Attributes describing a WAF exclusion filter. | | attributes | description | string | A description for the exclusion filter. | | attributes | enabled | boolean | Indicates whether the exclusion filter is enabled. | | attributes | event_query | string | The event query matched by the legacy exclusion filter. Cannot be created nor updated. | | attributes | ip_list | [string] | The client IP addresses matched by the exclusion filter (CIDR notation is supported). | | attributes | metadata | object | Extra information about the exclusion filter. Read-only. | | metadata | added_at | date-time | The creation date of the exclusion filter. | | metadata | added_by | string | The handle of the user who created the exclusion filter. | | metadata | added_by_name | string | The name of the user who created the exclusion filter. | | metadata | modified_at | date-time | The last modification date of the exclusion filter. | | metadata | modified_by | string | The handle of the user who last modified the exclusion filter. | | metadata | modified_by_name | string | The name of the user who last modified the exclusion filter. | | attributes | on_match | enum | The action taken when the exclusion filter matches. When set to `monitor`, security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked. Allowed enum values: `monitor`. | | attributes | parameters | [string] | A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. | | attributes | path_glob | string | The HTTP path glob expression matched by the exclusion filter. | | attributes | rules_target | [object] | The WAF rules targeted by the exclusion filter. | | rules_target | rule_id | string | Target a single WAF rule based on its identifier. | | rules_target | tags | object | Target multiple WAF rules based on their tags. | | tags | category | string | The category of the targeted WAF rules. | | tags | type | string | The type of the targeted WAF rules. | | attributes | scope | [object] | The services where the exclusion filter is deployed. | | scope | env | string | Deploy on this environment. | | scope | service | string | Deploy on this service. | | attributes | search_query | string | Generated event search query for traces matching the exclusion filter. Read-only. | | data | id | string | The identifier of the WAF exclusion filter. Read-only. | | data | type | enum | Type of the resource. The value should always be `exclusion_filter`. Allowed enum values: `exclusion_filter`. Default: `exclusion_filter`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "description": "Exclude false positives on a path", "enabled": true, "event_query": "string", "ip_list": [ "198.51.100.72" ], "metadata": { "added_at": "2019-09-19T10:00:00.000Z", "added_by": "string", "added_by_name": "string", "modified_at": "2019-09-19T10:00:00.000Z", "modified_by": "string", "modified_by_name": "string" }, "on_match": "string", "parameters": [ "list.search.query" ], "path_glob": "/accounts/*", "rules_target": [ { "rule_id": "dog-913-009", "tags": { "category": "attack_attempt", "type": "lfi" } } ], "scope": [ { "env": "www", "service": "prod" } ], "search_query": "string" }, "id": "3dd-0uc-h1s", "type": "exclusion_filter" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Not Authorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="409" %} Concurrent Modification {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export exclusion_filter_id="3b5-v82-ns6" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/exclusion_filters/${exclusion_filter_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "description": "Exclude false positives on a path", "enabled": false, "ip_list": [ "198.51.100.72" ], "on_match": "monitor" }, "type": "exclusion_filter" } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Update a WAF exclusion filter returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "exclusion_filter" in the system ExclusionFilterDataID := os.Getenv("EXCLUSION_FILTER_DATA_ID") body := datadogV2.ApplicationSecurityWafExclusionFilterUpdateRequest{ Data: datadogV2.ApplicationSecurityWafExclusionFilterUpdateData{ Attributes: datadogV2.ApplicationSecurityWafExclusionFilterUpdateAttributes{ Description: "Exclude false positives on a path", Enabled: false, IpList: []string{ "198.51.100.72", }, OnMatch: datadogV2.APPLICATIONSECURITYWAFEXCLUSIONFILTERONMATCH_MONITOR.Ptr(), }, Type: datadogV2.APPLICATIONSECURITYWAFEXCLUSIONFILTERTYPE_EXCLUSION_FILTER, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewApplicationSecurityApi(apiClient) resp, r, err := api.UpdateApplicationSecurityWafExclusionFilter(ctx, ExclusionFilterDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ApplicationSecurityApi.UpdateApplicationSecurityWafExclusionFilter`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ApplicationSecurityApi.UpdateApplicationSecurityWafExclusionFilter`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Update a WAF exclusion filter returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ApplicationSecurityApi; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterOnMatch; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterResponse; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterType; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterUpdateAttributes; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterUpdateData; import com.datadog.api.client.v2.model.ApplicationSecurityWafExclusionFilterUpdateRequest; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); ApplicationSecurityApi apiInstance = new ApplicationSecurityApi(defaultClient); // there is a valid "exclusion_filter" in the system String EXCLUSION_FILTER_DATA_ID = System.getenv("EXCLUSION_FILTER_DATA_ID"); ApplicationSecurityWafExclusionFilterUpdateRequest body = new ApplicationSecurityWafExclusionFilterUpdateRequest() .data( new ApplicationSecurityWafExclusionFilterUpdateData() .attributes( new ApplicationSecurityWafExclusionFilterUpdateAttributes() .description("Exclude false positives on a path") .enabled(false) .ipList(Collections.singletonList("198.51.100.72")) .onMatch(ApplicationSecurityWafExclusionFilterOnMatch.MONITOR)) .type(ApplicationSecurityWafExclusionFilterType.EXCLUSION_FILTER)); try { ApplicationSecurityWafExclusionFilterResponse result = apiInstance.updateApplicationSecurityWafExclusionFilter(EXCLUSION_FILTER_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling" + " ApplicationSecurityApi#updateApplicationSecurityWafExclusionFilter"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Update a WAF exclusion filter returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.application_security_api import ApplicationSecurityApi from datadog_api_client.v2.model.application_security_waf_exclusion_filter_on_match import ( ApplicationSecurityWafExclusionFilterOnMatch, ) from datadog_api_client.v2.model.application_security_waf_exclusion_filter_type import ( ApplicationSecurityWafExclusionFilterType, ) from datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_attributes import ( ApplicationSecurityWafExclusionFilterUpdateAttributes, ) from datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_data import ( ApplicationSecurityWafExclusionFilterUpdateData, ) from datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_request import ( ApplicationSecurityWafExclusionFilterUpdateRequest, ) # there is a valid "exclusion_filter" in the system EXCLUSION_FILTER_DATA_ID = environ["EXCLUSION_FILTER_DATA_ID"] body = ApplicationSecurityWafExclusionFilterUpdateRequest( data=ApplicationSecurityWafExclusionFilterUpdateData( attributes=ApplicationSecurityWafExclusionFilterUpdateAttributes( description="Exclude false positives on a path", enabled=False, ip_list=[ "198.51.100.72", ], on_match=ApplicationSecurityWafExclusionFilterOnMatch.MONITOR, ), type=ApplicationSecurityWafExclusionFilterType.EXCLUSION_FILTER, ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ApplicationSecurityApi(api_client) response = api_instance.update_application_security_waf_exclusion_filter( exclusion_filter_id=EXCLUSION_FILTER_DATA_ID, body=body ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Update a WAF exclusion filter returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::ApplicationSecurityAPI.new # there is a valid "exclusion_filter" in the system EXCLUSION_FILTER_DATA_ID = ENV["EXCLUSION_FILTER_DATA_ID"] body = DatadogAPIClient::V2::ApplicationSecurityWafExclusionFilterUpdateRequest.new({ data: DatadogAPIClient::V2::ApplicationSecurityWafExclusionFilterUpdateData.new({ attributes: DatadogAPIClient::V2::ApplicationSecurityWafExclusionFilterUpdateAttributes.new({ description: "Exclude false positives on a path", enabled: false, ip_list: [ "198.51.100.72", ], on_match: DatadogAPIClient::V2::ApplicationSecurityWafExclusionFilterOnMatch::MONITOR, }), type: DatadogAPIClient::V2::ApplicationSecurityWafExclusionFilterType::EXCLUSION_FILTER, }), }) p api_instance.update_application_security_waf_exclusion_filter(EXCLUSION_FILTER_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Update a WAF exclusion filter returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_application_security::ApplicationSecurityAPI; use datadog_api_client::datadogV2::model::ApplicationSecurityWafExclusionFilterOnMatch; use datadog_api_client::datadogV2::model::ApplicationSecurityWafExclusionFilterType; use datadog_api_client::datadogV2::model::ApplicationSecurityWafExclusionFilterUpdateAttributes; use datadog_api_client::datadogV2::model::ApplicationSecurityWafExclusionFilterUpdateData; use datadog_api_client::datadogV2::model::ApplicationSecurityWafExclusionFilterUpdateRequest; #[tokio::main] async fn main() { // there is a valid "exclusion_filter" in the system let exclusion_filter_data_id = std::env::var("EXCLUSION_FILTER_DATA_ID").unwrap(); let body = ApplicationSecurityWafExclusionFilterUpdateRequest::new( ApplicationSecurityWafExclusionFilterUpdateData::new( ApplicationSecurityWafExclusionFilterUpdateAttributes::new( "Exclude false positives on a path".to_string(), false, ) .ip_list(vec!["198.51.100.72".to_string()]) .on_match(ApplicationSecurityWafExclusionFilterOnMatch::MONITOR), ApplicationSecurityWafExclusionFilterType::EXCLUSION_FILTER, ), ); let configuration = datadog::Configuration::new(); let api = ApplicationSecurityAPI::with_config(configuration); let resp = api .update_application_security_waf_exclusion_filter(exclusion_filter_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Update a WAF exclusion filter returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.ApplicationSecurityApi(configuration); // there is a valid "exclusion_filter" in the system const EXCLUSION_FILTER_DATA_ID = process.env.EXCLUSION_FILTER_DATA_ID as string; const params: v2.ApplicationSecurityApiUpdateApplicationSecurityWafExclusionFilterRequest = { body: { data: { attributes: { description: "Exclude false positives on a path", enabled: false, ipList: ["198.51.100.72"], onMatch: "monitor", }, type: "exclusion_filter", }, }, exclusionFilterId: EXCLUSION_FILTER_DATA_ID, }; apiInstance .updateApplicationSecurityWafExclusionFilter(params) .then((data: v2.ApplicationSecurityWafExclusionFilterResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}