AIaikido

Get a custom rule

Get a custom semgrep rule

get/repositories/sast/custom-rules/{rule_id}

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/repositories/sast/custom-rules/{rule_id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: custom_sast_rules:read

Path parameters

rule_idinteger required

The ID of the custom rule

Response

Detailed information of a custom semgrep rule

Example response

{
  "custom_rule": {
    "id": 1,
    "semgrep_rule": "rules:\n- id: CUSTOM-RULE-1\n  pattern: console.log(...)\n  message: Semgrep found a debug statement\n  languages: [javascript]\n  severity: WARNING",
    "issue_title": "console.log",
    "priority": 20,
    "tldr": "console.log should be avoided in frontend applications",
    "how_to_fix": "remove the console.log",
    "language": "JS",
    "has_error": false
  }
}

Changes

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