v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Static Analysis

Get an AI custom rule

Get an AI custom rule by name within a ruleset.

get/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}

Path parameters

ruleset_namestring required

Example:my-ai-ruleset

The ruleset name.

rule_namestring required

Example:my-ai-rule

The rule name.

Response

Successful response

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"
  }
}