v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Static Analysis

Get an AI custom rule revision

Get a specific revision of an AI custom rule.

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

Path parameters

ruleset_namestring required

Example:my-ai-ruleset

The ruleset name.

rule_namestring required

Example:my-ai-rule

The rule name.

idstring required

Example:revision-abc-123

The revision identifier.

Response

Successful response

Example response

{
  "data": {
    "attributes": {
      "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
    },
    "id": "revision-abc-123",
    "type": "ai_rule_revision"
  }
}