API Reference

Detectors

Rules

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a new rule

POST/api/detectors/{detectorId}/rules

Create a new rule

Path ParametersExpand Collapse

detectorId: string

Body ParametersJSONExpand Collapse

condition: string

name: string

notify: optional boolean

ReturnsExpand Collapse

errors: array of object { code, message }

code: number

minimum1000

message: string

messages: array of object { code, message }

code: number

minimum1000

message: string

result: object { id }

id: string

success: boolean

Create a new rule

HTTP

HTTP

Python

curl https://rake.dev/api/detectors/$DETECTOR_ID/rules \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $RAKE_API_KEY" \
    -d '{
          "condition": "condition",
          "name": "name"
        }'

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}