v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Static Analysis

Create an AI custom ruleset

Create a new AI custom ruleset for the authenticated organization.

post/api/v2/static-analysis/ai/rulesets

Request body

Example request

{
  "data": {
    "attributes": {
      "description": "Ruleset description",
      "name": "my-ai-ruleset",
      "short_description": "Ruleset short description"
    },
    "id": "my-ai-ruleset",
    "type": "ai_ruleset"
  }
}

Response

Successfully created

Example response

{
  "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"
            ],
            "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"
  }
}