API sənədləri

İşləyən taramanı ləğv et

Gözləyən və ya davam edən taramanı ləğv edir. Tamamlanmış və ya uğursuz taramalar ləğv edilə bilməz.

POST/v1/scans/{scanId}/cancel
POSTİşləyən taramanı ləğv et
curl -X POST "https://api.darkradar.com/api/public/v1/scans/507f1f77bcf86cd799439011/cancel" \
  -H "x-api-key: $DARKRADAR_API_KEY"
Cavab

Uğurlu

{
  "success": true,
  "message": "OK",
  "data": {
    "scan": {
      "_id": "507f1f77bcf86cd799439011",
      "status": "cancelled",
      "cancelledAt": "2024-01-15T10:15:00Z"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:15:15.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 25
  }
}

Giriş icazəsi

Əhatəscans:write
Plan hüququapi_access

Yol parametrləri

SahələrDəyərlər
scanId · string · məcburiTaramanın kimliyi (24 simvol) · Nümunə: 507f1f77bcf86cd799439011

Cavablar

200Uğurlu
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ı
429Sürət həddi aşıldı; bir dəqiqə sonra yenidən yoxlayın

Cavab limitləri

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

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