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": "
data
\n[object]
A list of Agent rules objects
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\n[object]
A list of Agent rules objects
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Create a new Cloud Workload Security Agent rule.
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent.
blocking
\n[string]
The blocking policies that the rule belongs to.
description
\nstring
The description of the Agent rule.
disabled
\n[string]
The disabled policies that the rule belongs to.
enabled
\nboolean
Whether the Agent rule is enabled.
expression [required]
\nstring
The SECL expression of the Agent rule.
filters
\n[string]
The platforms the Agent rule is supported on.
monitoring
\n[string]
The monitoring policies that the rule belongs to.
name [required]
\nstring
The name of the Agent rule.
policy_id
\nstring
The ID of the policy where the Agent rule is saved.
product_tags
\n[string]
The list of product tags associated with the rule.
silent
\nboolean
Whether the rule is silent.
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Create a new Cloud Workload Security Agent rule.
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent.
blocking
\n[string]
The blocking policies that the rule belongs to.
description
\nstring
The description of the Agent rule.
disabled
\n[string]
The disabled policies that the rule belongs to.
enabled
\nboolean
Whether the Agent rule is enabled.
expression [required]
\nstring
The SECL expression of the Agent rule.
filters
\n[string]
The platforms the Agent rule is supported on.
monitoring
\n[string]
The monitoring policies that the rule belongs to.
name [required]
\nstring
The name of the Agent rule.
policy_id
\nstring
The ID of the policy where the Agent rule is saved.
product_tags
\n[string]
The list of product tags associated with the rule.
silent
\nboolean
Whether the rule is silent.
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Update an existing Cloud Workload Security Agent rule
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent
blocking
\n[string]
The blocking policies that the rule belongs to
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
monitoring
\n[string]
The monitoring policies that the rule belongs to
policy_id
\nstring
The ID of the policy where the Agent rule is saved
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
id
\nstring
The ID of the Agent rule
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Update an existing Cloud Workload Security Agent rule
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent
blocking
\n[string]
The blocking policies that the rule belongs to
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
monitoring
\n[string]
The monitoring policies that the rule belongs to
policy_id
\nstring
The ID of the policy where the Agent rule is saved
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
id
\nstring
The ID of the Agent rule
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\n[object]
A list of Agent policy objects
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
Date
\nstring
The date and time the version was created
Name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\n[object]
A list of Agent policy objects
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyType
\nstring
The type of the policy
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
date
\nstring
The date and time the version was created
name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
Date
\nstring
The date and time the version was created
Name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyType
\nstring
The type of the policy
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
date
\nstring
The date and time the version was created
name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
Date
\nstring
The date and time the version was created
Name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyType
\nstring
The type of the policy
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
date
\nstring
The date and time the version was created
name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
Date
\nstring
The date and time the version was created
Name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\nobject
Object for a single Agent policy
attributes
\nobject
A Cloud Workload Security Agent policy returned by the API
blockingRulesCount
\nint32
The number of rules with the blocking feature in this policy
datadogManaged
\nboolean
Whether the policy is managed by Datadog
description
\nstring
The description of the policy
disabledRulesCount
\nint32
The number of rules that are disabled in this policy
enabled
\nboolean
Whether the Agent policy is enabled
hostTags
\n[string]
The host tags defining where this policy is deployed
hostTagsLists
\n[array]
The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoringRulesCount
\nint32
The number of rules in the monitoring state in this policy
name
\nstring
The name of the policy
pinned
\nboolean
Whether the policy is pinned
policyType
\nstring
The type of the policy
policyVersion
\nstring
The version of the policy
priority
\nint64
The priority of the policy
ruleCount
\nint32
The number of rules in this policy
updateDate
\nint64
Timestamp in milliseconds when the policy was last updated
updatedAt
\nint64
When the policy was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the policy
handle
\nstring
The handle of the user
name
\nstring
The name of the user
versions
\n[object]
The versions of the policy
date
\nstring
The date and time the version was created
name
\nstring
The version of the policy
id
\nstring
The ID of the Agent policy
type
\nenum
The type of the resource, must always be policy \nAllowed enum values: policy
default: policy
data
\n[object]
A list of Agent rules objects
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\n[object]
A list of Agent rules objects
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Create a new Cloud Workload Security Agent rule.
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent.
blocking
\n[string]
The blocking policies that the rule belongs to.
description
\nstring
The description of the Agent rule.
disabled
\n[string]
The disabled policies that the rule belongs to.
enabled
\nboolean
Whether the Agent rule is enabled.
expression [required]
\nstring
The SECL expression of the Agent rule.
filters
\n[string]
The platforms the Agent rule is supported on.
monitoring
\n[string]
The monitoring policies that the rule belongs to.
name [required]
\nstring
The name of the Agent rule.
policy_id
\nstring
The ID of the policy where the Agent rule is saved.
product_tags
\n[string]
The list of product tags associated with the rule.
silent
\nboolean
Whether the rule is silent.
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Create a new Cloud Workload Security Agent rule.
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent.
blocking
\n[string]
The blocking policies that the rule belongs to.
description
\nstring
The description of the Agent rule.
disabled
\n[string]
The disabled policies that the rule belongs to.
enabled
\nboolean
Whether the Agent rule is enabled.
expression [required]
\nstring
The SECL expression of the Agent rule.
filters
\n[string]
The platforms the Agent rule is supported on.
monitoring
\n[string]
The monitoring policies that the rule belongs to.
name [required]
\nstring
The name of the Agent rule.
policy_id
\nstring
The ID of the policy where the Agent rule is saved.
product_tags
\n[string]
The list of product tags associated with the rule.
silent
\nboolean
Whether the rule is silent.
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data
\nobject
Object for a single Agent rule
attributes
\nobject
A Cloud Workload Security Agent rule returned by the API
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agentConstraint
\nstring
The version of the Agent
blocking
\n[string]
The blocking policies that the rule belongs to
category
\nstring
The category of the Agent rule
creationAuthorUuId
\nstring
The ID of the user who created the rule
creationDate
\nint64
When the Agent rule was created, timestamp in milliseconds
creator
\nobject
The attributes of the user who created the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
defaultRule
\nboolean
Whether the rule is included by default
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
filters
\n[string]
The platforms the Agent rule is supported on
monitoring
\n[string]
The monitoring policies that the rule belongs to
name
\nstring
The name of the Agent rule
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
updateAuthorUuId
\nstring
The ID of the user who updated the rule
updateDate
\nint64
Timestamp in milliseconds when the Agent rule was last updated
updatedAt
\nint64
When the Agent rule was last updated, timestamp in milliseconds
updater
\nobject
The attributes of the user who last updated the Agent rule
handle
\nstring
The handle of the user
name
\nstring
The name of the user
version
\nint64
The version of the Agent rule
id
\nstring
The ID of the Agent rule
type
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Update an existing Cloud Workload Security Agent rule
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
An empty object indicating the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\nstring
The value of the set action
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent
blocking
\n[string]
The blocking policies that the rule belongs to
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
monitoring
\n[string]
The monitoring policies that the rule belongs to
policy_id
\nstring
The ID of the policy where the Agent rule is saved
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
id
\nstring
The ID of the Agent rule
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule
data [required]
\nobject
Object for a single Agent rule
attributes [required]
\nobject
Update an existing Cloud Workload Security Agent rule
actions
\n[object]
The array of actions the rule can perform if triggered
filter
\nstring
SECL expression used to target the container to apply the action on
hash
\nobject
Hash file specified by the field attribute
field
\nstring
The field of the hash action
kill
\nobject
Kill system call applied on the container matching the rule
signal
\nstring
Supported signals for the kill system call
metadata
\nobject
The metadata action applied on the scope matching the rule
image_tag
\nstring
The image tag of the metadata action
service
\nstring
The service of the metadata action
short_image
\nstring
The short image of the metadata action
set
\nobject
The set action applied on the scope matching the rule
append
\nboolean
Whether the value should be appended to the field.
default_value
\nstring
The default value of the set action
expression
\nstring
The expression of the set action.
field
\nstring
The field of the set action
inherited
\nboolean
Whether the value should be inherited.
name
\nstring
The name of the set action
scope
\nstring
The scope of the set action.
size
\nint64
The size of the set action.
ttl
\nint64
The time to live of the set action.
value
\n<oneOf>
The value of the set action
Option 1
\nstring
Option 2
\ninteger
Option 3
\nboolean
agent_version
\nstring
Constrain the rule to specific versions of the Datadog Agent
blocking
\n[string]
The blocking policies that the rule belongs to
description
\nstring
The description of the Agent rule
disabled
\n[string]
The disabled policies that the rule belongs to
enabled
\nboolean
Whether the Agent rule is enabled
expression
\nstring
The SECL expression of the Agent rule
monitoring
\n[string]
The monitoring policies that the rule belongs to
policy_id
\nstring
The ID of the policy where the Agent rule is saved
product_tags
\n[string]
The list of product tags associated with the rule
silent
\nboolean
Whether the rule is silent.
id
\nstring
The ID of the Agent rule
type [required]
\nenum
The type of the resource, must always be agent_rule \nAllowed enum values: agent_rule
default: agent_rule