v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Static Analysis

List AI custom rulesets

Get all AI custom rulesets for the authenticated organization.

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

Query parameters

page[offset]integer

The offset for pagination.

page[limit]integer

The maximum number of rulesets to return.

Response

Successful response

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