Skip to content
Get started

List all detectors

detectors.list() -> DetectorListResponse
GET/api/detectors

List all detectors

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

List all detectors

import os
from rake import Rake

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