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/rulesets/{ruleset_name} https://api.ap2.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.datadoghq.eu/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.us2.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.us3.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} https://api.us5.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}
Overview Get an AI custom ruleset by name.
Arguments Path Parameters Response Successful response
Response containing a single AI custom ruleset.
Expand All
Response data for an AI custom ruleset.
Response attributes of an AI custom ruleset.
The identifier of the user who created the ruleset.
Base64-encoded full description of the ruleset.
The rules contained in the ruleset.
The identifier of the user who created the rule.
The most recent revision of the rule.
Rule category
Allowed enum values: SECURITY,BEST_PRACTICES,CODE_STYLE,ERROR_PRONE,PERFORMANCE
Checksum of the revision content.
Base64-encoded AI model content for this revision.
The identifier of the user who created the revision.
The associated CWE identifier.
Base64-encoded full description.
Directory patterns this rule applies to.
execution_mode [required ]
The execution mode for an AI rule revision.
Allowed enum values: auto,manual,always
File glob patterns this rule applies to.
Whether this is a default Datadog rule.
Whether this revision is published.
Whether this revision is for testing only.
Rule severity
Allowed enum values: ERROR,WARNING,NOTICE
short_description [required ]
Base64-encoded short description.
The version identifier for this revision.
short_description [required ]
Base64-encoded short description of the ruleset.
AI custom ruleset resource type.
Allowed enum values: ai_ruleset
{
"data" : {
"attributes" : {
"created_at" : "2024-01-01T00:00:00+00:00" ,
"created_by" : "example-handle" ,
"description" : "Ruleset description" ,
"name" : "my-ai-ruleset" ,
"rules" : [
{
"created_at" : "2024-01-01T00:00:00+00:00" ,
"created_by" : "example-handle" ,
"last_revision" : {
"category" : "SECURITY" ,
"checksum" : "abc123def456" ,
"content" : "Content" ,
"created_at" : "2024-01-01T00:00:00+00:00" ,
"created_by" : "example-handle" ,
"cwe" : "79" ,
"description" : "Ruleset description" ,
"directories" : [
[]
],
"execution_mode" : "auto" ,
"globs" : [
"**/*.py"
],
"is_default" : false ,
"is_published" : false ,
"is_testing" : false ,
"severity" : "ERROR" ,
"short_description" : "Ruleset short description" ,
"version_id" : 1
},
"name" : "my-ai-rule"
}
],
"short_description" : "Ruleset short description"
},
"id" : "my-ai-ruleset" ,
"type" : "ai_ruleset"
}
} 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"
}
]
} Ruleset 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
# Path parameters export ruleset_name = "my-ai-ruleset" # 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/rulesets/${ruleset_name} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " 
