Skip to main content
PUT
/
api
/
v1
/
detector
/
batch
/
{schema_id}
Update all detectors of a particular schema id. Main usage is enabling/disabling all detectors of a particular schema id. Only for admin, use with caution!
curl --request PUT \
  --url https://api.example.com/api/v1/detector/batch/{schema_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACTIVE",
  "name": "<string>",
  "source": "ATTACK_DETECTOR",
  "tags": [
    "<string>"
  ],
  "config": {},
  "destinations": [
    {
      "status": "ACTIVE",
      "id": 1,
      "tenantDestinationId": 123
    }
  ],
  "actions": [
    {
      "status": "ACTIVE",
      "scriptFilter": "<string>",
      "scriptParams": {},
      "id": 1,
      "severity": "INFO",
      "actionId": 123
    }
  ]
}
'
{
  "data": [
    {
      "id": 1,
      "createdAt": 123,
      "updatedAt": 123,
      "status": "ACTIVE",
      "schema": {
        "id": 1,
        "createdAt": 123,
        "updatedAt": 123,
        "status": "ACTIVE",
        "title": "<string>",
        "name": "<string>",
        "version": "0.0.1",
        "description": "Detector schema description example",
        "author": "<string>",
        "icon": "<string>",
        "tags": [
          "<string>"
        ],
        "networkTags": [
          "<string>"
        ]
      },
      "contractId": 123,
      "name": "<string>",
      "source": "ATTACK_DETECTOR",
      "tags": [
        "<string>"
      ],
      "config": {},
      "destinations": [
        {
          "id": 1,
          "createdAt": 123,
          "updatedAt": 123,
          "status": "ACTIVE",
          "tenantDestination": {
            "id": 1,
            "createdAt": 123,
            "updatedAt": 123,
            "tenantId": 123,
            "type": "EMAIL",
            "uid": "Telegram: /start {uid}",
            "tags": [
              "DEFAULT"
            ],
            "value": "<string>",
            "telegramBotUsername": "<string>",
            "telegramUserId": "<string>",
            "telegramUsername": "<string>",
            "telegramChatId": "<string>",
            "telegramChatTitle": "<string>",
            "telegramChatType": "<string>",
            "slackUri": "<string>",
            "slackChannelId": "<string>",
            "slackChannelName": "<string>",
            "uri": "<string>",
            "method": "<string>",
            "headers": {}
          }
        }
      ],
      "actions": [
        {
          "id": 1,
          "createdAt": 123,
          "updatedAt": 123,
          "status": "ACTIVE",
          "scriptFilter": "e.severity>=0.5",
          "scriptParams": {
            "_to": "e.getTxHash()",
            "_value": "a.getTimestamp()"
          },
          "actionId": 123
        }
      ]
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.extractor.live/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authentication

Path Parameters

schema_id
integer<int64>
required

Body

application/json
status
enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:
ACTIVE,
DISABLED,
DELETED
name
string

Name of the detector

source
enum<string>

Source of the detector events (Kafka topic)

Available options:
ATTACK_DETECTOR,
FORTA,
SENTINEL
tags
string[]

Tags of the detector

config
object

Configuration of the detector. Should match with Json schema from detector type

destinations
object[]

List of destinations associated with the entry

actions
object[]

List of actions associated with the entry

Response

200 - application/json

OK

data
object[]

Response data

total
integer<int64>

Total amount of document available for this request