API sənədləri

Bildiriş ünvanını təyin et

Qrupun bildiriş ünvanını yaradır və ya yeniləyir. İlk yaratmada cavab `201` və `signingSecret` daşıyır — sirr yalnız bu cavabda göstərilir, saxlayın. Yeniləmə `200` qaytarır və sirri dəyişmir; verilməyən sahələr olduğu kimi qalır.

PUT/v1/webhooks/{groupId}
PUTBildiriş ünvanını təyin et
curl -X PUT "https://api.darkradar.com/api/public/v1/webhooks/64b1f0c2a9e4d21f8c3b9a10" \
  -H "x-api-key: $DARKRADAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://darkradar.com/darkradar-webhook","events":["leak.created","scan.failed"],"severities":["critical","high"]}'
Cavab

Uğurlu

{
  "success": true,
  "message": "OK",
  "data": {
    "webhook": {
      "groupId": "64b1f0c2a9e4d21f8c3b9a10",
      "url": "•••• https://darkradar.com/…hook",
      "events": [
        "leak.created",
        "scan.finished",
        "scan.failed"
      ],
      "severities": [
        "critical",
        "high"
      ],
      "isActive": true,
      "lastDelivery": {
        "at": "2026-09-19T15:33:20.772Z",
        "ok": true,
        "type": "scan.finished",
        "reason": null
      },
      "createdAt": "2026-09-19T15:33:20.631Z",
      "updatedAt": "2026-09-19T15:33:20.673Z"
    }
  }
}

Giriş icazəsi

Əhatəwebhooks:write
Plan hüququapi_access

Yol parametrləri

SahələrDəyərlər
groupId · string · məcburiQoruma resursu qrupunun kimliyi (24 simvol); GET /v1/protection-resources/groups · Nümunə: 64b1f0c2a9e4d21f8c3b9a10

Sorğu gövdəsi

SahələrDəyərlər
url · string · istəyə bağlıÇatdırılma ünvanı: https və hamıya açıq ünvan (daxili şəbəkə, localhost, bulud meta məlumat ünvanı rədd edilir). Yaradarkən məcburidir.
events · string[] · istəyə bağlıAbunə olunan hadisələr. Yaradarkən verilməsə leak.created; yeniləmədə verilməsə dəyişmir. · Dəyərlər: leak.created, scan.finished, scan.failed, hunter.finding.created
severities · string[] · istəyə bağlıSızma hadisələrində ciddiyyət süzgəci. Yaradarkən verilməsə hamısı; yeniləmədə verilməsə dəyişmir. · Dəyərlər: critical, high, medium, low, info, unknown
isActive · boolean · istəyə bağlıÇatdırılma aktivdirmi (bağlı olanda hadisə göndərilmir).

Cavablar

200Uğurlu
201Yaradıldı
400Ünvan qəbul edilmədi (https deyil, daxili şəbəkə / localhost / bulud meta məlumat ünvanı) və ya naməlum hadisə/ciddiyyət
401Açar yoxdur, etibarsızdır, müddəti bitib və ya ləğv edilib
403Əhatə kifayət etmir, planda API girişi yoxdur və ya məhsul açıq deyil
404Qeyd yoxdur və ya bu açarın şirkətinə aid deyil
408Sorğu maksimum cavab müddətini aşdı
429Sürət həddi aşıldı; bir dəqiqə sonra yenidən yoxlayın

Cavab limitləri

Sürət limiti15 dəqiqədə 500 sorğu · IP başına

Bu səhifə işinizə yaradı?