AIaikido

Create custom rule

Create a new custom semgrep rule

post/repositories/sast/custom-rules

Request

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

Request body

semgrep_rulestring required

The semgrep rule

issue_titlestring required

The title of the issue associated with this semgrep rule

tldrstring required

A summary of what the issue associated with this semgrep rule is

how_to_fixstring required

A description on how to fix the issue associated with this semgrep rule

priorityinteger required

A numeric value from 1 to 100 indicating how severe the issue associated with this semgrep rule is

language'JS' | 'TS' | 'PHP' | 'Java' | 'Scala' | 'GO' | 'PY' | 'Ruby' | '.NET' | 'RUST' | 'Dart' | 'Swift' | 'Elixir' | 'C' | 'Clojure' | 'kotlin' | 'terraform' | 'generic' required

The programming language associated with this semgrep rule

Example request

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

Response

The custom rule has successfully been created

idinteger

The ID of the newly created custom rule in Aikido.

Example response

{
  "id": 1
}

Changes

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