A list of ticket creation rules with pagination metadata.
Expand All
Field
Type
Description
data [required]
[object]
A list of ticket creation rule data objects.
attributes [required]
object
Attributes of a ticket creation rule returned by the API.
action [required]
object
The action to take when the ticket creation rule matches a finding.
assignee_id
uuid
The UUID of the default assignee for created tickets.
auto_disabled_reason
string
The reason the rule was automatically disabled by the system due to a ticketing integration error.
fields
object
Custom fields of the Jira issue to create. For the list of available fields, see Jira documentation.
max_tickets_per_day [required]
int64
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.
project_id [required]
uuid
The UUID of the case management project.
target [required]
enum
The ticketing system to create tickets in.
Allowed enum values: jira,case_management
created_at [required]
int64
The Unix timestamp in milliseconds when the rule was created.
created_by [required]
object
The user or Datadog system who created the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
enabled [required]
boolean
Whether the ticket creation rule is enabled.
modified_at [required]
int64
The Unix timestamp in milliseconds when the rule was last modified.
modified_by [required]
object
The user or Datadog system who last modified the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
name [required]
string
The name of the ticket creation rule.
rule [required]
object
Defines the scope of findings to which the automation rule applies.
finding_types [required]
[string]
The list of security finding types that the automation rule applies to.
query
string
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.
id [required]
uuid
The ID of the ticket creation rule.
type [required]
enum
The JSON:API type for ticket creation rules.
Allowed enum values: ticket_creation_rules
links [required]
object
Pagination links for the list of automation rules.
first [required]
string
Link to the first page of results.
last [required]
string
Link to the last page of results.
next
string
Link to the next page of results.
prev
string
Link to the previous page of results.
meta [required]
object
Metadata for the list of automation rules.
page [required]
object
Pagination information for the list of automation rules.
total_filtered_count [required]
int64
The total number of rules matching the current filter.
"""
Get all ticket creation rules returns "Successfully retrieved the list of ticket creation rules" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApiconfiguration=Configuration()configuration.unstable_operations["list_security_findings_automation_ticket_creation_rules"]=TruewithApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.list_security_findings_automation_ticket_creation_rules()print(response)
# Get all ticket creation rules returns "Successfully retrieved the list of ticket creation rules" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.list_security_findings_automation_ticket_creation_rules".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newpapi_instance.list_security_findings_automation_ticket_creation_rules()
// Get all ticket creation rules returns "Successfully retrieved the list of ticket creation rules" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.ListSecurityFindingsAutomationTicketCreationRules",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.ListSecurityFindingsAutomationTicketCreationRules(ctx,*datadogV2.NewListSecurityFindingsAutomationTicketCreationRulesOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.ListSecurityFindingsAutomationTicketCreationRules`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.ListSecurityFindingsAutomationTicketCreationRules`:\n%s\n",responseContent)}
// Get all ticket creation rules returns "Successfully retrieved the list of ticket creation rules"// responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.TicketCreationRulesResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.listSecurityFindingsAutomationTicketCreationRules",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);try{TicketCreationRulesResponseresult=apiInstance.listSecurityFindingsAutomationTicketCreationRules();System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling"+" SecurityMonitoringApi#listSecurityFindingsAutomationTicketCreationRules");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get all ticket creation rules returns "Successfully retrieved the list of
// ticket creation rules" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::ListSecurityFindingsAutomationTicketCreationRulesOptionalParams;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.ListSecurityFindingsAutomationTicketCreationRules",true,);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.list_security_findings_automation_ticket_creation_rules(ListSecurityFindingsAutomationTicketCreationRulesOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get all ticket creation rules returns "Successfully retrieved the list of ticket creation rules" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listSecurityFindingsAutomationTicketCreationRules"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);apiInstance.listSecurityFindingsAutomationTicketCreationRules().then((data: v2.TicketCreationRulesResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));