DAdatadog
Security Monitoring

Get a SAST ruleset

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

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

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: code_analysis_read

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

Changes

No recorded changes to this operation across all 1 revision of this API.