API sənədləri

Tarama

Qoruma resurslarınızın sızma məlumatına qarşı taranması.

Sahələr

Tarama nəticə sayları.

stats.severitiesobject
Ciddiyyət səviyyəsinə görə tapıntı sayları.
stats.typesobject
Növə görə tapıntı sayları.
stats.resourceTypeBreakdownobject
Resurs növünə görə tapıntı sayları.
stats.totalItemsCheckednumber
Yoxlanılan qeyd sayı.
stats.totalResourcesScannednumber
Taranan qoruma resursu sayı.
stats.totalMatchesnumber
Ümumi uyğunluq.
stats.newMatchesnumber
Bu taramada ilk dəfə görülən uyğunluq.
stats.credentialsFoundnumber
Tapılan kimlik məlumatı.
stats.machinesFoundnumber
Tapılan maşın.

Tarama uğursuz olubsa xəta xülasəsi (yalnız mesaj və kod).

error.messagestring | null
Xəta mesajı.
error.codestring | null
Xəta kodu.
_idstring
Qeydin kimliyi (24 simvollu onaltılıq).
firmstring
Qeydin aid olduğu şirkətin kimliyi — həmişə API açarınızın şirkəti.
protectionResourceGroupIdstring | null
Qeydin bağlı olduğu qoruma resursu qrupunun kimliyi.
scanTypestring
Tarama növü: `manual`, `scheduled`, `automatic` və ya `auto`.
statusstring
Tarama statusu: `pending`, `running`, `completed`, `failed`, `cancelled`.
startedAtstring
Başlama vaxtı.
completedAtstring | null
Bitmə vaxtı.
durationMsnumber | null
Müddət (millisaniyə).
resourceResultsarray
Resurs başına tarama nəticələri.
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/scan.schema.json",
  "title": "Tarama",
  "description": "Qoruma resurslarınızın sızma məlumatına qarşı taranması.",
  "type": "object",
  "properties": {
    "stats": {
      "type": "object",
      "description": "Tarama nəticə sayları.",
      "properties": {
        "severities": {
          "type": "object",
          "description": "Ciddiyyət səviyyəsinə görə tapıntı sayları."
        },
        "types": {
          "type": "object",
          "description": "Növə görə tapıntı sayları."
        },
        "resourceTypeBreakdown": {
          "type": "object",
          "description": "Resurs növünə görə tapıntı sayları."
        },
        "totalItemsChecked": {
          "type": "number",
          "description": "Yoxlanılan qeyd sayı."
        },
        "totalResourcesScanned": {
          "type": "number",
          "description": "Taranan qoruma resursu sayı."
        },
        "totalMatches": {
          "type": "number",
          "description": "Ümumi uyğunluq."
        },
        "newMatches": {
          "type": "number",
          "description": "Bu taramada ilk dəfə görülən uyğunluq."
        },
        "credentialsFound": {
          "type": "number",
          "description": "Tapılan kimlik məlumatı."
        },
        "machinesFound": {
          "type": "number",
          "description": "Tapılan maşın."
        }
      }
    },
    "error": {
      "type": "object",
      "description": "Tarama uğursuz olubsa xəta xülasəsi (yalnız mesaj və kod).",
      "properties": {
        "message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Xəta mesajı."
        },
        "code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Xəta kodu."
        }
      }
    },
    "_id": {
      "type": "string",
      "description": "Qeydin kimliyi (24 simvollu onaltılıq)."
    },
    "firm": {
      "type": "string",
      "description": "Qeydin aid olduğu şirkətin kimliyi — həmişə API açarınızın şirkəti."
    },
    "protectionResourceGroupId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Qeydin bağlı olduğu qoruma resursu qrupunun kimliyi."
    },
    "scanType": {
      "type": "string",
      "description": "Tarama növü: `manual`, `scheduled`, `automatic` və ya `auto`."
    },
    "status": {
      "type": "string",
      "description": "Tarama statusu: `pending`, `running`, `completed`, `failed`, `cancelled`."
    },
    "startedAt": {
      "type": "string",
      "description": "Başlama vaxtı."
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Bitmə vaxtı."
    },
    "durationMs": {
      "type": [
        "number",
        "null"
      ],
      "description": "Müddət (millisaniyə)."
    },
    "resourceResults": {
      "type": "array",
      "description": "Resurs başına tarama nəticələri.",
      "items": {}
    },
    "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ı?