API Reference

Detectors

Rules

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a new rule

detectors.rules.create(strdetector_id, RuleCreateParams**kwargs) -> RuleCreateResponse

POST/api/detectors/{detectorId}/rules

Create a new rule

ParametersExpand Collapse

detector_id: str

condition: str

name: str

notify: Optional[bool]

ReturnsExpand Collapse

class RuleCreateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

messages: List[Message]

code: int

minimum1000

message: str

result: Result

id: str

success: bool

Create a new rule

Python

HTTP

Python

import os
from rake import Rake

client = Rake(
    api_key=os.environ.get("RAKE_API_KEY"),  # This is the default and can be omitted
)
rule = client.detectors.rules.create(
    detector_id="detectorId",
    condition="condition",
    name="name",
)
print(rule.errors)

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
}