API belgeleri

Yeni tarama oluştur

Bir alan adı ya da kuruluşunuzun tüm alan adları için yeni bir güvenlik taraması başlatır. Tarama arka planda sürer; durumunu tarama kimliğiyle sorgulayın.

POST/v1/scans
POSTYeni tarama oluştur
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"}'
Yanıt

Oluşturuldu

{
  "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
  }
}

Yetki

Kapsamscans:write
Plan yetkisiapi_access

İstek gövdesi

AlanlarDeğerler
groupId · string · isteğe bağlıTaranacak koruma kaynağı grubu; boşsa firmanın tüm kaynakları

Yanıtlar

201Oluşturuldu
400İstek geçersiz (bozuk kimlik, eksik ya da hatalı alan)
401Anahtar yok, geçersiz, süresi dolmuş ya da iptal edilmiş
403Kapsam yetersiz, planda API erişimi yok ya da ürün açık değil
404Kayıt yok ya da bu anahtarın firmasına ait değil
408İstek azami yanıt süresini aştı
409Firmada yürüyen bir tarama var; bitmesini bekleyin
429Hız sınırı aşıldı; bir dakika sonra tekrar deneyin

Yanıt sınırları

Hız sınırı15 dakikada 500 istek · IP başına

Bu sayfa işinize yaradı mı?