API sənədləri

Bildiriş ünvanı

Bir resurs qrupunun hadisələrinin imzalı şəkildə göndərildiyi ünvan.

Sahələr

groupIdstring
Ünvanın bağlı olduğu qoruma resursu qrupu; qrup başına ən çox bir ünvan.
urlstring
Çatdırılma ünvanı, maskalı (kök + son 4 simvol). Açıq ünvan və imza sirri heç bir oxumada qaytarılmır.
eventsarray
Abunə olunan hadisələr: `leak.created`, `scan.finished`, `scan.failed`.
severitiesarray
Sızma hadisələrində ciddiyyət süzgəci; siyahıda olmayan ciddiyyətdəki sızma göndərilmir.
isActiveboolean
Çatdırılma aktivdirmi.

Son çatdırılmanın xülasəsi; hələ çatdırılma yoxdursa `null`.

lastDelivery.atstring
Son çatdırılma vaxtı.
lastDelivery.okboolean
Alıcı `2xx` qaytarıbmı.
lastDelivery.typestring
Son çatdırılan hadisənin növü.
lastDelivery.reasonstring | null
Uğursuzdursa səbəb (məs. `http_503`, `timeout`); uğurludursa `null`.
createdAtstring
Yaradılma vaxtı (ISO 8601).
updatedAtstring
Son yenilənmə vaxtı (ISO 8601).

JSON Sxemi

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/webhook-endpoint.schema.json",
  "title": "Bildiriş ünvanı",
  "description": "Bir resurs qrupunun hadisələrinin imzalı şəkildə göndərildiyi ünvan.",
  "type": "object",
  "properties": {
    "groupId": {
      "type": "string",
      "description": "Ünvanın bağlı olduğu qoruma resursu qrupu; qrup başına ən çox bir ünvan."
    },
    "url": {
      "type": "string",
      "description": "Çatdırılma ünvanı, maskalı (kök + son 4 simvol). Açıq ünvan və imza sirri heç bir oxumada qaytarılmır."
    },
    "events": {
      "type": "array",
      "description": "Abunə olunan hadisələr: `leak.created`, `scan.finished`, `scan.failed`.",
      "items": {}
    },
    "severities": {
      "type": "array",
      "description": "Sızma hadisələrində ciddiyyət süzgəci; siyahıda olmayan ciddiyyətdəki sızma göndərilmir.",
      "items": {}
    },
    "isActive": {
      "type": "boolean",
      "description": "Çatdırılma aktivdirmi."
    },
    "lastDelivery": {
      "type": "object",
      "description": "Son çatdırılmanın xülasəsi; hələ çatdırılma yoxdursa `null`.",
      "properties": {
        "at": {
          "type": "string",
          "description": "Son çatdırılma vaxtı."
        },
        "ok": {
          "type": "boolean",
          "description": "Alıcı `2xx` qaytarıbmı."
        },
        "type": {
          "type": "string",
          "description": "Son çatdırılan hadisənin növü."
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Uğursuzdursa səbəb (məs. `http_503`, `timeout`); uğurludursa `null`."
        }
      }
    },
    "createdAt": {
      "type": "string",
      "description": "Yaradılma vaxtı (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Son yenilənmə vaxtı (ISO 8601)."
    }
  }
}

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