diff --git a/content/en/api/v2/application-security/examples.json b/content/en/api/v2/application-security/examples.json index 0b8169cb6f9..72fb78e5449 100644 --- a/content/en/api/v2/application-security/examples.json +++ b/content/en/api/v2/application-security/examples.json @@ -62,7 +62,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The WAF custom rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The WAF custom rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -148,7 +148,7 @@ "type": "custom_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -265,7 +265,7 @@ "type": "custom_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Create a new WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Create a new WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" } }, "DeleteApplicationSecurityWafCustomRule": { @@ -370,7 +370,7 @@ "type": "custom_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -456,7 +456,7 @@ "type": "custom_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single WAF custom rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata associated with the WAF Custom Rule.

\n
\n
\n
\n
\n
\n

added_at

\n
\n

date-time

\n

The date and time the WAF custom rule was created.

\n
\n \n
\n
\n
\n
\n
\n

added_by

\n
\n

string

\n

The handle of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

added_by_name

\n
\n

string

\n

The name of the user who created the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the WAF custom rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n

modified_by

\n
\n

string

\n

The handle of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_name

\n
\n

string

\n

The name of the user who last updated the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the custom rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -581,7 +581,7 @@ "type": "custom_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single WAF Custom Rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Update a WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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.no_cookies,server.request.cookies

Show 11 more,server.request.trailers,server.request.body,server.response.status,server.response.headers.no_cookies,server.response.trailers,grpc.server.request.metadata,grpc.server.request.message,grpc.server.method,graphql.server.all_resolvers,usr.id,http.client_ip

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single WAF Custom Rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Update a WAF custom rule.

\n
\n
\n
\n
\n
\n

action

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleAction object.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

Override the default action to take when the WAF custom rule would block. \nAllowed enum values: redirect_request,block_request

default: block_request

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

\n
\n
\n
\n
\n
\n

location

\n
\n

string

\n

The location to redirect to when the WAF custom rule triggers.

\n
\n \n
\n
\n
\n
\n
\n

status_code

\n
\n

int64

\n

The status code to return when the WAF custom rule triggers.

default: 403

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

blocking [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule will block the request.

\n
\n \n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF\nrule to trigger.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Operator to use for the WAF Condition. \nAllowed enum values: match_regex,!match_regex,phrase_match,!phrase_match,is_xss,is_sqli,exact_match,!exact_match,ip_match,!ip_match

Show 1 more,capture_data

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

string

\n

Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.

\n
\n \n
\n
\n
\n
\n
\n

inputs [required]

\n
\n

[object]

\n

List of inputs on which at least one should match with the given operator.

\n
\n
\n
\n
\n
\n

address [required]

\n
\n

enum

\n

Input from the request on which the condition should apply. \nAllowed 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

Show 21 more,server.request.custom-auth,server.request.cookies,server.request.trailers,server.request.body,server.request.body.filenames,server.response.status,server.response.headers.no_cookies,server.response.trailers,server.response.body,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.endpoint

\n
\n \n
\n
\n
\n
\n
\n

key_path

\n
\n

[string]

\n

Specific path for the input.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and\n!exact_match operator.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the operator of this condition.

\n
\n
\n
\n
\n
\n

case_sensitive

\n
\n

boolean

\n

Evaluate the value as case sensitive.

\n
\n \n
\n
\n
\n
\n
\n

min_length

\n
\n

int64

\n

Only evaluate this condition if the value has a minimum amount of characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

Regex to use with the condition. Only used with match_regex and !match_regex operator.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Store the captured value in the specified tag name. Only used with the capture_data operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Indicates whether the WAF custom rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Name of the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

path_glob

\n
\n

string

\n

The path glob for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

[object]

\n

The scope of the WAF custom rule.

\n
\n
\n
\n
\n
\n

env [required]

\n
\n

string

\n

The environment scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

The service scope for the WAF custom rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

object

\n

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security\nactivity field associated with the traces.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response. \nAllowed enum values: attack_attempt,business_logic,security_response

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the WAF rule, associated with the category will form the security activity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be custom_rule. \nAllowed enum values: custom_rule

default: custom_rule

\n
\n \n
\n
\n
\n
" } }, "ListApplicationSecurityWafExclusionFilters": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index f28222f5ca5..bd8c9e7581c 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -3990,19 +3990,29 @@ components: - server.request.uri.raw - server.request.path_params - server.request.query + - server.request.headers - server.request.headers.no_cookies + - server.request.custom-auth - server.request.cookies - server.request.trailers - server.request.body + - server.request.body.filenames - server.response.status - server.response.headers.no_cookies - server.response.trailers + - server.response.body - 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.endpoint example: server.db.statement type: string x-enum-varnames: @@ -4014,19 +4024,29 @@ components: - SERVER_REQUEST_URI_RAW - SERVER_REQUEST_PATH_PARAMS - SERVER_REQUEST_QUERY + - SERVER_REQUEST_HEADERS - SERVER_REQUEST_HEADERS_NO_COOKIES + - SERVER_REQUEST_CUSTOM_AUTH - SERVER_REQUEST_COOKIES - SERVER_REQUEST_TRAILERS - SERVER_REQUEST_BODY + - SERVER_REQUEST_BODY_FILENAMES - SERVER_RESPONSE_STATUS - SERVER_RESPONSE_HEADERS_NO_COOKIES - SERVER_RESPONSE_TRAILERS + - SERVER_RESPONSE_BODY - 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_ENDPOINT ApplicationSecurityWafCustomRuleConditionOperator: description: Operator to use for the WAF Condition. enum: