--- title: Create a WAF custom rule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Application Security --- # Create a WAF custom rule{% #create-a-waf-custom-rule %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/remote_config/products/asm/waf/custom_rules | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/remote_config/products/asm/waf/custom_rules | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/remote_config/products/asm/waf/custom_rules | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules | ### Overview Create a new WAF custom rule with the given parameters. ### Request #### Body Data (required) The definition of the new WAF Custom Rule. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Object for a single WAF custom rule. | | data | attributes [*required*] | object | Create a new WAF custom rule. | | attributes | action | object | The definition of `ApplicationSecurityWafCustomRuleAction` object. | | action | action | enum | Override the default action to take when the WAF custom rule would block. Allowed enum values: `redirect_request,block_request` | | action | parameters | object | The definition of `ApplicationSecurityWafCustomRuleActionParameters` object. | | parameters | location | string | The location to redirect to when the WAF custom rule triggers. | | parameters | status_code | int64 | The status code to return when the WAF custom rule triggers. | | attributes | blocking [*required*] | boolean | Indicates whether the WAF custom rule will block the request. | | attributes | conditions [*required*] | [object] | Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF rule to trigger | | conditions | operator [*required*] | enum | Operator to use for the WAF Condition. Allowed enum values: `match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match` | | conditions | parameters [*required*] | object | The scope of the WAF custom rule. | | parameters | data | string | Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter. | | parameters | inputs [*required*] | [object] | List of inputs on which at least one should match with the given operator. | | inputs | address [*required*] | enum | Input from the request on which the condition should apply. Allowed enum values: `server.db.statement,server.io.fs.file,server.io.net.url,server.sys.shell.cmd,server.request.method,server.request.uri.raw,server.request.path_params,server.request.query,server.request.headers,server.request.headers.no_cookies` | | inputs | key_path | [string] | Specific path for the input. | | parameters | list | [string] | List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator. | | parameters | options | object | Options for the operator of this condition. | | options | case_sensitive | boolean | Evaluate the value as case sensitive. | | options | min_length | int64 | Only evaluate this condition if the value has a minimum amount of characters. | | parameters | regex | string | Regex to use with the condition. Only used with match_regex and !match_regex operator. | | parameters | type | enum | The type of the value to compare against. Only used with the equals and !equals operator. Allowed enum values: `boolean,signed,unsigned,float,string` | | parameters | value | string | Store the captured value in the specified tag name. Only used with the capture_data operator. | | attributes | enabled [*required*] | boolean | Indicates whether the WAF custom rule is enabled. | | attributes | name [*required*] | string | The name of the WAF custom rule. | | attributes | path_glob | string | The path glob for the WAF custom rule. | | attributes | scope | [object] | The scope of the WAF custom rule. | | scope | env [*required*] | string | The environment scope for the WAF custom rule. | | scope | service [*required*] | string | The service scope for the WAF custom rule. | | attributes | tags [*required*] | object | Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces. | | tags | category [*required*] | enum | The category of the WAF Rule, can be either `business_logic`, `attack_attempt` or `security_response`. Allowed enum values: `attack_attempt,business_logic,security_response` | | tags | type [*required*] | string | The type of the WAF rule, associated with the category will form the security activity. | | data | type [*required*] | enum | The type of the resource. The value should always be `custom_rule`. Allowed enum values: `custom_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "action": { "action": "block_request", "parameters": { "location": "/blocking", "status_code": 403 } }, "blocking": false, "conditions": [ { "operator": "match_regex", "parameters": { "data": "blocked_users", "inputs": [ { "address": "server.db.statement", "key_path": [] } ], "list": [], "options": { "case_sensitive": false, "min_length": "integer" }, "regex": "path.*", "type": "string", "value": "custom_tag" } } ], "enabled": false, "name": "Block request from a bad useragent", "path_glob": "/api/search/*", "scope": [ { "env": "prod", "service": "billing-service" } ], "tags": { "category": "business_logic", "type": "users.login.success" } }, "type": "custom_rule" } } ``` {% /tab %} ### Response {% tab title="201" %} Created {% tab title="Model" %} Response object that includes a single WAF custom rule. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Object for a single WAF custom rule. | | data | attributes | object | A WAF custom rule. | | attributes | action | object | The definition of `ApplicationSecurityWafCustomRuleAction` object. | | action | action | enum | Override the default action to take when the WAF custom rule would block. Allowed enum values: `redirect_request,block_request` | | action | parameters | object | The definition of `ApplicationSecurityWafCustomRuleActionParameters` object. | | parameters | location | string | The location to redirect to when the WAF custom rule triggers. | | parameters | status_code | int64 | The status code to return when the WAF custom rule triggers. | | attributes | blocking [*required*] | boolean | Indicates whether the WAF custom rule will block the request. | | attributes | conditions [*required*] | [object] | Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF rule to trigger. | | conditions | operator [*required*] | enum | Operator to use for the WAF Condition. Allowed enum values: `match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match` | | conditions | parameters [*required*] | object | The scope of the WAF custom rule. | | parameters | data | string | Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter. | | parameters | inputs [*required*] | [object] | List of inputs on which at least one should match with the given operator. | | inputs | address [*required*] | enum | Input from the request on which the condition should apply. Allowed enum values: `server.db.statement,server.io.fs.file,server.io.net.url,server.sys.shell.cmd,server.request.method,server.request.uri.raw,server.request.path_params,server.request.query,server.request.headers,server.request.headers.no_cookies` | | inputs | key_path | [string] | Specific path for the input. | | parameters | list | [string] | List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator. | | parameters | options | object | Options for the operator of this condition. | | options | case_sensitive | boolean | Evaluate the value as case sensitive. | | options | min_length | int64 | Only evaluate this condition if the value has a minimum amount of characters. | | parameters | regex | string | Regex to use with the condition. Only used with match_regex and !match_regex operator. | | parameters | type | enum | The type of the value to compare against. Only used with the equals and !equals operator. Allowed enum values: `boolean,signed,unsigned,float,string` | | parameters | value | string | Store the captured value in the specified tag name. Only used with the capture_data operator. | | attributes | enabled [*required*] | boolean | Indicates whether the WAF custom rule is enabled. | | attributes | metadata | object | Metadata associated with the WAF Custom Rule. | | metadata | added_at | date-time | The date and time the WAF custom rule was created. | | metadata | added_by | string | The handle of the user who created the WAF custom rule. | | metadata | added_by_name | string | The name of the user who created the WAF custom rule. | | metadata | modified_at | date-time | The date and time the WAF custom rule was last updated. | | metadata | modified_by | string | The handle of the user who last updated the WAF custom rule. | | metadata | modified_by_name | string | The name of the user who last updated the WAF custom rule. | | attributes | name [*required*] | string | The name of the WAF custom rule. | | attributes | path_glob | string | The path glob for the WAF custom rule. | | attributes | scope | [object] | The scope of the WAF custom rule. | | scope | env [*required*] | string | The environment scope for the WAF custom rule. | | scope | service [*required*] | string | The service scope for the WAF custom rule. | | attributes | tags [*required*] | object | Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces. | | tags | category [*required*] | enum | The category of the WAF Rule, can be either `business_logic`, `attack_attempt` or `security_response`. Allowed enum values: `attack_attempt,business_logic,security_response` | | tags | type [*required*] | string | The type of the WAF rule, associated with the category will form the security activity. | | data | id | string | The ID of the custom rule. | | data | type | enum | The type of the resource. The value should always be `custom_rule`. Allowed enum values: `custom_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "action": { "action": "block_request", "parameters": { "location": "/blocking", "status_code": 403 } }, "blocking": false, "conditions": [ { "operator": "match_regex", "parameters": { "data": "blocked_users", "inputs": [ { "address": "server.db.statement", "key_path": [] } ], "list": [], "options": { "case_sensitive": false, "min_length": "integer" }, "regex": "path.*", "type": "string", "value": "custom_tag" } } ], "enabled": false, "metadata": { "added_at": "2021-01-01T00:00:00Z", "added_by": "john.doe@datadoghq.com", "added_by_name": "John Doe", "modified_at": "2021-01-01T00:00:00Z", "modified_by": "john.doe@datadoghq.com", "modified_by_name": "John Doe" }, "name": "Block request from bad useragent", "path_glob": "/api/search/*", "scope": [ { "env": "prod", "service": "billing-service" } ], "tags": { "category": "business_logic", "type": "users.login.success" } }, "id": "2857c47d-1e3a-4300-8b2f-dc24089c084b", "type": "custom_rule" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Not Authorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="409" %} Concurrent Modification {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "action": { "action": "block_request", "parameters": { "location": "/blocking", "status_code": 403 } }, "blocking": false, "conditions": [ { "operator": "match_regex", "parameters": { "data": "blocked_users", "regex": "path.*", "value": "custom_tag" } } ], "enabled": false, "name": "Block request from a bad useragent", "path_glob": "/api/search/*", "scope": [ { "env": "prod", "service": "billing-service" } ], "tags": { "category": "business_logic", "type": "users.login.success" } }, "type": "custom_rule" } } EOF ##### ```python """ Create a WAF custom rule returns "Created" response """ 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_custom_rule_action import ( ApplicationSecurityWafCustomRuleAction, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_action_action import ( ApplicationSecurityWafCustomRuleActionAction, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_action_parameters import ( ApplicationSecurityWafCustomRuleActionParameters, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition import ( ApplicationSecurityWafCustomRuleCondition, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_input import ( ApplicationSecurityWafCustomRuleConditionInput, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_input_address import ( ApplicationSecurityWafCustomRuleConditionInputAddress, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_operator import ( ApplicationSecurityWafCustomRuleConditionOperator, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_options import ( ApplicationSecurityWafCustomRuleConditionOptions, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_parameters import ( ApplicationSecurityWafCustomRuleConditionParameters, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_condition_parameters_type import ( ApplicationSecurityWafCustomRuleConditionParametersType, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_create_attributes import ( ApplicationSecurityWafCustomRuleCreateAttributes, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_create_data import ( ApplicationSecurityWafCustomRuleCreateData, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_create_request import ( ApplicationSecurityWafCustomRuleCreateRequest, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_scope import ApplicationSecurityWafCustomRuleScope from datadog_api_client.v2.model.application_security_waf_custom_rule_tags import ApplicationSecurityWafCustomRuleTags from datadog_api_client.v2.model.application_security_waf_custom_rule_tags_category import ( ApplicationSecurityWafCustomRuleTagsCategory, ) from datadog_api_client.v2.model.application_security_waf_custom_rule_type import ApplicationSecurityWafCustomRuleType body = ApplicationSecurityWafCustomRuleCreateRequest( data=ApplicationSecurityWafCustomRuleCreateData( attributes=ApplicationSecurityWafCustomRuleCreateAttributes( action=ApplicationSecurityWafCustomRuleAction( action=ApplicationSecurityWafCustomRuleActionAction.BLOCK_REQUEST, parameters=ApplicationSecurityWafCustomRuleActionParameters( location="/blocking", status_code=403, ), ), blocking=False, conditions=[ ApplicationSecurityWafCustomRuleCondition( operator=ApplicationSecurityWafCustomRuleConditionOperator.MATCH_REGEX, parameters=ApplicationSecurityWafCustomRuleConditionParameters( data="blocked_users", inputs=[ ApplicationSecurityWafCustomRuleConditionInput( address=ApplicationSecurityWafCustomRuleConditionInputAddress.SERVER_DB_STATEMENT, key_path=[], ), ], list=[], options=ApplicationSecurityWafCustomRuleConditionOptions( case_sensitive=False, min_length=0, ), regex="path.*", type=ApplicationSecurityWafCustomRuleConditionParametersType.STRING, value="custom_tag", ), ), ], enabled=False, name="Block request from a bad useragent", path_glob="/api/search/*", scope=[ ApplicationSecurityWafCustomRuleScope( env="prod", service="billing-service", ), ], tags=ApplicationSecurityWafCustomRuleTags( category=ApplicationSecurityWafCustomRuleTagsCategory.BUSINESS_LOGIC, type="users.login.success", ), ), type=ApplicationSecurityWafCustomRuleType.CUSTOM_RULE, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ApplicationSecurityApi(api_client) response = api_instance.create_application_security_waf_custom_rule(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a WAF custom rule returns "Created" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ApplicationSecurityAPI.new body = DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleCreateRequest.new({ data: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleCreateData.new({ attributes: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleCreateAttributes.new({ action: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleAction.new({ action: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleActionAction::BLOCK_REQUEST, parameters: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleActionParameters.new({ location: "/blocking", status_code: 403, }), }), blocking: false, conditions: [ DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleCondition.new({ operator: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionOperator::MATCH_REGEX, parameters: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionParameters.new({ data: "blocked_users", inputs: [ DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionInput.new({ address: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionInputAddress::SERVER_DB_STATEMENT, key_path: [], }), ], list: [], options: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionOptions.new({ case_sensitive: false, min_length: 0, }), regex: "path.*", type: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionParametersType::STRING, value: "custom_tag", }), }), ], enabled: false, name: "Block request from a bad useragent", path_glob: "/api/search/*", scope: [ DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleScope.new({ env: "prod", service: "billing-service", }), ], tags: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleTags.new({ category: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleTagsCategory::BUSINESS_LOGIC, type: "users.login.success", }), }), type: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleType::CUSTOM_RULE, }), }) p api_instance.create_application_security_waf_custom_rule(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Create a WAF custom rule returns "Created" 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() { body := datadogV2.ApplicationSecurityWafCustomRuleCreateRequest{ Data: datadogV2.ApplicationSecurityWafCustomRuleCreateData{ Attributes: datadogV2.ApplicationSecurityWafCustomRuleCreateAttributes{ Action: &datadogV2.ApplicationSecurityWafCustomRuleAction{ Action: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULEACTIONACTION_BLOCK_REQUEST.Ptr(), Parameters: &datadogV2.ApplicationSecurityWafCustomRuleActionParameters{ Location: datadog.PtrString("/blocking"), StatusCode: datadog.PtrInt64(403), }, }, Blocking: false, Conditions: []datadogV2.ApplicationSecurityWafCustomRuleCondition{ { Operator: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULECONDITIONOPERATOR_MATCH_REGEX, Parameters: datadogV2.ApplicationSecurityWafCustomRuleConditionParameters{ Data: datadog.PtrString("blocked_users"), Inputs: []datadogV2.ApplicationSecurityWafCustomRuleConditionInput{ { Address: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULECONDITIONINPUTADDRESS_SERVER_DB_STATEMENT, KeyPath: []string{}, }, }, List: []string{}, Options: &datadogV2.ApplicationSecurityWafCustomRuleConditionOptions{ CaseSensitive: datadog.PtrBool(false), MinLength: datadog.PtrInt64(0), }, Regex: datadog.PtrString("path.*"), Type: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULECONDITIONPARAMETERSTYPE_STRING.Ptr(), Value: datadog.PtrString("custom_tag"), }, }, }, Enabled: false, Name: "Block request from a bad useragent", PathGlob: datadog.PtrString("/api/search/*"), Scope: []datadogV2.ApplicationSecurityWafCustomRuleScope{ { Env: "prod", Service: "billing-service", }, }, Tags: datadogV2.ApplicationSecurityWafCustomRuleTags{ Category: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULETAGSCATEGORY_BUSINESS_LOGIC, Type: "users.login.success", }, }, Type: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULETYPE_CUSTOM_RULE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewApplicationSecurityApi(apiClient) resp, r, err := api.CreateApplicationSecurityWafCustomRule(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ApplicationSecurityApi.CreateApplicationSecurityWafCustomRule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ApplicationSecurityApi.CreateApplicationSecurityWafCustomRule`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a WAF custom rule returns "Created" 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.ApplicationSecurityWafCustomRuleAction; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleActionAction; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleActionParameters; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleCondition; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionInput; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionInputAddress; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionOperator; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionOptions; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionParameters; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleConditionParametersType; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleCreateAttributes; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleCreateData; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleCreateRequest; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleResponse; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleScope; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleTags; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleTagsCategory; import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleType; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ApplicationSecurityApi apiInstance = new ApplicationSecurityApi(defaultClient); ApplicationSecurityWafCustomRuleCreateRequest body = new ApplicationSecurityWafCustomRuleCreateRequest() .data( new ApplicationSecurityWafCustomRuleCreateData() .attributes( new ApplicationSecurityWafCustomRuleCreateAttributes() .action( new ApplicationSecurityWafCustomRuleAction() .action( ApplicationSecurityWafCustomRuleActionAction.BLOCK_REQUEST) .parameters( new ApplicationSecurityWafCustomRuleActionParameters() .location("/blocking") .statusCode(403L))) .blocking(false) .conditions( Collections.singletonList( new ApplicationSecurityWafCustomRuleCondition() .operator( ApplicationSecurityWafCustomRuleConditionOperator .MATCH_REGEX) .parameters( new ApplicationSecurityWafCustomRuleConditionParameters() .data("blocked_users") .inputs( Collections.singletonList( new ApplicationSecurityWafCustomRuleConditionInput() .address( ApplicationSecurityWafCustomRuleConditionInputAddress .SERVER_DB_STATEMENT))) .options( new ApplicationSecurityWafCustomRuleConditionOptions() .caseSensitive(false) .minLength(0L)) .regex("path.*") .type( ApplicationSecurityWafCustomRuleConditionParametersType .STRING) .value("custom_tag")))) .enabled(false) .name("Block request from a bad useragent") .pathGlob("/api/search/*") .scope( Collections.singletonList( new ApplicationSecurityWafCustomRuleScope() .env("prod") .service("billing-service"))) .tags( new ApplicationSecurityWafCustomRuleTags() .category( ApplicationSecurityWafCustomRuleTagsCategory.BUSINESS_LOGIC) .type("users.login.success"))) .type(ApplicationSecurityWafCustomRuleType.CUSTOM_RULE)); try { ApplicationSecurityWafCustomRuleResponse result = apiInstance.createApplicationSecurityWafCustomRule(body); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling ApplicationSecurityApi#createApplicationSecurityWafCustomRule"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Create a WAF custom rule returns "Created" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_application_security::ApplicationSecurityAPI; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleAction; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleActionAction; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleActionParameters; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleCondition; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionInput; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionInputAddress; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionOperator; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionOptions; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionParameters; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleConditionParametersType; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleCreateAttributes; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleCreateData; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleCreateRequest; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleScope; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleTags; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleTagsCategory; use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleType; use std::collections::BTreeMap; #[tokio::main] async fn main() { let body = ApplicationSecurityWafCustomRuleCreateRequest::new( ApplicationSecurityWafCustomRuleCreateData::new( ApplicationSecurityWafCustomRuleCreateAttributes::new( false, vec![ ApplicationSecurityWafCustomRuleCondition::new( ApplicationSecurityWafCustomRuleConditionOperator::MATCH_REGEX, ApplicationSecurityWafCustomRuleConditionParameters::new( vec![ ApplicationSecurityWafCustomRuleConditionInput::new( ApplicationSecurityWafCustomRuleConditionInputAddress::SERVER_DB_STATEMENT, ).key_path(vec![]) ], ) .data("blocked_users".to_string()) .list(vec![]) .options( ApplicationSecurityWafCustomRuleConditionOptions::new() .case_sensitive(false) .min_length(0), ) .regex("path.*".to_string()) .type_(ApplicationSecurityWafCustomRuleConditionParametersType::STRING) .value("custom_tag".to_string()), ) ], false, "Block request from a bad useragent".to_string(), ApplicationSecurityWafCustomRuleTags::new( ApplicationSecurityWafCustomRuleTagsCategory::BUSINESS_LOGIC, "users.login.success".to_string(), ).additional_properties(BTreeMap::from([])), ) .action( ApplicationSecurityWafCustomRuleAction::new() .action(ApplicationSecurityWafCustomRuleActionAction::BLOCK_REQUEST) .parameters( ApplicationSecurityWafCustomRuleActionParameters::new() .location("/blocking".to_string()) .status_code(403), ), ) .path_glob("/api/search/*".to_string()) .scope( vec![ ApplicationSecurityWafCustomRuleScope::new( "prod".to_string(), "billing-service".to_string(), ) ], ), ApplicationSecurityWafCustomRuleType::CUSTOM_RULE, ), ); let configuration = datadog::Configuration::new(); let api = ApplicationSecurityAPI::with_config(configuration); let resp = api.create_application_security_waf_custom_rule(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a WAF custom rule returns "Created" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ApplicationSecurityApi(configuration); const params: v2.ApplicationSecurityApiCreateApplicationSecurityWafCustomRuleRequest = { body: { data: { attributes: { action: { action: "block_request", parameters: { location: "/blocking", statusCode: 403, }, }, blocking: false, conditions: [ { operator: "match_regex", parameters: { data: "blocked_users", inputs: [ { address: "server.db.statement", keyPath: [], }, ], list: [], options: { caseSensitive: false, minLength: 0, }, regex: "path.*", type: "string", value: "custom_tag", }, }, ], enabled: false, name: "Block request from a bad useragent", pathGlob: "/api/search/*", scope: [ { env: "prod", service: "billing-service", }, ], tags: { category: "business_logic", type: "users.login.success", }, }, type: "custom_rule", }, }, }; apiInstance .createApplicationSecurityWafCustomRule(params) .then((data: v2.ApplicationSecurityWafCustomRuleResponse) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}