Mettre à jour une règle personnalisée WAF
PUT
https://api.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.us3.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.us5.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.datadoghq.eu/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.ap1.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.ap2.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.uk1.datadoghq.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.ddog-gov.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}https://api.us2.ddog-gov.com/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}Présentation
Mettre à jour un filtre d'exclusion WAF spécifique à l'aide de son identifiant. Renvoie l'objet de filtre d'exclusion lorsque la requête est réussie.
Arguments
Paramètres du chemin
Name
Type
Description
custom_rule_id [required]string
The ID of the custom rule.
Requête
Body Data (required)
Nouvelle définition de la règle WAF personnalisée.
Champ
Type
Description
data [required]object
Objet de requête contenant la règle personnalisée à mettre à jour.
attributes [required]object
Update a WAF custom rule.
actionobject
The definition of ApplicationSecurityWafCustomRuleAction object.
actionenum
Override the default action to take when the WAF custom rule would block.
block_requestAllowed enum values:
redirect_request, block_requestparametersobject
The definition of ApplicationSecurityWafCustomRuleActionParameters object.
locationstring
The location to redirect to when the WAF custom rule triggers.
status_codeint64
The status code to return when the WAF custom rule triggers.
403blocking [required]boolean
Indicates whether the WAF custom rule will block the request.
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.
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_matchShow 5 more
capture_data, exists, !exists, equals, !equalsparameters [required]object
The scope of the WAF custom rule.
datastring
Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.
inputs [required][object]
List of inputs on which at least one should match with the given operator.
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.fs.file_write, server.io.net.url, server.sys.shell.cmd, server.request.method, server.request.uri.raw, server.request.path_params, server.request.query, server.request.headersShow 24 more
server.request.headers.no_cookies, server.request.custom-auth, server.request.cookies, server.request.trailers, server.request.body, server.request.body.filenames, server.request.body.files_content, server.response.status, server.response.headers.no_cookies, server.response.trailers, server.response.body, server.response.body.raw, grpc.server.request.metadata, grpc.server.request.message, grpc.server.method, graphql.server.all_resolvers, usr.id, http.client_ip, server.llm.event, server.llm.guard.verdict, _dd.appsec.fp.http.header, _dd.appsec.fp.http.network, _dd.appsec.fp.session, _dd.appsec.fp.http.endpointkey_path[string]
Specific path for the input.
list[string]
List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator.
optionsobject
Options for the operator of this condition.
case_sensitiveboolean
Evaluate the value as case sensitive.
falsemin_lengthint64
Only evaluate this condition if the value has a minimum amount of characters.
0regexstring
Regex to use with the condition. Only used with match_regex and !match_regex operator.
typeenum
The type of the value to compare against. Only used with the equals and !equals operator.
Allowed enum values:
boolean, signed, unsigned, float, stringvaluestring
Store the captured value in the specified tag name. Only used with the capture_data operator.
enabled [required]boolean
Indicates whether the WAF custom rule is enabled.
name [required]string
The name of the WAF custom rule.
path_globstring
The path glob for the WAF custom rule.
scope[object]
The scope of the WAF custom rule.
env [required]string
The environment scope for the WAF custom rule.
service [required]string
The service scope for the WAF custom rule.
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.
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_responsetype [required]string
The type of the WAF rule, associated with the category will form the security activity.
type [required]enum
The type of the resource. The value should always be custom_rule.
custom_ruleAllowed enum values:
custom_rule{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}Réponse
OK
Response object that includes a single WAF custom rule.
Champ
Type
Description
dataobject
Object for a single WAF custom rule.
attributesobject
A WAF custom rule.
actionobject
The definition of ApplicationSecurityWafCustomRuleAction object.
actionenum
Override the default action to take when the WAF custom rule would block.
block_requestAllowed enum values:
redirect_request, block_requestparametersobject
The definition of ApplicationSecurityWafCustomRuleActionParameters object.
locationstring
The location to redirect to when the WAF custom rule triggers.
status_codeint64
The status code to return when the WAF custom rule triggers.
403blocking [required]boolean
Indicates whether the WAF custom rule will block the request.
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.
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_matchShow 5 more
capture_data, exists, !exists, equals, !equalsparameters [required]object
The scope of the WAF custom rule.
datastring
Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.
inputs [required][object]
List of inputs on which at least one should match with the given operator.
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.fs.file_write, server.io.net.url, server.sys.shell.cmd, server.request.method, server.request.uri.raw, server.request.path_params, server.request.query, server.request.headersShow 24 more
server.request.headers.no_cookies, server.request.custom-auth, server.request.cookies, server.request.trailers, server.request.body, server.request.body.filenames, server.request.body.files_content, server.response.status, server.response.headers.no_cookies, server.response.trailers, server.response.body, server.response.body.raw, grpc.server.request.metadata, grpc.server.request.message, grpc.server.method, graphql.server.all_resolvers, usr.id, http.client_ip, server.llm.event, server.llm.guard.verdict, _dd.appsec.fp.http.header, _dd.appsec.fp.http.network, _dd.appsec.fp.session, _dd.appsec.fp.http.endpointkey_path[string]
Specific path for the input.
list[string]
List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator.
optionsobject
Options for the operator of this condition.
case_sensitiveboolean
Evaluate the value as case sensitive.
falsemin_lengthint64
Only evaluate this condition if the value has a minimum amount of characters.
0regexstring
Regex to use with the condition. Only used with match_regex and !match_regex operator.
typeenum
The type of the value to compare against. Only used with the equals and !equals operator.
Allowed enum values:
boolean, signed, unsigned, float, stringvaluestring
Store the captured value in the specified tag name. Only used with the capture_data operator.
enabled [required]boolean
Indicates whether the WAF custom rule is enabled.
metadataobject
Metadata associated with the WAF Custom Rule.
added_atdate-time
The date and time the WAF custom rule was created.
added_bystring
The handle of the user who created the WAF custom rule.
added_by_namestring
The name of the user who created the WAF custom rule.
modified_atdate-time
The date and time the WAF custom rule was last updated.
modified_bystring
The handle of the user who last updated the WAF custom rule.
modified_by_namestring
The name of the user who last updated the WAF custom rule.
name [required]string
The name of the WAF custom rule.
path_globstring
The path glob for the WAF custom rule.
scope[object]
The scope of the WAF custom rule.
env [required]string
The environment scope for the WAF custom rule.
service [required]string
The service scope for the WAF custom rule.
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.
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_responsetype [required]string
The type of the WAF rule, associated with the category will form the security activity.
idstring
The ID of the custom rule.
typeenum
The type of the resource. The value should always be custom_rule.
custom_ruleAllowed enum values:
custom_rule{
"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"
}
}Bad Request
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Concurrent Modification
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
Update a WAF Custom Rule returns "OK" response
# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOF# Path parameters
export custom_rule_id="3b5-v82-ns6"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/remote_config/products/asm/waf/custom_rules/${custom_rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"type": "custom_rule",
"attributes": {
"blocking": false,
"conditions": [
{
"operator": "match_regex",
"parameters": {
"inputs": [
{
"address": "server.request.query",
"key_path": [
"id"
]
}
],
"regex": "badactor"
}
}
],
"enabled": false,
"name": "test",
"path_glob": "/test",
"scope": [
{
"env": "test",
"service": "test"
}
],
"tags": {
"category": "attack_attempt",
"type": "test"
}
}
}
}
EOFUpdate a WAF Custom Rule returns "OK" response
// Update a WAF Custom Rule 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 "custom_rule" in the system
CustomRuleDataID := os.Getenv("CUSTOM_RULE_DATA_ID")
body := datadogV2.ApplicationSecurityWafCustomRuleUpdateRequest{
Data: datadogV2.ApplicationSecurityWafCustomRuleUpdateData{
Type: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULETYPE_CUSTOM_RULE,
Attributes: datadogV2.ApplicationSecurityWafCustomRuleUpdateAttributes{
Blocking: false,
Conditions: []datadogV2.ApplicationSecurityWafCustomRuleCondition{
{
Operator: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULECONDITIONOPERATOR_MATCH_REGEX,
Parameters: datadogV2.ApplicationSecurityWafCustomRuleConditionParameters{
Inputs: []datadogV2.ApplicationSecurityWafCustomRuleConditionInput{
{
Address: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULECONDITIONINPUTADDRESS_SERVER_REQUEST_QUERY,
KeyPath: []string{
"id",
},
},
},
Regex: datadog.PtrString("badactor"),
},
},
},
Enabled: false,
Name: "test",
PathGlob: datadog.PtrString("/test"),
Scope: []datadogV2.ApplicationSecurityWafCustomRuleScope{
{
Env: "test",
Service: "test",
},
},
Tags: datadogV2.ApplicationSecurityWafCustomRuleTags{
Category: datadogV2.APPLICATIONSECURITYWAFCUSTOMRULETAGSCATEGORY_ATTACK_ATTEMPT,
Type: "test",
},
},
},
}
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.UpdateApplicationSecurityWafCustomRule(ctx, CustomRuleDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationSecurityApi.UpdateApplicationSecurityWafCustomRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ApplicationSecurityApi.UpdateApplicationSecurityWafCustomRule`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Update a WAF Custom Rule returns "OK" response
// Update a WAF Custom Rule 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.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.ApplicationSecurityWafCustomRuleConditionParameters;
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 com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleUpdateAttributes;
import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleUpdateData;
import com.datadog.api.client.v2.model.ApplicationSecurityWafCustomRuleUpdateRequest;
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 "custom_rule" in the system
String CUSTOM_RULE_DATA_ID = System.getenv("CUSTOM_RULE_DATA_ID");
ApplicationSecurityWafCustomRuleUpdateRequest body =
new ApplicationSecurityWafCustomRuleUpdateRequest()
.data(
new ApplicationSecurityWafCustomRuleUpdateData()
.type(ApplicationSecurityWafCustomRuleType.CUSTOM_RULE)
.attributes(
new ApplicationSecurityWafCustomRuleUpdateAttributes()
.blocking(false)
.conditions(
Collections.singletonList(
new ApplicationSecurityWafCustomRuleCondition()
.operator(
ApplicationSecurityWafCustomRuleConditionOperator
.MATCH_REGEX)
.parameters(
new ApplicationSecurityWafCustomRuleConditionParameters()
.inputs(
Collections.singletonList(
new ApplicationSecurityWafCustomRuleConditionInput()
.address(
ApplicationSecurityWafCustomRuleConditionInputAddress
.SERVER_REQUEST_QUERY)
.keyPath(
Collections.singletonList("id"))))
.regex("badactor"))))
.enabled(false)
.name("test")
.pathGlob("/test")
.scope(
Collections.singletonList(
new ApplicationSecurityWafCustomRuleScope()
.env("test")
.service("test")))
.tags(
new ApplicationSecurityWafCustomRuleTags()
.category(
ApplicationSecurityWafCustomRuleTagsCategory.ATTACK_ATTEMPT)
.type("test"))));
try {
ApplicationSecurityWafCustomRuleResponse result =
apiInstance.updateApplicationSecurityWafCustomRule(CUSTOM_RULE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling ApplicationSecurityApi#updateApplicationSecurityWafCustomRule");
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 and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Update a WAF Custom Rule returns "OK" response
"""
Update a WAF Custom Rule 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_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_parameters import (
ApplicationSecurityWafCustomRuleConditionParameters,
)
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
from datadog_api_client.v2.model.application_security_waf_custom_rule_update_attributes import (
ApplicationSecurityWafCustomRuleUpdateAttributes,
)
from datadog_api_client.v2.model.application_security_waf_custom_rule_update_data import (
ApplicationSecurityWafCustomRuleUpdateData,
)
from datadog_api_client.v2.model.application_security_waf_custom_rule_update_request import (
ApplicationSecurityWafCustomRuleUpdateRequest,
)
# there is a valid "custom_rule" in the system
CUSTOM_RULE_DATA_ID = environ["CUSTOM_RULE_DATA_ID"]
body = ApplicationSecurityWafCustomRuleUpdateRequest(
data=ApplicationSecurityWafCustomRuleUpdateData(
type=ApplicationSecurityWafCustomRuleType.CUSTOM_RULE,
attributes=ApplicationSecurityWafCustomRuleUpdateAttributes(
blocking=False,
conditions=[
ApplicationSecurityWafCustomRuleCondition(
operator=ApplicationSecurityWafCustomRuleConditionOperator.MATCH_REGEX,
parameters=ApplicationSecurityWafCustomRuleConditionParameters(
inputs=[
ApplicationSecurityWafCustomRuleConditionInput(
address=ApplicationSecurityWafCustomRuleConditionInputAddress.SERVER_REQUEST_QUERY,
key_path=[
"id",
],
),
],
regex="badactor",
),
),
],
enabled=False,
name="test",
path_glob="/test",
scope=[
ApplicationSecurityWafCustomRuleScope(
env="test",
service="test",
),
],
tags=ApplicationSecurityWafCustomRuleTags(
category=ApplicationSecurityWafCustomRuleTagsCategory.ATTACK_ATTEMPT,
type="test",
),
),
),
)
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_custom_rule(custom_rule_id=CUSTOM_RULE_DATA_ID, body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Update a WAF Custom Rule returns "OK" response
# Update a WAF Custom Rule 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 "custom_rule" in the system
CUSTOM_RULE_DATA_ID = ENV["CUSTOM_RULE_DATA_ID"]
body = DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleUpdateRequest.new({
data: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleUpdateData.new({
type: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleType::CUSTOM_RULE,
attributes: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleUpdateAttributes.new({
blocking: false,
conditions: [
DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleCondition.new({
operator: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionOperator::MATCH_REGEX,
parameters: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionParameters.new({
inputs: [
DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionInput.new({
address: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleConditionInputAddress::SERVER_REQUEST_QUERY,
key_path: [
"id",
],
}),
],
regex: "badactor",
}),
}),
],
enabled: false,
name: "test",
path_glob: "/test",
scope: [
DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleScope.new({
env: "test",
service: "test",
}),
],
tags: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleTags.new({
category: DatadogAPIClient::V2::ApplicationSecurityWafCustomRuleTagsCategory::ATTACK_ATTEMPT,
type: "test",
}),
}),
}),
})
p api_instance.update_application_security_waf_custom_rule(CUSTOM_RULE_DATA_ID, body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Update a WAF Custom Rule returns "OK" response
// Update a WAF Custom Rule returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_application_security::ApplicationSecurityAPI;
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::ApplicationSecurityWafCustomRuleConditionParameters;
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 datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleUpdateAttributes;
use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleUpdateData;
use datadog_api_client::datadogV2::model::ApplicationSecurityWafCustomRuleUpdateRequest;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
// there is a valid "custom_rule" in the system
let custom_rule_data_id = std::env::var("CUSTOM_RULE_DATA_ID").unwrap();
let body =
ApplicationSecurityWafCustomRuleUpdateRequest::new(
ApplicationSecurityWafCustomRuleUpdateData::new(
ApplicationSecurityWafCustomRuleUpdateAttributes::new(
false,
vec![
ApplicationSecurityWafCustomRuleCondition::new(
ApplicationSecurityWafCustomRuleConditionOperator::MATCH_REGEX,
ApplicationSecurityWafCustomRuleConditionParameters::new(
vec![
ApplicationSecurityWafCustomRuleConditionInput::new(
ApplicationSecurityWafCustomRuleConditionInputAddress::SERVER_REQUEST_QUERY,
).key_path(vec!["id".to_string()])
],
).regex("badactor".to_string()),
)
],
false,
"test".to_string(),
ApplicationSecurityWafCustomRuleTags::new(
ApplicationSecurityWafCustomRuleTagsCategory::ATTACK_ATTEMPT,
"test".to_string(),
).additional_properties(BTreeMap::from([])),
)
.path_glob("/test".to_string())
.scope(vec![ApplicationSecurityWafCustomRuleScope::new("test".to_string(), "test".to_string())]),
ApplicationSecurityWafCustomRuleType::CUSTOM_RULE,
),
);
let configuration = datadog::Configuration::new();
let api = ApplicationSecurityAPI::with_config(configuration);
let resp = api
.update_application_security_waf_custom_rule(custom_rule_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 and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runUpdate a WAF Custom Rule returns "OK" response
/**
* Update a WAF Custom Rule 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 "custom_rule" in the system
const CUSTOM_RULE_DATA_ID = process.env.CUSTOM_RULE_DATA_ID as string;
const params: v2.ApplicationSecurityApiUpdateApplicationSecurityWafCustomRuleRequest =
{
body: {
data: {
type: "custom_rule",
attributes: {
blocking: false,
conditions: [
{
operator: "match_regex",
parameters: {
inputs: [
{
address: "server.request.query",
keyPath: ["id"],
},
],
regex: "badactor",
},
},
],
enabled: false,
name: "test",
pathGlob: "/test",
scope: [
{
env: "test",
service: "test",
},
],
tags: {
category: "attack_attempt",
type: "test",
},
},
},
},
customRuleId: CUSTOM_RULE_DATA_ID,
};
apiInstance
.updateApplicationSecurityWafCustomRule(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 and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"