diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 4f6eab95b84..d82b5581556 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -8353,7 +8353,7 @@ menu: - CreateIncidentImpact unstable: - v2 - order: 7 + order: 8 - name: List an incident's impacts url: '#list-an-incidents-impacts' identifier: incidents-list-an-incidents-impacts @@ -8366,23 +8366,49 @@ menu: - ListIncidentImpacts unstable: - v2 - order: 6 - - name: 'Create, update, and delete incident attachments' - url: '#create,-update,-and-delete-incident-attachments' - identifier: 'incidents-create,-update,-and-delete-incident-attachments' + order: 7 + - name: Update incident attachment + url: '#update-incident-attachment' + identifier: incidents-update-incident-attachment parent: incidents generated: true params: versions: - v2 operationids: - - UpdateIncidentAttachments + - UpdateIncidentAttachment unstable: - v2 - order: 8 - - name: Get a list of attachments - url: '#get-a-list-of-attachments' - identifier: incidents-get-a-list-of-attachments + order: 37 + - name: Delete incident attachment + url: '#delete-incident-attachment' + identifier: incidents-delete-incident-attachment + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentAttachment + unstable: + - v2 + order: 36 + - name: Create incident attachment + url: '#create-incident-attachment' + identifier: incidents-create-incident-attachment + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentAttachment + unstable: + - v2 + order: 35 + - name: List incident attachments + url: '#list-incident-attachments' + identifier: incidents-list-incident-attachments parent: incidents generated: true params: @@ -8392,7 +8418,7 @@ menu: - ListIncidentAttachments unstable: - v2 - order: 7 + order: 34 - name: Update an existing incident url: '#update-an-existing-incident' identifier: incidents-update-an-existing-incident diff --git a/content/en/api/v2/csm-threats/examples.json b/content/en/api/v2/csm-threats/examples.json index d006cf6b8b8..71f8ebef190 100644 --- a/content/en/api/v2/csm-threats/examples.json +++ b/content/en/api/v2/csm-threats/examples.json @@ -9,9 +9,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -30,9 +28,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -69,7 +65,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

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
" + "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
" }, "403": { "json": { @@ -103,9 +99,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -124,9 +118,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -162,7 +154,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

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
" + "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
" }, "400": { "json": { @@ -213,9 +205,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -234,9 +224,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -256,7 +244,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

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
" + "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
" } }, "DeleteCSMThreatsAgentRule": { @@ -301,9 +289,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -322,9 +308,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -360,7 +344,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

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
" + "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
" }, "403": { "json": { @@ -402,9 +386,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -423,9 +405,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -461,7 +441,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

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
" + "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
" }, "400": { "json": { @@ -517,9 +497,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -538,9 +516,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -559,7 +535,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

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

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

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

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

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
" + "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
" }, "400": { "json": { @@ -996,9 +968,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1017,9 +987,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1056,7 +1024,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

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
" + "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
" }, "403": { "json": { @@ -1090,9 +1058,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1111,9 +1077,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1149,7 +1113,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

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
" + "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
" }, "400": { "json": { @@ -1200,9 +1164,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1221,9 +1183,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1243,7 +1203,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

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
" + "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
" } }, "DeleteCloudWorkloadSecurityAgentRule": { @@ -1288,9 +1248,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1309,9 +1267,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1347,7 +1303,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

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
" + "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
" }, "403": { "json": { @@ -1389,9 +1345,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1410,9 +1364,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1448,7 +1400,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

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
" + "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
" }, "400": { "json": { @@ -1504,9 +1456,7 @@ "actions": [ { "filter": "string", - "hash": { - "field": "string" - }, + "hash": {}, "kill": { "signal": "string" }, @@ -1525,9 +1475,7 @@ "scope": "string", "size": "integer", "ttl": "integer", - "value": { - "type": "undefined" - } + "value": "string" } } ], @@ -1546,7 +1494,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

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
" + "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
" } } } \ 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 d7c4ed36b90..1e334c658de 100644 --- a/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json +++ b/content/en/api/v2/csm-threats/request.CreateCSMThreatsAgentRule_1295653933.json @@ -18,9 +18,7 @@ } }, { - "hash": { - "field": "exec.file" - } + "hash": {} } ] }, 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 8c0f02a459b..d30c5d29e00 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": "exec.file.path", + "expression": "open.file.path", "default_value": "/dev/null", "scope": "process" } diff --git a/content/en/api/v2/incidents/examples.json b/content/en/api/v2/incidents/examples.json index 41a55c32b86..4f4af6cdb8c 100644 --- a/content/en/api/v2/incidents/examples.json +++ b/content/en/api/v2/incidents/examples.json @@ -139,7 +139,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incidents.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

\n

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

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

pagination

\n
\n

object

\n

Pagination properties.

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

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

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

offset

\n
\n

int64

\n

The index of the first element in the results.

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

size

\n
\n

int64

\n

Maximum size of pages to return.

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

data [required]

\n
\n

[object]

\n

An array of incidents.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

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

attributes [required]

\n
\n

object

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

attachment

\n
\n

object

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

documentUrl

\n
\n

string

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

title

\n
\n

string

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

attachment_type

\n
\n

enum

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

modified

\n
\n

date-time

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

id [required]

\n
\n

string

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

relationships [required]

\n
\n

object

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

last_modified_by_user

\n
\n

object

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

data [required]

\n
\n

object

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

id [required]

\n
\n

string

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

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

pagination

\n
\n

object

\n

Pagination properties.

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

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

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

offset

\n
\n

int64

\n

The index of the first element in the results.

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

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -319,7 +319,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

\n

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

data [required]

\n
\n

object

\n

Incident data from a response.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

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

attributes [required]

\n
\n

object

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

attachment

\n
\n

object

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

documentUrl

\n
\n

string

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

title

\n
\n

string

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

attachment_type

\n
\n

enum

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

modified

\n
\n

date-time

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

id [required]

\n
\n

string

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

relationships [required]

\n
\n

object

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

last_modified_by_user

\n
\n

object

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

data [required]

\n
\n

object

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

id [required]

\n
\n

string

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -2656,7 +2656,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data returned by an incident search.

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

attributes

\n
\n

object

\n

Attributes returned by an incident search.

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

facets [required]

\n
\n

object

\n

Facet data for incidents returned by a search query.

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

commander

\n
\n

[object]

\n

Facet data for incident commander users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

created_by

\n
\n

[object]

\n

Facet data for incident creator users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

fields

\n
\n

[object]

\n

Facet data for incident property fields.

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

aggregates

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

facets [required]

\n
\n

[object]

\n

Facet data for the property field of an incident.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

impact

\n
\n

[object]

\n

Facet data for incident impact attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

last_modified_by

\n
\n

[object]

\n

Facet data for incident last modified by users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

postmortem

\n
\n

[object]

\n

Facet data for incident postmortem existence.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

responder

\n
\n

[object]

\n

Facet data for incident responder users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

severity

\n
\n

[object]

\n

Facet data for incident severity attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

state

\n
\n

[object]

\n

Facet data for incident state attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

time_to_repair

\n
\n

[object]

\n

Facet data for incident time to repair metrics.

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

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

time_to_resolve

\n
\n

[object]

\n

Facet data for incident time to resolve metrics.

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

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

incidents [required]

\n
\n

[object]

\n

Incidents returned by the search.

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

data [required]

\n
\n

object

\n

Incident data from a response.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

total [required]

\n
\n

int32

\n

Number of incidents returned by the search.

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

type

\n
\n

enum

\n

Incident search result type. \nAllowed enum values: incidents_search_results

default: incidents_search_results

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

\n

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

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

pagination

\n
\n

object

\n

Pagination properties.

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

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

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

offset

\n
\n

int64

\n

The index of the first element in the results.

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

size

\n
\n

int64

\n

Maximum size of pages to return.

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

data [required]

\n
\n

object

\n

Data returned by an incident search.

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

attributes

\n
\n

object

\n

Attributes returned by an incident search.

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

facets [required]

\n
\n

object

\n

Facet data for incidents returned by a search query.

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

commander

\n
\n

[object]

\n

Facet data for incident commander users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

created_by

\n
\n

[object]

\n

Facet data for incident creator users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

fields

\n
\n

[object]

\n

Facet data for incident property fields.

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

aggregates

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

facets [required]

\n
\n

[object]

\n

Facet data for the property field of an incident.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

impact

\n
\n

[object]

\n

Facet data for incident impact attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

last_modified_by

\n
\n

[object]

\n

Facet data for incident last modified by users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

postmortem

\n
\n

[object]

\n

Facet data for incident postmortem existence.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

responder

\n
\n

[object]

\n

Facet data for incident responder users.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

ID of the user.

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

severity

\n
\n

[object]

\n

Facet data for incident severity attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

state

\n
\n

[object]

\n

Facet data for incident state attributes.

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

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

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

name

\n
\n

string

\n

The facet value appearing in search results.

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

time_to_repair

\n
\n

[object]

\n

Facet data for incident time to repair metrics.

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

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

time_to_resolve

\n
\n

[object]

\n

Facet data for incident time to resolve metrics.

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

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

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

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

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

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

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

name [required]

\n
\n

string

\n

Name of the incident property field.

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

incidents [required]

\n
\n

[object]

\n

Incidents returned by the search.

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

data [required]

\n
\n

object

\n

Incident data from a response.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

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

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

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

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

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

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

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

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

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

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

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

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

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

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

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

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

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

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

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

Option 1

\n
\n

object

\n

A field with a single value selected.

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

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

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

value

\n
\n

string

\n

The single value selected for this field.

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

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

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

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

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

value

\n
\n

[string]

\n

The multiple values selected for this field.

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

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

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

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

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

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

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

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

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

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

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

name

\n
\n

string

\n

Non Datadog creator name.

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

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

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

display_name

\n
\n

string

\n

The name of the notified handle.

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

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

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

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

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

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

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

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

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

state

\n
\n

string

\n

The state incident.

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

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

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

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

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

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

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

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

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

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

visibility

\n
\n

string

\n

The incident visibility status.

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

id [required]

\n
\n

string

\n

The incident's ID.

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

relationships

\n
\n

object

\n

The incident's relationships from a response.

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

attachments

\n
\n

object

\n

A relationship reference for attachments.

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

data [required]

\n
\n

[object]

\n

An array of incident attachments.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

commander_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

created_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

declared_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

impacts

\n
\n

object

\n

Relationship to impacts.

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

data [required]

\n
\n

[object]

\n

An array of incident impacts.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

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

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

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

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

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

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

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

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

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

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

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

last_modified_by_user

\n
\n

object

\n

Relationship to user.

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

data [required]

\n
\n

object

\n

Relationship to user object.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

responders

\n
\n

object

\n

Relationship to incident responders.

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

data [required]

\n
\n

[object]

\n

An array of incident responders.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

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

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

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

data [required]

\n
\n

[object]

\n

An array of user defined fields.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

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

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

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

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

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

total [required]

\n
\n

int32

\n

Number of incidents returned by the search.

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

type

\n
\n

enum

\n

Incident search result type. \nAllowed enum values: incidents_search_results

default: incidents_search_results

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

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

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

Option 1

\n
\n

object

\n

User object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

email

\n
\n

string

\n

Email of the user.

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

handle

\n
\n

string

\n

Handle of the user.

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

icon

\n
\n

string

\n

URL of the user's icon.

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

name

\n
\n

string

\n

Name of the user.

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

uuid

\n
\n

string

\n

UUID of the user.

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

id

\n
\n

string

\n

ID of the user.

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

Option 2

\n
\n

object

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

attributes [required]

\n
\n

object

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

attachment

\n
\n

object

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

documentUrl

\n
\n

string

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

title

\n
\n

string

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

attachment_type

\n
\n

enum

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

modified

\n
\n

date-time

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

id [required]

\n
\n

string

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

relationships [required]

\n
\n

object

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

last_modified_by_user

\n
\n

object

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

data [required]

\n
\n

object

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

id [required]

\n
\n

string

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

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

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

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

pagination

\n
\n

object

\n

Pagination properties.

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

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

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

offset

\n
\n

int64

\n

The index of the first element in the results.

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

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -2885,7 +2885,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

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

attributes

\n
\n

object

\n

The incident's attributes from a response.

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

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

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

case_id

\n
\n

int64

\n

The incident case id.

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

created

\n
\n

date-time

\n

Timestamp when the incident was created.

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

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A single incident attachment.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3065,7 +3065,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A single incident attachment.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3193,16 +3193,17 @@ { "attributes": { "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" + "documentUrl": "string", + "title": "string" }, - "attachment_type": "postmortem" + "attachment_type": "string", + "modified": "2019-09-19T10:00:00.000Z" }, - "id": "00000000-abcd-0001-0000-000000000000", + "id": "00000000-abcd-0002-0000-000000000000", "relationships": { "last_modified_by_user": { "data": { - "id": "00000000-0000-0000-2345-000000000000", + "id": "", "type": "users" } } @@ -3228,43 +3229,82 @@ "verified": false }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n
\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentAttachment": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "string", + "title": "string" + }, + "attachment_type": "string", + "modified": "2019-09-19T10:00:00.000Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" } + } + }, + "type": "incident_attachments" + }, + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "verified": false }, + "id": "string", "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n
\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3274,7 +3314,48 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "401": { + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "incident_attachments" + } + }, + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "string", + "title": "string" + }, + "attachment_type": "string" + }, + "id": "string", + "type": "incident_attachments" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentAttachment": { + "responses": { + "400": { "json": { "errors": [ "Bad Request" @@ -3313,31 +3394,30 @@ "html": "" } }, - "UpdateIncidentAttachments": { + "UpdateIncidentAttachment": { "responses": { "200": { "json": { - "data": [ - { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" + "data": { + "attributes": { + "attachment": { + "documentUrl": "string", + "title": "string" }, - "id": "00000000-abcd-0001-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } + "attachment_type": "string", + "modified": "2019-09-19T10:00:00.000Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" } - }, - "type": "incident_attachments" - } - ], + } + }, + "type": "incident_attachments" + }, "included": [ { "attributes": { @@ -3356,43 +3436,11 @@ "verified": false }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n
\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n
\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3402,14 +3450,6 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, "403": { "json": { "errors": [ @@ -3437,28 +3477,23 @@ }, "request": { "json_curl": { - "data": [ - { - "type": "incident_attachments" - } - ] + "data": { + "type": "incident_attachments" + } }, "json": { - "data": [ - { - "attributes": { - "attachment": { - "documentUrl": "https://www.example.com/webstore-failure-runbook", - "title": "Runbook for webstore service failures" - }, - "attachment_type": "link" - }, - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_attachments" - } - ] + "data": { + "attributes": { + "attachment": { + "documentUrl": "string", + "title": "string" + } + }, + "id": "string", + "type": "incident_attachments" + } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments. An attachment object without an "id" key indicates that you want to\ncreate that attachment. An attachment object without an "attributes" key indicates that you want to\ndelete that attachment. An attachment object with both the "id" key and a populated "attributes" object\nindicates that you want to update that attachment.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

 <oneOf>

\n

Incident attachment attributes.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" } }, "ListIncidentImpacts": { diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 8fd4203f099..eb3c2f2342d 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -793,13 +793,6 @@ "description": "Update an existing incident returns \"OK\" response" } ], - "UpdateIncidentAttachments": [ - { - "group": "incidents", - "suffix": "_3881702075", - "description": "Create an incident attachment returns \"OK\" response" - } - ], "CreateIncidentIntegration": [ { "group": "incidents", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index c3d75ec6dd3..4a004629f3e 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -178,6 +178,15 @@ components: required: true schema: type: string + AttachmentIncludeQueryParameter: + description: 'Resource to include in the response. Supported value: `last_modified_by_user`.' + explode: false + in: query + name: include + required: false + schema: + example: last_modified_by_user + type: string AuthNMappingID: description: The UUID of the AuthN Mapping. in: path @@ -458,26 +467,6 @@ components: items: $ref: '#/components/schemas/GetIssueIncludeQueryParameterItem' type: array - IncidentAttachmentFilterQueryParameter: - description: Specifies which types of attachments are included in the response. - explode: false - in: query - name: filter[attachment_type] - required: false - schema: - items: - $ref: '#/components/schemas/IncidentAttachmentAttachmentType' - type: array - IncidentAttachmentIncludeQueryParameter: - description: Specifies which types of related objects are included in the response. - explode: false - in: query - name: include - required: false - schema: - items: - $ref: '#/components/schemas/IncidentAttachmentRelatedObject' - type: array IncidentIDPathParameter: description: The UUID of the incident. in: path @@ -5344,6 +5333,124 @@ components: - findings - project type: object + Attachment: + properties: + data: + $ref: '#/components/schemas/AttachmentData' + included: + items: + $ref: '#/components/schemas/AttachmentIncluded' + type: array + type: object + AttachmentArray: + properties: + data: + example: + - attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123 + title: Postmortem IR-123 + attachment_type: postmortem + modified: '2025-01-01T01:01:01.000000001Z' + id: 00000000-abcd-0002-0000-000000000000 + relationships: + last_modified_by_user: + data: + id: 00000000-0000-0000-cccc-000000000000 + type: users + type: incident_attachments + items: + $ref: '#/components/schemas/AttachmentData' + type: array + included: + items: + $ref: '#/components/schemas/AttachmentIncluded' + type: array + required: + - data + type: object + AttachmentData: + example: + attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123 + title: Postmortem IR-123 + attachment_type: postmortem + modified: '2025-01-01T01:01:01.000000001Z' + id: 00000000-abcd-0002-0000-000000000000 + relationships: + last_modified_by_user: + data: + id: 00000000-0000-0000-cccc-000000000000 + type: users + type: incident_attachments + properties: + attributes: + $ref: '#/components/schemas/AttachmentDataAttributes' + id: + example: 00000000-abcd-0002-0000-000000000000 + type: string + relationships: + $ref: '#/components/schemas/AttachmentDataRelationships' + type: + $ref: '#/components/schemas/IncidentAttachmentType' + required: + - type + - attributes + - relationships + - id + type: object + AttachmentDataAttributes: + properties: + attachment: + $ref: '#/components/schemas/AttachmentDataAttributesAttachment' + attachment_type: + $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType' + modified: + format: date-time + type: string + type: object + AttachmentDataAttributesAttachment: + properties: + documentUrl: + type: string + title: + type: string + type: object + AttachmentDataAttributesAttachmentType: + enum: + - postmortem + - link + type: string + x-enum-varnames: + - POSTMORTEM + - LINK + AttachmentDataRelationships: + properties: + last_modified_by_user: + $ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUser' + type: object + AttachmentDataRelationshipsLastModifiedByUser: + properties: + data: + $ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUserData' + required: + - data + type: object + AttachmentDataRelationshipsLastModifiedByUserData: + properties: + id: + example: '' + type: string + type: + $ref: '#/components/schemas/UserType' + required: + - type + - id + type: object + AttachmentIncluded: + oneOf: + - $ref: '#/components/schemas/User140420082644000' AuditLogsEvent: description: Object description of an Audit Logs event after it is processed and stored by Datadog. @@ -10236,10 +10343,6 @@ 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' @@ -10418,11 +10521,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 @@ -10449,11 +10552,8 @@ components: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet' type: object CloudWorkloadSecurityAgentRuleActionHash: - description: Hash file specified by the field attribute - properties: - field: - description: The field of the hash action - type: string + additionalProperties: {} + description: An empty object indicating the hash action type: object CloudWorkloadSecurityAgentRuleActionMetadata: description: The metadata action applied on the scope matching the rule @@ -10501,14 +10601,9 @@ components: format: int64 type: integer value: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue' + description: The value of the set action + type: string 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: @@ -12872,6 +12967,45 @@ components: required: - type type: object + CreateAttachmentRequest: + example: + data: + attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123 + title: Postmortem-IR-123 + attachment_type: postmortem + id: 00000000-0000-0000-0000-000000000000 + type: incident_attachments + properties: + data: + $ref: '#/components/schemas/CreateAttachmentRequestData' + type: object + CreateAttachmentRequestData: + properties: + attributes: + $ref: '#/components/schemas/CreateAttachmentRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/IncidentAttachmentType' + required: + - type + type: object + CreateAttachmentRequestDataAttributes: + properties: + attachment: + $ref: '#/components/schemas/CreateAttachmentRequestDataAttributesAttachment' + attachment_type: + $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType' + type: object + CreateAttachmentRequestDataAttributesAttachment: + properties: + documentUrl: + type: string + title: + type: string + type: object CreateCaseRequestArray: description: List of requests to create cases for security findings. properties: @@ -25559,126 +25693,6 @@ components: type: string x-mimetype: application/xml type: object - IncidentAttachmentAttachmentType: - description: The type of the incident attachment attributes. - enum: - - link - - postmortem - example: link - type: string - x-enum-varnames: - - LINK - - POSTMORTEM - IncidentAttachmentAttributes: - description: The attributes object for an attachment. - oneOf: - - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes' - - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes' - IncidentAttachmentData: - description: A single incident attachment. - example: - attributes: - attachment: - documentUrl: '' - title: Postmortem IR-123 - attachment_type: postmortem - id: 00000000-abcd-0002-0000-000000000000 - relationships: - last_modified_by_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - type: incident_attachments - properties: - attributes: - $ref: '#/components/schemas/IncidentAttachmentAttributes' - id: - description: A unique identifier that represents the incident attachment. - example: 00000000-abcd-0001-0000-000000000000 - type: string - relationships: - $ref: '#/components/schemas/IncidentAttachmentRelationships' - type: - $ref: '#/components/schemas/IncidentAttachmentType' - required: - - type - - attributes - - id - - relationships - type: object - IncidentAttachmentLinkAttachmentType: - default: link - description: The type of link attachment attributes. - enum: - - link - example: link - type: string - x-enum-varnames: - - LINK - IncidentAttachmentLinkAttributes: - description: The attributes object for a link attachment. - properties: - attachment: - $ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject' - attachment_type: - $ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType' - modified: - description: Timestamp when the incident attachment link was last modified. - format: date-time - readOnly: true - type: string - required: - - attachment_type - - attachment - type: object - IncidentAttachmentLinkAttributesAttachmentObject: - description: The link attachment. - properties: - documentUrl: - description: The URL of this link attachment. - example: https://www.example.com/webstore-failure-runbook - type: string - title: - description: The title of this link attachment. - example: Runbook for webstore service failures - type: string - required: - - documentUrl - - title - type: object - IncidentAttachmentPostmortemAttachmentType: - default: postmortem - description: The type of postmortem attachment attributes. - enum: - - postmortem - example: postmortem - type: string - x-enum-varnames: - - POSTMORTEM - IncidentAttachmentPostmortemAttributes: - description: The attributes object for a postmortem attachment. - properties: - attachment: - $ref: '#/components/schemas/IncidentAttachmentsPostmortemAttributesAttachmentObject' - attachment_type: - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttachmentType' - required: - - attachment_type - - attachment - type: object - IncidentAttachmentRelatedObject: - description: The object related to an incident attachment. - enum: - - users - type: string - x-enum-varnames: - - USERS - IncidentAttachmentRelationships: - description: The incident attachment's relationships. - properties: - last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' - type: object IncidentAttachmentType: default: incident_attachments description: The incident attachment resource type. @@ -25688,142 +25702,6 @@ components: type: string x-enum-varnames: - INCIDENT_ATTACHMENTS - IncidentAttachmentUpdateAttributes: - description: Incident attachment attributes. - oneOf: - - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes' - - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes' - IncidentAttachmentUpdateData: - description: A single incident attachment. - properties: - attributes: - $ref: '#/components/schemas/IncidentAttachmentUpdateAttributes' - id: - description: A unique identifier that represents the incident attachment. - example: 00000000-abcd-0001-0000-000000000000 - type: string - type: - $ref: '#/components/schemas/IncidentAttachmentType' - required: - - type - type: object - IncidentAttachmentUpdateRequest: - description: The update request for an incident's attachments. - properties: - data: - description: 'An array of incident attachments. An attachment object without - an "id" key indicates that you want to - - create that attachment. An attachment object without an "attributes" key - indicates that you want to - - delete that attachment. An attachment object with both the "id" key and - a populated "attributes" object - - indicates that you want to update that attachment.' - example: - - attributes: - attachment: - documentUrl: https://app.datadoghq.com/notebook/123 - title: Postmortem IR-123 - attachment_type: postmortem - id: 00000000-abcd-0002-0000-000000000000 - type: incident_attachments - - attributes: - attachment: - documentUrl: https://www.example.com/webstore-failure-runbook - title: Runbook for webstore service failures - attachment_type: link - type: incident_attachments - - id: 00000000-abcd-0003-0000-000000000000 - type: incident_attachments - items: - $ref: '#/components/schemas/IncidentAttachmentUpdateData' - type: array - required: - - data - type: object - IncidentAttachmentUpdateResponse: - description: The response object containing the created or updated incident - attachments. - properties: - data: - description: 'An array of incident attachments. Only the attachments that - were created or updated by the request are - - returned.' - example: - - attributes: - attachment: - documentUrl: '' - title: Postmortem IR-123 - attachment_type: postmortem - id: 00000000-abcd-0002-0000-000000000000 - relationships: - last_modified_by_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - type: incident_attachments - items: - $ref: '#/components/schemas/IncidentAttachmentData' - type: array - included: - description: Included related resources that the user requested. - items: - $ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem' - type: array - required: - - data - type: object - IncidentAttachmentsPostmortemAttributesAttachmentObject: - description: The postmortem attachment. - properties: - documentUrl: - description: The URL of this notebook attachment. - example: https://app.datadoghq.com/notebook/123 - type: string - title: - description: The title of this postmortem attachment. - example: Postmortem IR-123 - type: string - required: - - documentUrl - - title - type: object - IncidentAttachmentsResponse: - description: The response object containing an incident's attachments. - properties: - data: - description: An array of incident attachments. - example: - - attributes: - attachment: - documentUrl: '' - title: Postmortem IR-123 - attachment_type: postmortem - id: 00000000-abcd-0002-0000-000000000000 - relationships: - last_modified_by_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - type: incident_attachments - items: - $ref: '#/components/schemas/IncidentAttachmentData' - type: array - included: - description: Included related resources that the user requested. - items: - $ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem' - type: array - required: - - data - type: object - IncidentAttachmentsResponseIncludedItem: - description: An object related to an attachment that is included in the response. - oneOf: - - $ref: '#/components/schemas/User' IncidentCreateAttributes: description: The incident's attributes for a create request. properties: @@ -27094,7 +26972,7 @@ components: description: An object related to an incident that is included in the response. oneOf: - $ref: '#/components/schemas/IncidentUserData' - - $ref: '#/components/schemas/IncidentAttachmentData' + - $ref: '#/components/schemas/AttachmentData' IncidentResponseMeta: description: The metadata object containing pagination metadata. properties: @@ -40114,6 +39992,41 @@ components: $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' type: array type: object + PatchAttachmentRequest: + example: + data: + attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/124/Postmortem-IR-124 + title: Postmortem-IR-124 + type: incident_attachments + properties: + data: + $ref: '#/components/schemas/PatchAttachmentRequestData' + type: object + PatchAttachmentRequestData: + properties: + attributes: + $ref: '#/components/schemas/PatchAttachmentRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/IncidentAttachmentType' + required: + - type + type: object + PatchAttachmentRequestDataAttributes: + properties: + attachment: + $ref: '#/components/schemas/PatchAttachmentRequestDataAttributesAttachment' + type: object + PatchAttachmentRequestDataAttributesAttachment: + properties: + documentUrl: + type: string + title: + type: string + type: object PatchIncidentNotificationTemplateRequest: description: Update request for a notification template. properties: @@ -56758,6 +56671,17 @@ components: type: $ref: '#/components/schemas/UsersType' type: object + User140420082644000: + properties: + attributes: + $ref: '#/components/schemas/UserAttributes' + id: + type: string + type: + $ref: '#/components/schemas/UserType' + required: + - type + type: object UserAttributes: description: Attributes of user object returned by the API. properties: @@ -57208,6 +57132,15 @@ components: meta: $ref: '#/components/schemas/TeamsResponseMeta' type: object + UserType: + default: users + description: Users resource type. + enum: + - users + example: users + type: string + x-enum-varnames: + - USERS UserUpdateAttributes: description: Attributes of the edited user. properties: @@ -68233,6 +68166,7 @@ paths: - us3.datadoghq.com - us5.datadoghq.com - ap1.datadoghq.com + - ap2.datadoghq.com - datadoghq.eu - ddog-gov.com subdomain: @@ -68458,8 +68392,7 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: - - incident_notification_settings_read + - AuthZ: [] summary: List incident notification rules tags: - Incidents @@ -68663,8 +68596,7 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: - - incident_settings_read + - AuthZ: [] summary: List incident notification templates tags: - Incidents @@ -68782,7 +68714,8 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_settings_read + - incident_read + - incident_write summary: Get incident notification template tags: - Incidents @@ -68875,6 +68808,7 @@ paths: x-permission: operator: OR permissions: + - incident_settings_read - incident_read x-unstable: '**Note**: This endpoint is in public beta. @@ -68917,7 +68851,7 @@ paths: x-codegen-request-body-name: body x-menu-order: 19 x-permission: - operator: OR + operator: AND permissions: - incident_settings_write x-unstable: '**Note**: This endpoint is in public beta. @@ -69214,82 +69148,170 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents/{incident_id}/attachments: get: - description: Get all attachments for a given incident. + description: List incident attachments. operationId: ListIncidentAttachments parameters: - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter' - - $ref: '#/components/parameters/IncidentAttachmentFilterQueryParameter' + - description: Filter attachments by type. Supported values are `1` (`postmortem`) + and `2` (`link`). + in: query + name: filter[attachment_type] + schema: + example: '1' + type: string + - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IncidentAttachmentsResponse' + $ref: '#/components/schemas/AttachmentArray' description: OK '400': $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List incident attachments + tags: + - Incidents + x-menu-order: 34 + x-permission: + operator: OR + permissions: + - incident_read + x-unstable: '**Note**: This endpoint is in Preview. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + post: + description: Create an incident attachment. + operationId: CreateIncidentAttachment + parameters: + - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAttachmentRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Attachment' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create incident attachment + tags: + - Incidents + x-menu-order: 35 + x-permission: + operator: AND + permissions: + - incident_write + x-unstable: '**Note**: This endpoint is in Preview. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/incidents/{incident_id}/attachments/{attachment_id}: + delete: + operationId: DeleteIncidentAttachment + parameters: + - $ref: '#/components/parameters/IncidentIDPathParameter' + - description: The ID of the attachment. + in: path + name: attachment_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000002 + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get a list of attachments + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Delete incident attachment tags: - Incidents - x-menu-order: 7 + x-menu-order: 36 x-permission: - operator: OR + operator: AND permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. + - incident_write + x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' patch: - deprecated: true - description: The bulk update endpoint for creating, updating, and deleting attachments - for a given incident. - operationId: UpdateIncidentAttachments + operationId: UpdateIncidentAttachment parameters: - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter' + - description: The ID of the attachment. + in: path + name: attachment_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000002 + - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentAttachmentUpdateRequest' - description: Incident Attachment Payload. + $ref: '#/components/schemas/PatchAttachmentRequest' required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IncidentAttachmentUpdateResponse' + $ref: '#/components/schemas/Attachment' description: OK '400': $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Create, update, and delete incident attachments + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Update incident attachment tags: - Incidents - x-codegen-request-body-name: body - x-menu-order: 8 + x-menu-order: 37 x-permission: - operator: OR + operator: AND permissions: - incident_write - x-unstable: '**Note**: This endpoint is deprecated.' + x-unstable: '**Note**: This endpoint is in Preview. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents/{incident_id}/impacts: get: description: Get all impacts for an incident. @@ -69322,7 +69344,7 @@ paths: summary: List an incident's impacts tags: - Incidents - x-menu-order: 6 + x-menu-order: 7 x-permission: operator: OR permissions: @@ -69369,7 +69391,7 @@ paths: tags: - Incidents x-codegen-request-body-name: body - x-menu-order: 7 + x-menu-order: 8 x-permission: operator: OR permissions: diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 08925ed0c9e..6b19a267940 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1185,14 +1185,22 @@ "request_schema_description": "Update request for an incident." }, "ListIncidentAttachments": { - "description": "Get all attachments for a given incident.", - "summary": "Get a list of attachments" - }, - "UpdateIncidentAttachments": { - "description": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident.", - "summary": "Create, update, and delete incident attachments", - "request_description": "Incident Attachment Payload.", - "request_schema_description": "The update request for an incident's attachments." + "description": "List incident attachments.", + "summary": "List incident attachments" + }, + "CreateIncidentAttachment": { + "description": "Create an incident attachment.", + "summary": "Create incident attachment", + "request_description": "", + "request_schema_description": "" + }, + "DeleteIncidentAttachment": { + "summary": "Delete incident attachment" + }, + "UpdateIncidentAttachment": { + "summary": "Update incident attachment", + "request_description": "", + "request_schema_description": "" }, "ListIncidentImpacts": { "description": "Get all impacts for an incident.",