Skip to content
Get started

Delete a detector and its rules

detectors.delete(strdetector_id) -> DetectorDeleteResponse
DELETE/api/detectors/{detectorId}

Delete a detector and its rules

ParametersExpand Collapse
detector_id: str
ReturnsExpand Collapse
class DetectorDeleteResponse:
errors: List[Error]
code: int
minimum1000
message: str
messages: List[Message]
code: int
minimum1000
message: str
result: Result
id: str
success: bool

Delete a detector and its rules

import os
from rake import Rake

client = Rake(
    api_key=os.environ.get("RAKE_API_KEY"),  # This is the default and can be omitted
)
detector = client.detectors.delete(
    "detectorId",
)
print(detector.errors)
{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}