API belgeleri

Envanter öğelerini listele

Kuruluşunuzla ilişkili envanter öğelerini (zararlı yazılım örnekleri, bulaşmış dosyalar ve toplanan diğer dosyalar) sayfa sayfa listeler.

GET/v1/inventory
GETEnvanter öğelerini listele
curl -X GET "https://api.darkradar.com/api/public/v1/inventory" \
  -H "x-api-key: $DARKRADAR_API_KEY"
Yanıt

Başarılı

{
  "success": true,
  "message": "OK",
  "data": {
    "items": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "fileName": "infected_document.pdf",
        "fileType": "application/pdf",
        "fileSize": 245678,
        "status": "locked",
        "eventId": "507f1f77bcf86cd799439012",
        "relationId": "507f1f77bcf86cd799439013",
        "createdAt": "2024-01-15T10:00:00Z",
        "metadata": {
          "source": "RedLine",
          "malwareFamily": "Stealer"
        }
      }
    ]
  },
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 50,
    "pages": 3,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  },
  "meta": {
    "timestamp": "2024-02-01T10:30:45.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 52
  }
}

Yetki

Kapsaminventory:read
Plan yetkisiapi_access

Sorgu parametreleri

AlanlarDeğerler
page · integer · isteğe bağlıSayfa numarası (1’den başlar) · Örnek: 1
limit · integer · isteğe bağlıSayfa başına kayıt (en çok 100) · Örnek: 50
type · string · isteğe bağlıOlay türüne göre süz · Örnek: malware_sample
status · string · isteğe bağlıDuruma göre süz · Örnek: locked
search · string · isteğe bağlıOlay alanlarında metin araması · Örnek: malware

Yanıtlar

200Başarılı
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ı
429Hız sınırı aşıldı; bir dakika sonra tekrar deneyin

Yanıt sınırları

Sayfa boyutulimit · varsayılan 50 · en çok 100
Hız sınırı15 dakikada 500 istek · IP başına

Bu sayfa işinize yaradı mı?