Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Security Monitoring

Get a SAST ruleset

Get a SAST ruleset by name, including all its rules.

get/api/v2/static-analysis/rulesets/{ruleset_name}

Path parameters

ruleset_namestring required
Example:python-best-practices

The name of the ruleset to retrieve.

Query parameters

include_testsboolean

When true, test cases for each rule are included in the response.

include_testing_rulesboolean

When true, rules that are in testing mode are included in the response.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "description": "A collection of Python best practice rules.",
      "name": "python-best-practices",
      "rules": [
        {
          "data": {
            "type": "rules"
          }
        }
      ],
      "short_description": "Python best practices ruleset."
    },
    "id": "python-best-practices",
    "type": "rulesets"
  }
}