diff --git a/content/en/api/v2/csm-threats/examples.json b/content/en/api/v2/csm-threats/examples.json index 71f8ebef190..d006cf6b8b8 100644 --- a/content/en/api/v2/csm-threats/examples.json +++ b/content/en/api/v2/csm-threats/examples.json @@ -9,7 +9,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -28,7 +30,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -65,7 +69,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of Agent rules objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data

\n
\n

[object]

\n

A list of Agent rules objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -99,7 +103,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -118,7 +124,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -154,7 +162,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -205,7 +213,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -224,7 +234,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -244,7 +256,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

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

attributes [required]

\n
\n

object

\n

Create a new Cloud Workload Security Agent rule.

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent.

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to.

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

description

\n
\n

string

\n

The description of the Agent rule.

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to.

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled.

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

expression [required]

\n
\n

string

\n

The SECL expression of the Agent rule.

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on.

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to.

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

name [required]

\n
\n

string

\n

The name of the Agent rule.

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

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved.

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule.

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data [required]

\n
\n

object

\n

Object for a single Agent rule

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

attributes [required]

\n
\n

object

\n

Create a new Cloud Workload Security Agent rule.

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent.

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to.

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

description

\n
\n

string

\n

The description of the Agent rule.

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to.

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled.

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

expression [required]

\n
\n

string

\n

The SECL expression of the Agent rule.

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on.

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to.

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

name [required]

\n
\n

string

\n

The name of the Agent rule.

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

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved.

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule.

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" } }, "DeleteCSMThreatsAgentRule": { @@ -289,7 +301,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -308,7 +322,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -344,7 +360,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -386,7 +402,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -405,7 +423,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -441,7 +461,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data

\n
\n

object

\n

Object for a single Agent rule

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -497,7 +517,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -516,7 +538,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -535,7 +559,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

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

attributes [required]

\n
\n

object

\n

Update an existing Cloud Workload Security Agent rule

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data [required]

\n
\n

object

\n

Object for a single Agent rule

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

attributes [required]

\n
\n

object

\n

Update an existing Cloud Workload Security Agent rule

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

Hash file specified by the field attribute

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

field

\n
\n

string

\n

The field of the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

 <oneOf>

\n

The value of the set action

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

Option 1

\n
\n

string

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

Option 2

\n
\n

integer

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

Option 3

\n
\n

boolean

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

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" } }, "ListCSMThreatsAgentPolicies": { @@ -555,6 +579,7 @@ "monitoringRulesCount": 100, "name": "my_agent_policy", "pinned": false, + "policyType": "policy", "policyVersion": "1", "priority": 10, "ruleCount": 100, @@ -566,8 +591,8 @@ }, "versions": [ { - "Date": "string", - "Name": "1.47.0-rc2" + "date": "string", + "name": "1.47.0-rc2" } ] }, @@ -576,7 +601,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of Agent policy objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

Date

\n
\n

string

\n

The date and time the version was created

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

Name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

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

data

\n
\n

[object]

\n

A list of Agent policy objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyType

\n
\n

string

\n

The type of the policy

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

date

\n
\n

string

\n

The date and time the version was created

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

name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -617,6 +642,7 @@ "monitoringRulesCount": 100, "name": "my_agent_policy", "pinned": false, + "policyType": "policy", "policyVersion": "1", "priority": 10, "ruleCount": 100, @@ -628,8 +654,8 @@ }, "versions": [ { - "Date": "string", - "Name": "1.47.0-rc2" + "date": "string", + "name": "1.47.0-rc2" } ] }, @@ -637,7 +663,7 @@ "type": "policy" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

Date

\n
\n

string

\n

The date and time the version was created

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

Name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

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

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyType

\n
\n

string

\n

The type of the policy

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

date

\n
\n

string

\n

The date and time the version was created

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

name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -774,6 +800,7 @@ "monitoringRulesCount": 100, "name": "my_agent_policy", "pinned": false, + "policyType": "policy", "policyVersion": "1", "priority": 10, "ruleCount": 100, @@ -785,8 +812,8 @@ }, "versions": [ { - "Date": "string", - "Name": "1.47.0-rc2" + "date": "string", + "name": "1.47.0-rc2" } ] }, @@ -794,7 +821,7 @@ "type": "policy" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

Date

\n
\n

string

\n

The date and time the version was created

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

Name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

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

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyType

\n
\n

string

\n

The type of the policy

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

date

\n
\n

string

\n

The date and time the version was created

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

name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -843,6 +870,7 @@ "monitoringRulesCount": 100, "name": "my_agent_policy", "pinned": false, + "policyType": "policy", "policyVersion": "1", "priority": 10, "ruleCount": 100, @@ -854,8 +882,8 @@ }, "versions": [ { - "Date": "string", - "Name": "1.47.0-rc2" + "date": "string", + "name": "1.47.0-rc2" } ] }, @@ -863,7 +891,7 @@ "type": "policy" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

Date

\n
\n

string

\n

The date and time the version was created

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

Name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

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

data

\n
\n

object

\n

Object for a single Agent policy

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent policy returned by the API

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

blockingRulesCount

\n
\n

int32

\n

The number of rules with the blocking feature in this policy

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

datadogManaged

\n
\n

boolean

\n

Whether the policy is managed by Datadog

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

description

\n
\n

string

\n

The description of the policy

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

disabledRulesCount

\n
\n

int32

\n

The number of rules that are disabled in this policy

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

enabled

\n
\n

boolean

\n

Whether the Agent policy is enabled

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

hostTags

\n
\n

[string]

\n

The host tags defining where this policy is deployed

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

hostTagsLists

\n
\n

[array]

\n

The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR

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

monitoringRulesCount

\n
\n

int32

\n

The number of rules in the monitoring state in this policy

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

name

\n
\n

string

\n

The name of the policy

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

pinned

\n
\n

boolean

\n

Whether the policy is pinned

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

policyType

\n
\n

string

\n

The type of the policy

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

policyVersion

\n
\n

string

\n

The version of the policy

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

priority

\n
\n

int64

\n

The priority of the policy

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

ruleCount

\n
\n

int32

\n

The number of rules in this policy

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the policy was last updated

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

updatedAt

\n
\n

int64

\n

When the policy was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the policy

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

versions

\n
\n

[object]

\n

The versions of the policy

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

date

\n
\n

string

\n

The date and time the version was created

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

name

\n
\n

string

\n

The version of the policy

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

id

\n
\n

string

\n

The ID of the Agent policy

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

type

\n
\n

enum

\n

The type of the resource, must always be policy \nAllowed enum values: policy

default: policy

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -968,7 +996,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -987,7 +1017,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1024,7 +1056,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of Agent rules objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

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

hash

\n
\n

object

\n

An empty object indicating the hash action

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

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

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

signal

\n
\n

string

\n

Supported signals for the kill system call

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

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

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

image_tag

\n
\n

string

\n

The image tag of the metadata action

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

service

\n
\n

string

\n

The service of the metadata action

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

short_image

\n
\n

string

\n

The short image of the metadata action

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

set

\n
\n

object

\n

The set action applied on the scope matching the rule

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

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

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

default_value

\n
\n

string

\n

The default value of the set action

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

expression

\n
\n

string

\n

The expression of the set action.

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

field

\n
\n

string

\n

The field of the set action

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

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

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

name

\n
\n

string

\n

The name of the set action

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

scope

\n
\n

string

\n

The scope of the set action.

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

size

\n
\n

int64

\n

The size of the set action.

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

ttl

\n
\n

int64

\n

The time to live of the set action.

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

value

\n
\n

string

\n

The value of the set action

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

agentConstraint

\n
\n

string

\n

The version of the Agent

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

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

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

category

\n
\n

string

\n

The category of the Agent rule

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

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

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

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

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

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

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

description

\n
\n

string

\n

The description of the Agent rule

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

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

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

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

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

expression

\n
\n

string

\n

The SECL expression of the Agent rule

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

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

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

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

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

name

\n
\n

string

\n

The name of the Agent rule

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

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

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

silent

\n
\n

boolean

\n

Whether the rule is silent.

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

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

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

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

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

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

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

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

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

handle

\n
\n

string

\n

The handle of the user

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

name

\n
\n

string

\n

The name of the user

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

version

\n
\n

int64

\n

The version of the Agent rule

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

id

\n
\n

string

\n

The ID of the Agent rule

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

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

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

data

\n
\n

[object]

\n

A list of Agent rules objects

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

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

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

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

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

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -1058,7 +1090,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -1077,7 +1111,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1113,7 +1149,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

An empty object indicating the hash action

\n
\n \n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The value of the set action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1164,7 +1200,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -1183,7 +1221,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1203,7 +1243,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Create a new Cloud Workload Security Agent rule.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

An empty object indicating the hash action

\n
\n \n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The value of the set action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent.

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

The SECL expression of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on.

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved.

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule.

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Create a new Cloud Workload Security Agent rule.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent.

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

The SECL expression of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on.

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Agent rule.

\n
\n \n
\n
\n
\n
\n
\n

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved.

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule.

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" } }, "DeleteCloudWorkloadSecurityAgentRule": { @@ -1248,7 +1288,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -1267,7 +1309,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1303,7 +1347,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

An empty object indicating the hash action

\n
\n \n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The value of the set action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -1345,7 +1389,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -1364,7 +1410,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1400,7 +1448,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

An empty object indicating the hash action

\n
\n \n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The value of the set action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A Cloud Workload Security Agent rule returned by the API

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agentConstraint

\n
\n

string

\n

The version of the Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorUuId

\n
\n

string

\n

The ID of the user who created the rule

\n
\n \n
\n
\n
\n
\n
\n

creationDate

\n
\n

int64

\n

When the Agent rule was created, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The attributes of the user who created the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultRule

\n
\n

boolean

\n

Whether the rule is included by default

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[string]

\n

The platforms the Agent rule is supported on

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorUuId

\n
\n

string

\n

The ID of the user who updated the rule

\n
\n \n
\n
\n
\n
\n
\n

updateDate

\n
\n

int64

\n

Timestamp in milliseconds when the Agent rule was last updated

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

When the Agent rule was last updated, timestamp in milliseconds

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

The attributes of the user who last updated the Agent rule

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1456,7 +1504,9 @@ "actions": [ { "filter": "string", - "hash": {}, + "hash": { + "field": "string" + }, "kill": { "signal": "string" }, @@ -1475,7 +1525,9 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": "string" + "value": { + "type": "undefined" + } } } ], @@ -1494,7 +1546,7 @@ "type": "agent_rule" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Update an existing Cloud Workload Security Agent rule

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

An empty object indicating the hash action

\n
\n \n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The value of the set action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single Agent rule

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Update an existing Cloud Workload Security Agent rule

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

The array of actions the rule can perform if triggered

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

SECL expression used to target the container to apply the action on

\n
\n \n
\n
\n
\n
\n
\n

hash

\n
\n

object

\n

Hash file specified by the field attribute

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the hash action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

kill

\n
\n

object

\n

Kill system call applied on the container matching the rule

\n
\n
\n
\n
\n
\n

signal

\n
\n

string

\n

Supported signals for the kill system call

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

The metadata action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

image_tag

\n
\n

string

\n

The image tag of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The service of the metadata action

\n
\n \n
\n
\n
\n
\n
\n

short_image

\n
\n

string

\n

The short image of the metadata action

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

set

\n
\n

object

\n

The set action applied on the scope matching the rule

\n
\n
\n
\n
\n
\n

append

\n
\n

boolean

\n

Whether the value should be appended to the field.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value of the set action

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The expression of the set action.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field of the set action

\n
\n \n
\n
\n
\n
\n
\n

inherited

\n
\n

boolean

\n

Whether the value should be inherited.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the set action

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope of the set action.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The size of the set action.

\n
\n \n
\n
\n
\n
\n
\n

ttl

\n
\n

int64

\n

The time to live of the set action.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

 <oneOf>

\n

The value of the set action

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

integer

\n
\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

agent_version

\n
\n

string

\n

Constrain the rule to specific versions of the Datadog Agent

\n
\n \n
\n
\n
\n
\n
\n

blocking

\n
\n

[string]

\n

The blocking policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

[string]

\n

The disabled policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the Agent rule is enabled

\n
\n \n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

The SECL expression of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

monitoring

\n
\n

[string]

\n

The monitoring policies that the rule belongs to

\n
\n \n
\n
\n
\n
\n
\n

policy_id

\n
\n

string

\n

The ID of the policy where the Agent rule is saved

\n
\n \n
\n
\n
\n
\n
\n

product_tags

\n
\n

[string]

\n

The list of product tags associated with the rule

\n
\n \n
\n
\n
\n
\n
\n

silent

\n
\n

boolean

\n

Whether the rule is silent.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Agent rule

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule

default: agent_rule

\n
\n \n
\n
\n
\n
" } } } \ No newline at end of file diff --git a/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json b/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json index 1e334c658de..d7c4ed36b90 100644 --- a/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json +++ b/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json @@ -18,7 +18,9 @@ } }, { - "hash": {} + "hash": { + "field": "exec.file" + } } ] }, diff --git a/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1363354233.json b/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1363354233.json index d30c5d29e00..8c0f02a459b 100644 --- a/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1363354233.json +++ b/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1363354233.json @@ -12,7 +12,7 @@ { "set": { "name": "test_set", - "expression": "open.file.path", + "expression": "exec.file.path", "default_value": "/dev/null", "scope": "process" } diff --git a/content/en/api/v2/security-monitoring/examples.json b/content/en/api/v2/security-monitoring/examples.json index 969ea0c0b6a..6fcbde28d4b 100644 --- a/content/en/api/v2/security-monitoring/examples.json +++ b/content/en/api/v2/security-monitoring/examples.json @@ -3691,6 +3691,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -3790,7 +3796,7 @@ ], "type": "string" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Create a new signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Create a new cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Create a new signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Create a new cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" } }, "GetSuppressionsAffectingRule": { @@ -4276,6 +4282,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -4384,7 +4396,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

Array containing the list of rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

Array containing the list of rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4469,6 +4481,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -4569,7 +4587,7 @@ "updatedAt": "integer", "version": "integer" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -4665,6 +4683,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -4764,7 +4788,7 @@ ], "type": "string" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Create a new signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Create a new cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Create a new signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Create a new cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" } }, "ConvertSecurityMonitoringRuleFromJSONToTerraform": { @@ -4888,6 +4912,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -4987,7 +5017,7 @@ ], "type": "string" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The payload of a signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The payload of a signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
" } }, "TestSecurityMonitoringRule": { @@ -5111,6 +5141,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -5224,7 +5260,7 @@ } ] }, - "html": "
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Test a rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule to test

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ruleQueryPayloads

\n
\n

[object]

\n

Data payloads used to test rules query with the expected result.

\n
\n
\n
\n
\n
\n

expectedResult

\n
\n

boolean

\n

Expected result of the test.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

int64

\n

Index of the query under test.

\n
\n \n
\n
\n
\n
\n
\n

payload

\n
\n

object

\n

Payload used to test the rule query.

\n
\n
\n
\n
\n
\n

ddsource

\n
\n

string

\n

Source of the payload.

\n
\n \n
\n
\n
\n
\n
\n

ddtags

\n
\n

string

\n

Tags associated with your data.

\n
\n \n
\n
\n
\n
\n
\n

hostname

\n
\n

string

\n

The name of the originating host of the log.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the payload.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The name of the application or service generating the data.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Test a rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule to test

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ruleQueryPayloads

\n
\n

[object]

\n

Data payloads used to test rules query with the expected result.

\n
\n
\n
\n
\n
\n

expectedResult

\n
\n

boolean

\n

Expected result of the test.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

int64

\n

Index of the query under test.

\n
\n \n
\n
\n
\n
\n
\n

payload

\n
\n

object

\n

Payload used to test the rule query.

\n
\n
\n
\n
\n
\n

ddsource

\n
\n

string

\n

Source of the payload.

\n
\n \n
\n
\n
\n
\n
\n

ddtags

\n
\n

string

\n

Tags associated with your data.

\n
\n \n
\n
\n
\n
\n
\n

hostname

\n
\n

string

\n

The name of the originating host of the log.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the payload.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The name of the application or service generating the data.

\n
\n \n
\n
\n
\n
\n
\n
" } }, "ValidateSecurityMonitoringRule": { @@ -5325,6 +5361,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -5424,7 +5466,7 @@ ], "type": "string" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The payload of a signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The payload of a cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: api_security,application_security,log_detection,workload_security

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The payload of a signal correlation rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting signals which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The payload of a cloud configuration rule.

\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.

\n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions [required]

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message in markdown format for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options on cloud configuration rules.

\n
\n
\n
\n
\n
\n

complianceRuleOptions [required]

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated findings and signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: cloud_configuration

\n
\n \n
\n
\n
\n
" } }, "DeleteSecurityMonitoringRule": { @@ -5520,6 +5562,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -5620,7 +5668,7 @@ "updatedAt": "integer", "version": "integer" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" }, "404": { "json": { @@ -5705,6 +5753,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -5805,7 +5859,7 @@ "updatedAt": "integer", "version": "integer" }, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -5916,6 +5970,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -6013,7 +6073,7 @@ ], "version": 1 }, - "html": "
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden Message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[ <oneOf>]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Query for matching rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Query for matching rule on signals.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the rule being updated.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden Message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[ <oneOf>]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Query for matching rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Query for matching rule on signals.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId [required]

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the rule being updated.

\n
\n \n
\n
" } }, "ConvertExistingSecurityMonitoringRule": { @@ -6185,6 +6245,12 @@ "message": "", "name": "My security monitoring rule.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -6298,7 +6364,7 @@ } ] }, - "html": "
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Test a rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule to test

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ruleQueryPayloads

\n
\n

[object]

\n

Data payloads used to test rules query with the expected result.

\n
\n
\n
\n
\n
\n

expectedResult

\n
\n

boolean

\n

Expected result of the test.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

int64

\n

Index of the query under test.

\n
\n \n
\n
\n
\n
\n
\n

payload

\n
\n

object

\n

Payload used to test the rule query.

\n
\n
\n
\n
\n
\n

ddsource

\n
\n

string

\n

Source of the payload.

\n
\n \n
\n
\n
\n
\n
\n

ddtags

\n
\n

string

\n

Tags associated with your data.

\n
\n \n
\n
\n
\n
\n
\n

hostname

\n
\n

string

\n

The name of the originating host of the log.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the payload.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The name of the application or service generating the data.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Test a rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The payload of a rule to test

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ruleQueryPayloads

\n
\n

[object]

\n

Data payloads used to test rules query with the expected result.

\n
\n
\n
\n
\n
\n

expectedResult

\n
\n

boolean

\n

Expected result of the test.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

int64

\n

Index of the query under test.

\n
\n \n
\n
\n
\n
\n
\n

payload

\n
\n

object

\n

Payload used to test the rule query.

\n
\n
\n
\n
\n
\n

ddsource

\n
\n

string

\n

Source of the payload.

\n
\n \n
\n
\n
\n
\n
\n

ddtags

\n
\n

string

\n

Tags associated with your data.

\n
\n \n
\n
\n
\n
\n
\n

hostname

\n
\n

string

\n

The name of the originating host of the log.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the payload.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The name of the application or service generating the data.

\n
\n \n
\n
\n
\n
\n
\n
" } }, "GetRuleVersionHistory": { @@ -6374,6 +6440,12 @@ "message": "string", "name": "string", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "complianceRuleOptions": { "complexRule": false, "regoRule": { @@ -6481,7 +6553,7 @@ "type": "string" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the rule version history.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Response object containing the version history of a rule.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

The number of rule versions.

\n
\n \n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The RuleVersionHistory data.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

A rule version with a list of updates.

\n
\n
\n
\n
\n
\n

changes

\n
\n

[object]

\n

A list of changes.

\n
\n
\n
\n
\n
\n

change

\n
\n

string

\n

The new value of the field.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field that was changed.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of change. \nAllowed enum values: create,update,delete

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of data. \nAllowed enum values: GetRuleVersionHistoryResponse

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the rule version history.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Response object containing the version history of a rule.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

The number of rule versions.

\n
\n \n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The RuleVersionHistory data.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

A rule version with a list of updates.

\n
\n
\n
\n
\n
\n

changes

\n
\n

[object]

\n

A list of changes.

\n
\n
\n
\n
\n
\n

change

\n
\n

string

\n

The new value of the field.

\n
\n \n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

The field that was changed.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of change. \nAllowed enum values: create,update,delete

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rule

\n
\n

 <oneOf>

\n

Create a new rule.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceSignalOptions

\n
\n

object

\n

How to generate compliance signals. Useful for cloud_configuration rules only.

\n
\n
\n
\n
\n
\n

defaultActivationStatus

\n
\n

boolean

\n

The default activation status.

\n
\n \n
\n
\n
\n
\n
\n

defaultGroupByFields

\n
\n

[string]

\n

The default group by fields.

\n
\n \n
\n
\n
\n
\n
\n

userActivationStatus

\n
\n

boolean

\n

Whether signals will be sent.

\n
\n \n
\n
\n
\n
\n
\n

userGroupByFields

\n
\n

[string]

\n

Fields to use to group findings by when sending signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

defaultTags

\n
\n

[string]

\n

Default Tags for default rules (included in tags)

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

customQueryExtension

\n
\n

string

\n

Query extension to append to the logs query.

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

index

\n
\n

string

\n

This field is currently unstable and might be removed in a minor version upgrade.\nThe index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

indexes

\n
\n

[string]

\n

List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.

\n
\n \n
\n
\n
\n
\n
\n

metric

\n
\n

string

\n

DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max\naggregations. metrics field should be used instead.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables for the rule.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

schedulingOptions

\n
\n

object

\n

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

\n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

Start date for the schedule, in ISO 8601 format without timezone.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

Time zone of the start date, in the tz database format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating signals from third-party rules. Only available for third-party rules.

\n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: log_detection,infrastructure_configuration,workload_security,cloud_configuration,application_security,api_security

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

int64

\n

The date the rule was last updated, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Rule.

\n
\n
\n
\n
\n
\n

cases

\n
\n

[object]

\n

Cases for generating signals.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

customStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each rule case.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

createdAt

\n
\n

int64

\n

When the rule was created, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

creationAuthorId

\n
\n

int64

\n

User ID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

customMessage

\n
\n

string

\n

Custom/Overridden message for generated signals (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

customName

\n
\n

string

\n

Custom/Overridden name of the rule (used in case of Default rule update).

\n
\n \n
\n
\n
\n
\n
\n

deprecationDate

\n
\n

int64

\n

When the rule will be deprecated, timestamp in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

filters

\n
\n

[object]

\n

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

\n
\n
\n
\n
\n
\n

action

\n
\n

enum

\n

The type of filtering action. \nAllowed enum values: require,suppress

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query for selecting logs to apply the filtering action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

hasExtendedTitle

\n
\n

boolean

\n

Whether the notifications include the triggering group-by values in their title.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

isDefault

\n
\n

boolean

\n

Whether the rule is included by default.

\n
\n \n
\n
\n
\n
\n
\n

isDeleted

\n
\n

boolean

\n

Whether the rule has been deleted.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

complianceRuleOptions

\n
\n

object

\n

Options for cloud_configuration rules.\nFields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

\n
\n
\n
\n
\n
\n

complexRule

\n
\n

boolean

\n

Whether the rule is a complex one.\nMust be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

regoRule

\n
\n

object

\n

Rule details.

\n
\n
\n
\n
\n
\n

policy [required]

\n
\n

string

\n

The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/

\n
\n \n
\n
\n
\n
\n
\n

resourceTypes [required]

\n
\n

[string]

\n

List of resource types that will be evaluated upon. Must have at least one element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

resourceType

\n
\n

string

\n

Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

decreaseCriticalityBasedOnEnv

\n
\n

boolean

\n

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.\nThe decrement is applied when the environment tag of the signal starts with staging, test or dev.

\n
\n \n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

hardcodedEvaluatorType

\n
\n

enum

\n

Hardcoded evaluator type. \nAllowed enum values: log4shell

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries

\n
\n

[object]

\n

Queries for selecting logs which are part of the rule.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

correlatedByFields

\n
\n

[string]

\n

Fields to correlate by.

\n
\n \n
\n
\n
\n
\n
\n

correlatedQueryIndex

\n
\n

int32

\n

Index of the rule query used to retrieve the correlated field.

\n
\n \n
\n
\n
\n
\n
\n

defaultRuleId

\n
\n

string

\n

Default Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

ruleId

\n
\n

string

\n

Rule ID to match on signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The rule type. \nAllowed enum values: signal_correlation

\n
\n \n
\n
\n
\n
\n
\n

updateAuthorId

\n
\n

int64

\n

User ID of the user who updated the rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

The version of the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of data. \nAllowed enum values: GetRuleVersionHistoryResponse

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -7307,6 +7379,12 @@ "message": "A large number of failed login attempts.", "name": "Excessive number of failed attempts.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "detectionMethod": "string", "evaluationWindow": "integer", "impossibleTravelOptions": { @@ -7395,7 +7473,7 @@ "totalCount": "integer" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array containing the list of threat hunting jobs.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Threat hunting job attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

Time when the job was created.

\n
\n \n
\n
\n
\n
\n
\n

createdByHandle

\n
\n

string

\n

The handle of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdByName

\n
\n

string

\n

The name of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdFromRuleId

\n
\n

string

\n

ID of the rule used to create the job (if it is created from a rule).

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jobName

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

jobStatus

\n
\n

string

\n

Job status.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

Last modification time of the job.

\n
\n \n
\n
\n
\n
\n
\n

signalOutput

\n
\n

boolean

\n

Whether the job outputs signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of payload. \nAllowed enum values: historicalDetectionsJob

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata about the list of jobs.

\n
\n
\n
\n
\n
\n

totalCount

\n
\n

int32

\n

Number of jobs in the list.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array containing the list of threat hunting jobs.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Threat hunting job attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

Time when the job was created.

\n
\n \n
\n
\n
\n
\n
\n

createdByHandle

\n
\n

string

\n

The handle of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdByName

\n
\n

string

\n

The name of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdFromRuleId

\n
\n

string

\n

ID of the rule used to create the job (if it is created from a rule).

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jobName

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

jobStatus

\n
\n

string

\n

Job status.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

Last modification time of the job.

\n
\n \n
\n
\n
\n
\n
\n

signalOutput

\n
\n

boolean

\n

Whether the job outputs signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of payload. \nAllowed enum values: historicalDetectionsJob

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata about the list of jobs.

\n
\n
\n
\n
\n
\n

totalCount

\n
\n

int32

\n

Number of jobs in the list.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -7565,6 +7643,12 @@ "message": "A large number of failed login attempts.", "name": "Excessive number of failed attempts.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "detectionMethod": "string", "evaluationWindow": "integer", "impossibleTravelOptions": { @@ -7644,7 +7728,7 @@ "type": "string" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data for running a threat hunting job request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Run a threat hunting job request.

\n
\n
\n
\n
\n
\n

fromRule

\n
\n

object

\n

Definition of a threat hunting job based on a security monitoring rule.

\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the detection rule used to create the job.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notifications sent when the job is completed.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Request ID.

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of data. \nAllowed enum values: historicalDetectionsJobCreate

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data for running a threat hunting job request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Run a threat hunting job request.

\n
\n
\n
\n
\n
\n

fromRule

\n
\n

object

\n

Definition of a threat hunting job based on a security monitoring rule.

\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the detection rule used to create the job.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notifications sent when the job is completed.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Request ID.

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of data. \nAllowed enum values: historicalDetectionsJobCreate

\n
\n \n
\n
\n
\n
" } }, "ConvertJobResultToSignal": { @@ -7824,6 +7908,12 @@ "message": "A large number of failed login attempts.", "name": "Excessive number of failed attempts.", "options": { + "anomalyDetectionOptions": { + "bucketDuration": 300, + "detectionTolerance": 5, + "learningDuration": "integer", + "learningPeriodBaseline": "integer" + }, "detectionMethod": "string", "evaluationWindow": "integer", "impossibleTravelOptions": { @@ -7908,7 +7998,7 @@ "type": "string" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Threat hunting job response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Threat hunting job attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

Time when the job was created.

\n
\n \n
\n
\n
\n
\n
\n

createdByHandle

\n
\n

string

\n

The handle of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdByName

\n
\n

string

\n

The name of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdFromRuleId

\n
\n

string

\n

ID of the rule used to create the job (if it is created from a rule).

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jobName

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

jobStatus

\n
\n

string

\n

Job status.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

Last modification time of the job.

\n
\n \n
\n
\n
\n
\n
\n

signalOutput

\n
\n

boolean

\n

Whether the job outputs signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of payload. \nAllowed enum values: historicalDetectionsJob

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Threat hunting job response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Threat hunting job attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

Time when the job was created.

\n
\n \n
\n
\n
\n
\n
\n

createdByHandle

\n
\n

string

\n

The handle of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdByName

\n
\n

string

\n

The name of the user who created the job.

\n
\n \n
\n
\n
\n
\n
\n

createdFromRuleId

\n
\n

string

\n

ID of the rule used to create the job (if it is created from a rule).

\n
\n \n
\n
\n
\n
\n
\n

jobDefinition

\n
\n

object

\n

Definition of a threat hunting job.

\n
\n
\n
\n
\n
\n

calculatedFields

\n
\n

[object]

\n

Calculated fields.

\n
\n
\n
\n
\n
\n

expression [required]

\n
\n

string

\n

Expression.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Field name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

cases [required]

\n
\n

[object]

\n

Cases used for generating job results.

\n
\n
\n
\n
\n
\n

actions

\n
\n

[object]

\n

Action to perform for each rule case.

\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Options for the rule action

\n
\n
\n
\n
\n
\n

duration

\n
\n

int64

\n

Duration of the action in seconds. 0 indicates no expiration.

\n
\n \n
\n
\n
\n
\n
\n

flaggedIPType

\n
\n

enum

\n

Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. \nAllowed enum values: SUSPICIOUS,FLAGGED

\n
\n \n
\n
\n
\n
\n
\n

userBehaviorName

\n
\n

string

\n

Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The action type. \nAllowed enum values: block_ip,block_user,user_behavior,flag_ip

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Starting time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

groupSignalsBy

\n
\n

[string]

\n

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

\n
\n \n
\n
\n
\n
\n
\n

index [required]

\n
\n

string

\n

Index used to load the data.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Message for generated results.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

Job options.

\n
\n
\n
\n
\n
\n

anomalyDetectionOptions

\n
\n

object

\n

Options on anomaly detection method.

\n
\n
\n
\n
\n
\n

bucketDuration

\n
\n

enum

\n

Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300. \nAllowed enum values: 300,600,900,1800,3600,10800

\n
\n \n
\n
\n
\n
\n
\n

detectionTolerance

\n
\n

enum

\n

An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. \nAllowed enum values: 1,6,12,24,48,168,336

\n
\n \n
\n
\n
\n
\n
\n

learningPeriodBaseline

\n
\n

int64

\n

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

detectionMethod

\n
\n

enum

\n

The detection method. \nAllowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold,sequence_detection

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

impossibleTravelOptions

\n
\n

object

\n

Options on impossible travel detection method.

\n
\n
\n
\n
\n
\n

baselineUserLocations

\n
\n

boolean

\n

If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

keepAlive

\n
\n

enum

\n

Once a signal is generated, the signal will remain "open" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

maxSignalDuration

\n
\n

enum

\n

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

newValueOptions

\n
\n

object

\n

Options on new value detection method.

\n
\n
\n
\n
\n
\n

forgetAfter

\n
\n

enum

\n

The duration in days after which a learned value is forgotten. \nAllowed enum values: 1,2,7,14,21,28

\n
\n \n
\n
\n
\n
\n
\n

instantaneousBaseline

\n
\n

boolean

\n

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

\n
\n \n
\n
\n
\n
\n
\n

learningDuration

\n
\n

enum

\n

The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. \nAllowed enum values: 0,1,7

\n
\n \n
\n
\n
\n
\n
\n

learningMethod

\n
\n

enum

\n

The learning method used to determine when signals should be generated for values that weren't learned. \nAllowed enum values: duration,threshold

default: duration

\n
\n \n
\n
\n
\n
\n
\n

learningThreshold

\n
\n

enum

\n

A number of occurrences after which signals will be generated for values that weren't learned. \nAllowed enum values: 0,1

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sequenceDetectionOptions

\n
\n

object

\n

Options on sequence detection method.

\n
\n
\n
\n
\n
\n

stepTransitions

\n
\n

[object]

\n

Transitions defining the allowed order of steps and their evaluation windows.

\n
\n
\n
\n
\n
\n

child

\n
\n

string

\n

Name of the child step.

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

parent

\n
\n

string

\n

Name of the parent step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

Steps that define the conditions to be matched in sequence.

\n
\n
\n
\n
\n
\n

condition

\n
\n

string

\n

Condition referencing rule queries (e.g., a > 0).

\n
\n \n
\n
\n
\n
\n
\n

evaluationWindow

\n
\n

enum

\n

A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used. \nAllowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Unique name identifying the step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

thirdPartyRuleOptions

\n
\n

object

\n

Options on third party detection method.

\n
\n
\n
\n
\n
\n

defaultNotifications

\n
\n

[string]

\n

Notification targets for the logs that do not correspond to any of the cases.

\n
\n \n
\n
\n
\n
\n
\n

defaultStatus

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n

rootQueries

\n
\n

[object]

\n

Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

\n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

signalTitleTemplate

\n
\n

string

\n

A template for the signal title; if omitted, the title is generated based on the case name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

Queries for selecting logs analyzed by the job.

\n
\n
\n
\n
\n
\n

aggregation

\n
\n

enum

\n

The aggregation type. \nAllowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none

\n
\n \n
\n
\n
\n
\n
\n

dataSource

\n
\n

enum

\n

Source of events, either logs, audit trail, or Datadog events. \nAllowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events

default: logs

\n
\n \n
\n
\n
\n
\n
\n

distinctFields

\n
\n

[string]

\n

Field for which the cardinality is measured. Sent as an array.

\n
\n \n
\n
\n
\n
\n
\n

groupByFields

\n
\n

[string]

\n

Fields to group by.

\n
\n \n
\n
\n
\n
\n
\n

hasOptionalGroupByFields

\n
\n

boolean

\n

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

\n
\n \n
\n
\n
\n
\n
\n

metrics

\n
\n

[string]

\n

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to run on logs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

referenceTables

\n
\n

[object]

\n

Reference tables used in the queries.

\n
\n
\n
\n
\n
\n

checkPresence

\n
\n

boolean

\n

Whether to include or exclude the matched values.

\n
\n \n
\n
\n
\n
\n
\n

columnName

\n
\n

string

\n

The name of the column in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

logFieldPath

\n
\n

string

\n

The field in the log to match against the reference table.

\n
\n \n
\n
\n
\n
\n
\n

ruleQueryName

\n
\n

string

\n

The name of the query to apply the reference table to.

\n
\n \n
\n
\n
\n
\n
\n

tableName

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for generated signals.

\n
\n \n
\n
\n
\n
\n
\n

thirdPartyCases

\n
\n

[object]

\n

Cases for generating results from third-party detection method. Only available for third-party detection method.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the case.

\n
\n \n
\n
\n
\n
\n
\n

notifications

\n
\n

[string]

\n

Notification targets for each case.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

A query to map a third party event to this case.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Severity of the Security Signal. \nAllowed enum values: info,low,medium,high,critical

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

Ending time of data analyzed by the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Job type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jobName

\n
\n

string

\n

Job name.

\n
\n \n
\n
\n
\n
\n
\n

jobStatus

\n
\n

string

\n

Job status.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

Last modification time of the job.

\n
\n \n
\n
\n
\n
\n
\n

signalOutput

\n
\n

boolean

\n

Whether the job outputs signals.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the job.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of payload. \nAllowed enum values: historicalDetectionsJob

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringRule_2323193894.json b/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringRule_2323193894.json new file mode 100644 index 00000000000..be3e96311c3 --- /dev/null +++ b/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringRule_2323193894.json @@ -0,0 +1,42 @@ +{ + "name": "Example-Security-Monitoring", + "type": "log_detection", + "isEnabled": true, + "queries": [ + { + "aggregation": "count", + "dataSource": "logs", + "distinctFields": [], + "groupByFields": [ + "@usr.email", + "@network.client.ip" + ], + "hasOptionalGroupByFields": false, + "name": "", + "query": "service:app status:error" + } + ], + "cases": [ + { + "name": "", + "status": "info", + "notifications": [], + "condition": "a > 0.995" + } + ], + "message": "An anomaly detection rule", + "options": { + "detectionMethod": "anomaly_detection", + "evaluationWindow": 900, + "keepAlive": 3600, + "maxSignalDuration": 86400, + "anomalyDetectionOptions": { + "bucketDuration": 300, + "learningDuration": 24, + "detectionTolerance": 3, + "learningPeriodBaseline": 10 + } + }, + "tags": [], + "filters": [] +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 07e6f70ef6e..6ddf4d84149 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1485,6 +1485,11 @@ "suffix": "", "description": "Create a detection rule returns \"OK\" response" }, + { + "group": "security_monitoring", + "suffix": "_2323193894", + "description": "Create a detection rule with detection method 'anomaly_detection' returns \"OK\" response" + }, { "group": "security_monitoring", "suffix": "_2899714190", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index bec91538324..a21c8ad1f91 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -10236,6 +10236,10 @@ components: description: Whether the policy is pinned example: false type: boolean + policyType: + description: The type of the policy + example: policy + type: string policyVersion: description: The version of the policy example: '1' @@ -10414,11 +10418,11 @@ components: CloudWorkloadSecurityAgentPolicyVersion: description: The versions of the policy properties: - Date: + date: description: The date and time the version was created nullable: true type: string - Name: + name: description: The version of the policy example: 1.47.0-rc2 type: string @@ -10445,8 +10449,11 @@ components: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet' type: object CloudWorkloadSecurityAgentRuleActionHash: - additionalProperties: {} - description: An empty object indicating the hash action + description: Hash file specified by the field attribute + properties: + field: + description: The field of the hash action + type: string type: object CloudWorkloadSecurityAgentRuleActionMetadata: description: The metadata action applied on the scope matching the rule @@ -10494,9 +10501,14 @@ components: format: int64 type: integer value: - description: The value of the set action - type: string + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue' type: object + CloudWorkloadSecurityAgentRuleActionSetValue: + description: The value of the set action + oneOf: + - type: string + - type: integer + - type: boolean CloudWorkloadSecurityAgentRuleActions: description: The array of actions the rule can perform if triggered items: @@ -47542,6 +47554,86 @@ components: description: The name of the reference table. type: string type: object + SecurityMonitoringRuleAnomalyDetectionOptions: + additionalProperties: {} + description: Options on anomaly detection method. + properties: + bucketDuration: + $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration' + detectionTolerance: + $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance' + learningDuration: + $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration' + learningPeriodBaseline: + description: An optional override baseline to apply while the rule is in + the learning period. Must be greater than or equal to 0. + format: int64 + minimum: 0 + type: integer + type: object + SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration: + description: 'Duration in seconds of the time buckets used to aggregate events + matched by the rule. + + Must be greater than or equal to 300.' + enum: + - 300 + - 600 + - 900 + - 1800 + - 3600 + - 10800 + example: 300 + format: int32 + type: integer + x-enum-varnames: + - FIVE_MINUTES + - TEN_MINUTES + - FIFTEEN_MINUTES + - THIRTY_MINUTES + - ONE_HOUR + - THREE_HOURS + SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance: + description: 'An optional parameter that sets how permissive anomaly detection + is. + + Higher values require higher deviations before triggering a signal.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + example: 5 + format: int32 + type: integer + x-enum-varnames: + - ONE + - TWO + - THREE + - FOUR + - FIVE + SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration: + description: Learning duration in hours. Anomaly detection waits for at least + this amount of historical data before it starts evaluating. + enum: + - 1 + - 6 + - 12 + - 24 + - 48 + - 168 + - 336 + format: int32 + type: integer + x-enum-varnames: + - ONE_HOUR + - SIX_HOURS + - TWELVE_HOURS + - ONE_DAY + - TWO_DAYS + - ONE_WEEK + - TWO_WEEKS SecurityMonitoringRuleCase: description: Case when signal is generated. properties: @@ -47907,6 +47999,8 @@ components: SecurityMonitoringRuleOptions: description: Options. properties: + anomalyDetectionOptions: + $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions' complianceRuleOptions: $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' decreaseCriticalityBasedOnEnv: @@ -55346,6 +55440,8 @@ components: ThreatHuntingJobOptions: description: Job options. properties: + anomalyDetectionOptions: + $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions' detectionMethod: $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' evaluationWindow: