diff --git a/hugo/content/en/api/v2/security-monitoring/examples.json b/hugo/content/en/api/v2/security-monitoring/examples.json index 2d9aa8a17f1..4d0f0c67d6d 100644 --- a/hugo/content/en/api/v2/security-monitoring/examples.json +++ b/hugo/content/en/api/v2/security-monitoring/examples.json @@ -2565,7 +2565,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of ticket creation rule data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

links [required]

\n
\n

object

\n

Pagination links for the list of automation rules.

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

first [required]

\n
\n

string

\n

Link to the first page of results.

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

last [required]

\n
\n

string

\n

Link to the last page of results.

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

next

\n
\n

string

\n

Link to the next page of results.

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

prev

\n
\n

string

\n

Link to the previous page of results.

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

meta [required]

\n
\n

object

\n

Metadata for the list of automation rules.

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

page [required]

\n
\n

object

\n

Pagination information for the list of automation rules.

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

total_filtered_count [required]

\n
\n

int64

\n

The total number of rules matching the current filter.

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

data [required]

\n
\n

[object]

\n

A list of ticket creation rule data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

links [required]

\n
\n

object

\n

Pagination links for the list of automation rules.

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

first [required]

\n
\n

string

\n

Link to the first page of results.

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

last [required]

\n
\n

string

\n

Link to the last page of results.

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

next

\n
\n

string

\n

Link to the next page of results.

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

prev

\n
\n

string

\n

Link to the previous page of results.

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

meta [required]

\n
\n

object

\n

Metadata for the list of automation rules.

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

page [required]

\n
\n

object

\n

Pagination information for the list of automation rules.

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

total_filtered_count [required]

\n
\n

int64

\n

The total number of rules matching the current filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -2633,7 +2633,7 @@ "type": "ticket_creation_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2733,7 +2733,7 @@ "type": "ticket_creation_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

enabled

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

enabled

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" } }, "ReorderSecurityFindingsAutomationTicketCreationRules": { @@ -2898,7 +2898,7 @@ "type": "ticket_creation_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -2974,7 +2974,7 @@ "type": "ticket_creation_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

data [required]

\n
\n

object

\n

The data object for a ticket creation rule returned by the API.

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

attributes [required]

\n
\n

object

\n

Attributes of a ticket creation rule returned by the API.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

auto_disabled_reason

\n
\n

string

\n

The reason the rule was automatically disabled by the system due to a ticketing integration error.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

created_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was created.

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

created_by [required]

\n
\n

object

\n

The user or Datadog system who created the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

enabled [required]

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

modified_at [required]

\n
\n

int64

\n

The Unix timestamp in milliseconds when the rule was last modified.

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

modified_by [required]

\n
\n

object

\n

The user or Datadog system who last modified the rule.

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

id [required]

\n
\n

string

\n

The actor's identifier (a user UUID or a system identifier).

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

name [required]

\n
\n

string

\n

The name of the actor.

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

type [required]

\n
\n

enum

\n

Whether the actor is a user or the Datadog system. \nAllowed enum values: user,system

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

id [required]

\n
\n

uuid

\n

The ID of the ticket creation rule.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -3082,7 +3082,7 @@ "type": "ticket_creation_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

fields

\n
\n

object

\n

Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management

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

enabled

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

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

data [required]

\n
\n

object

\n

The data object for a ticket creation rule create or update request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a ticket creation rule.

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

action [required]

\n
\n

object

\n

The action to take when the ticket creation rule matches a finding.

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

assignee_id

\n
\n

uuid

\n

The UUID of the default assignee for created tickets.

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

fields

\n
\n

object

\n

Target-specific fields of the ticket to create.

For target: jira, the custom fields of the Jira issue. For the list of available fields, see Jira documentation.

For target: linear, the optional keys linear_project_id (string, the identifier of the Linear project the issue is created in) and linear_label_ids (array of strings, the identifiers of the Linear labels applied to the issue).

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

max_tickets_per_day [required]

\n
\n

int64

\n

The maximum number of tickets the rule may create per day. If exceeded, one final ticket will be created, explaining the limit was hit and link back to the responsible rule.

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

project_id [required]

\n
\n

uuid

\n

The UUID of the case management project.

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

target [required]

\n
\n

enum

\n

The ticketing system to create tickets in. \nAllowed enum values: jira,case_management,linear

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

enabled

\n
\n

boolean

\n

Whether the ticket creation rule is enabled.

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

name [required]

\n
\n

string

\n

The name of the ticket creation rule.

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

rule [required]

\n
\n

object

\n

Defines the scope of findings to which the automation rule applies.

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

finding_types [required]

\n
\n

[string]

\n

The list of security finding types that the automation rule applies to.

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

query

\n
\n

string

\n

A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.

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

type [required]

\n
\n

enum

\n

The JSON:API type for ticket creation rules. \nAllowed enum values: ticket_creation_rules

\n
\n \n
\n
\n
\n
" } }, "DetachCase": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 483b79b8852..fc11ddbbe6c 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -122357,7 +122357,12 @@ components: format: uuid type: string fields: - description: Custom fields of the Jira issue to create. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + description: |- + Target-specific fields of the ticket to create. + + For `target: jira`, the custom fields of the Jira issue. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + + For `target: linear`, the optional keys `linear_project_id` (string, the identifier of the Linear project the issue is created in) and `linear_label_ids` (array of strings, the identifiers of the Linear labels applied to the issue). example: labels: - security @@ -122394,7 +122399,12 @@ components: example: "Daily ticket creation limit exceeded" type: string fields: - description: Custom fields of the Jira issue to create. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + description: |- + Target-specific fields of the ticket to create. + + For `target: jira`, the custom fields of the Jira issue. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + + For `target: linear`, the optional keys `linear_project_id` (string, the identifier of the Linear project the issue is created in) and `linear_label_ids` (array of strings, the identifiers of the Linear labels applied to the issue). example: labels: - security @@ -122592,11 +122602,13 @@ components: enum: - jira - case_management + - linear example: jira type: string x-enum-varnames: - JIRA - CASE_MANAGEMENT + - LINEAR TimeAggregation: description: |- Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation.