Yeni tarama yarat

Bir domen və ya təşkilatınızın bütün domenləri üçün yeni təhlükəsizlik taraması başladır. Tarama arxa planda davam edir; statusunu tarama kimliyi ilə yoxlayın.

POST/v1/scans

POSTYeni tarama yarat

curl -X POST "https://api.darkradar.com/api/public/v1/scans" \
  -H "x-api-key: $DARKRADAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupId":"64b1f0c2a9e4d21f8c3b9a10"}'

Cavab

Yaradıldı

{
  "success": true,
  "message": "OK",
  "data": {
    "scan": {
      "_id": "507f1f77bcf86cd799439011",
      "firmId": "507f1f77bcf86cd799439012",
      "protectionResourceId": "507f1f77bcf86cd799439013",
      "status": "pending",
      "scanType": "manual",
      "createdAt": "2024-01-15T10:00:00Z"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:00:15.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 42
  }
}

Giriş icazəsi

Əhatəscans:write

Plan hüququapi_access

Sorğu gövdəsi

Sahələr	Dəyərlər
`groupId` · string · istəyə bağlı	Taranacaq qoruma resursu QRUPU; boşdursa şirkətin bütün resursları

Cavablar

201Yaradıldı

400Sorğu etibarsızdır (pozuq kimlik, çatışmayan və ya səhv sahə)

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ı

409Şirkətdə davam edən tarama var; bitməsini gözləyin

429Sürət həddi aşıldı; bir dəqiqə sonra yenidən yoxlayın

TaramaCavab modeli

Cavab limitləri

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