API belgeleri

Tarama

Koruma kaynaklarınızın sızıntı verisine karşı taranması.

Alanlar

Tarama sonuç sayıları.

stats.severitiesobject
Önem düzeyine göre bulgu sayıları.
stats.typesobject
Türe göre bulgu sayıları.
stats.resourceTypeBreakdownobject
Kaynak türüne göre bulgu sayıları.
stats.totalItemsCheckednumber
Denetlenen kayıt sayısı.
stats.totalResourcesScannednumber
Taranan koruma kaynağı sayısı.
stats.totalMatchesnumber
Toplam eşleşme.
stats.newMatchesnumber
Bu taramada ilk kez görülen eşleşme.
stats.credentialsFoundnumber
Bulunan kimlik bilgisi.
stats.machinesFoundnumber
Bulunan makine.

Tarama başarısız olduysa hata özeti (yalnız mesaj ve kod).

error.messagestring | null
Hata mesajı.
error.codestring | null
Hata kodu.
_idstring
Kaydın kimliği (24 karakterlik onaltılı).
firmstring
Kaydın ait olduğu firmanın kimliği — her zaman API anahtarınızın firması.
protectionResourceGroupIdstring | null
Kaydın bağlı olduğu koruma kaynağı grubunun kimliği.
scanTypestring
Tarama türü: `manual`, `scheduled`, `automatic` ya da `auto`.
statusstring
Tarama durumu: `pending`, `running`, `completed`, `failed`, `cancelled`.
startedAtstring
Başlama zamanı.
completedAtstring | null
Bitiş zamanı.
durationMsnumber | null
Süre (milisaniye).
resourceResultsarray
Kaynak başına tarama sonuçları.
createdAtstring
Oluşturulma zamanı (ISO 8601).
updatedAtstring
Son güncelleme zamanı (ISO 8601).

JSON şeması

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/scan.schema.json",
  "title": "Tarama",
  "description": "Koruma kaynaklarınızın sızıntı verisine karşı taranması.",
  "type": "object",
  "properties": {
    "stats": {
      "type": "object",
      "description": "Tarama sonuç sayıları.",
      "properties": {
        "severities": {
          "type": "object",
          "description": "Önem düzeyine göre bulgu sayıları."
        },
        "types": {
          "type": "object",
          "description": "Türe göre bulgu sayıları."
        },
        "resourceTypeBreakdown": {
          "type": "object",
          "description": "Kaynak türüne göre bulgu sayıları."
        },
        "totalItemsChecked": {
          "type": "number",
          "description": "Denetlenen kayıt sayısı."
        },
        "totalResourcesScanned": {
          "type": "number",
          "description": "Taranan koruma kaynağı sayısı."
        },
        "totalMatches": {
          "type": "number",
          "description": "Toplam eşleşme."
        },
        "newMatches": {
          "type": "number",
          "description": "Bu taramada ilk kez görülen eşleşme."
        },
        "credentialsFound": {
          "type": "number",
          "description": "Bulunan kimlik bilgisi."
        },
        "machinesFound": {
          "type": "number",
          "description": "Bulunan makine."
        }
      }
    },
    "error": {
      "type": "object",
      "description": "Tarama başarısız olduysa hata özeti (yalnız mesaj ve kod).",
      "properties": {
        "message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Hata mesajı."
        },
        "code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Hata kodu."
        }
      }
    },
    "_id": {
      "type": "string",
      "description": "Kaydın kimliği (24 karakterlik onaltılı)."
    },
    "firm": {
      "type": "string",
      "description": "Kaydın ait olduğu firmanın kimliği — her zaman API anahtarınızın firması."
    },
    "protectionResourceGroupId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Kaydın bağlı olduğu koruma kaynağı grubunun kimliği."
    },
    "scanType": {
      "type": "string",
      "description": "Tarama türü: `manual`, `scheduled`, `automatic` ya da `auto`."
    },
    "status": {
      "type": "string",
      "description": "Tarama durumu: `pending`, `running`, `completed`, `failed`, `cancelled`."
    },
    "startedAt": {
      "type": "string",
      "description": "Başlama zamanı."
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Bitiş zamanı."
    },
    "durationMs": {
      "type": [
        "number",
        "null"
      ],
      "description": "Süre (milisaniye)."
    },
    "resourceResults": {
      "type": "array",
      "description": "Kaynak başına tarama sonuçları.",
      "items": {}
    },
    "createdAt": {
      "type": "string",
      "description": "Oluşturulma zamanı (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Son güncelleme zamanı (ISO 8601)."
    }
  }
}

Bu sayfa işinize yaradı mı?