API sənədləri

Qoruma resursu

İzlədiyiniz bir varlıq (domen, IP, e-poçt…).

Sahələr

_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.
groupIdstring
Resursun bağlı olduğu qrupun kimliyi.
resourceTypestring
Növ: `domain`, `ip`, `hwid`, `email`, `username`, `application`.
targetValuestring
İzlənən dəyər (kiçik hərfə çevrilir).
descriptionstring | null
Təsvir (istəyə bağlı).
isActiveboolean
İzləmə aktivdirmi.
authorizationBlockedboolean
Səlahiyyət əhatəsi səbəbindən yeni uyğunluqlar dayandırılıbmı.
thirdPartyIncludeboolean
Üçüncü tərəf sızmaları da əhatə olunsunmu.
matchModestring
Uyğunluq rejimi: `machine` və ya `credential`.
isVerifiedboolean
Sahiblik təsdiqlənibmi.
verificationMethodstring
Doğrulama üsulu (məs. `dns`, `file`, `manual`).
verificationStatusstring
Doğrulama statusu.
verifiedAtstring
Təsdiqləndiyi vaxt.
reviewStatusstring | null
Əl ilə yoxlama statusu (lazımdırsa).
createdAtstring
Yaradılma vaxtı (ISO 8601).
updatedAtstring
Son yenilənmə vaxtı (ISO 8601).
metadataobject · istəyə bağlı
Sərbəst əlavə məlumat (yoxdursa sahə qaytarılmır).

JSON Sxemi

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/protection-resource.schema.json",
  "title": "Qoruma resursu",
  "description": "İzlədiyiniz bir varlıq (domen, IP, e-poçt…).",
  "type": "object",
  "properties": {
    "_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."
    },
    "groupId": {
      "type": "string",
      "description": "Resursun bağlı olduğu qrupun kimliyi."
    },
    "resourceType": {
      "type": "string",
      "description": "Növ: `domain`, `ip`, `hwid`, `email`, `username`, `application`."
    },
    "targetValue": {
      "type": "string",
      "description": "İzlənən dəyər (kiçik hərfə çevrilir)."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Təsvir (istəyə bağlı)."
    },
    "isActive": {
      "type": "boolean",
      "description": "İzləmə aktivdirmi."
    },
    "authorizationBlocked": {
      "type": "boolean",
      "description": "Səlahiyyət əhatəsi səbəbindən yeni uyğunluqlar dayandırılıbmı."
    },
    "thirdPartyInclude": {
      "type": "boolean",
      "description": "Üçüncü tərəf sızmaları da əhatə olunsunmu."
    },
    "matchMode": {
      "type": "string",
      "description": "Uyğunluq rejimi: `machine` və ya `credential`."
    },
    "isVerified": {
      "type": "boolean",
      "description": "Sahiblik təsdiqlənibmi."
    },
    "verificationMethod": {
      "type": "string",
      "description": "Doğrulama üsulu (məs. `dns`, `file`, `manual`)."
    },
    "verificationStatus": {
      "type": "string",
      "description": "Doğrulama statusu."
    },
    "verifiedAt": {
      "type": "string",
      "description": "Təsdiqləndiyi vaxt."
    },
    "reviewStatus": {
      "type": [
        "string",
        "null"
      ],
      "description": "Əl ilə yoxlama statusu (lazımdırsa)."
    },
    "createdAt": {
      "type": "string",
      "description": "Yaradılma vaxtı (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Son yenilənmə vaxtı (ISO 8601)."
    },
    "metadata": {
      "type": "object",
      "description": "Sərbəst əlavə məlumat (yoxdursa sahə qaytarılmır)."
    }
  }
}

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