Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
GET https://api.ap1.datadoghq.com/api/v2/static-analysis/ai/prompts https://api.ap2.datadoghq.com/api/v2/static-analysis/ai/prompts https://api.datadoghq.eu/api/v2/static-analysis/ai/prompts https://api.ddog-gov.com/api/v2/static-analysis/ai/prompts https://api.us2.ddog-gov.com/api/v2/static-analysis/ai/prompts https://api.datadoghq.com/api/v2/static-analysis/ai/prompts https://api.us3.datadoghq.com/api/v2/static-analysis/ai/prompts https://api.us5.datadoghq.com/api/v2/static-analysis/ai/prompts
Overview Get all AI prompts, including default prompts and custom AI rule prompts for the authenticated organization.
Response Successful response
Response containing a list of AI prompts.
Expand All
Response attributes of an AI prompt.
Rule category
Allowed enum values: SECURITY,BEST_PRACTICES,CODE_STYLE,ERROR_PRONE,PERFORMANCE
Checksum of the prompt content.
Base64-encoded AI prompt content.
The CWE identifier associated with this prompt.
Base64-encoded full description.
Directory patterns this prompt applies to.
execution_mode [required ]
The execution mode for an AI rule revision.
Allowed enum values: auto,manual,always
file_search_keywords [required ]
Keywords used to search for relevant files.
File glob patterns this prompt applies to.
Whether this is a default Datadog prompt.
Whether this prompt is for testing only.
Programming language
Allowed enum values: PYTHON,JAVASCRIPT,TYPESCRIPT,JAVA,GO,YAML,RUBY,CSHARP,PHP,KOTLINShow 1 more ,SWIFT
result_keywords_exclude [required ]
Keywords to exclude from results.
The version of the rule this prompt is associated with.
Rule severity
Allowed enum values: ERROR,WARNING,NOTICE
short_description [required ]
Base64-encoded short description.
AI prompt resource type.
Allowed enum values: ai_prompt
{
"data" : [
{
"attributes" : {
"category" : "SECURITY" ,
"checksum" : "abc123" ,
"content" : "Content" ,
"cwe" : "79" ,
"description" : "Ruleset description" ,
"directories" : [
[]
],
"execution_mode" : "auto" ,
"file_search_keywords" : [
"import"
],
"globs" : [
"**/*.py"
],
"is_default" : false ,
"is_testing" : false ,
"language" : "PYTHON" ,
"result_keywords_exclude" : [
[]
],
"rule_version" : "1" ,
"severity" : "ERROR" ,
"short_description" : "Ruleset short description"
},
"id" : "my-ai-ruleset/my-ai-rule" ,
"type" : "ai_prompt"
}
]
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Not Found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Internal Server Error
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Code Example Copy
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/static-analysis/ai/prompts " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " 
