v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBStatic Analysis
Create an AI custom rule
Create a new AI custom rule within a ruleset.
post/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules
Path parameters
ruleset_namestring required
Example:my-ai-ruleset
The ruleset name.
Request body
Example request
{
"data": {
"attributes": {
"name": "my-ai-rule"
},
"id": "my-ai-rule",
"type": "ai_rule"
}
}Response
Successfully created
Example response
{
"data": {
"attributes": {
"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"
],
"severity": "ERROR",
"short_description": "Ruleset short description",
"version_id": 1
},
"name": "my-ai-rule"
},
"id": "my-ai-rule",
"type": "ai_rule"
}
}