İnventar elementlərini siyahıla

Təşkilatınızla əlaqəli inventar elementlərini (zərərli proqram nümunələri, yoluxmuş fayllar və toplanan digər fayllar) səhifə-səhifə siyahılayır.

GET/v1/inventory

GETİnventar elementlərini siyahıla

curl -X GET "https://api.darkradar.com/api/public/v1/inventory" \
  -H "x-api-key: $DARKRADAR_API_KEY"

Cavab

Uğurlu

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

Giriş icazəsi

Əhatəinventory:read

Plan hüququapi_access

Sorğu parametrləri

Sahələr	Dəyərlər
`page` · integer · istəyə bağlı	Səhifə nömrəsi (1-dən başlayır) · Nümunə: `1`
`limit` · integer · istəyə bağlı	Səhifə başına qeyd (ən çox 100) · Nümunə: `50`
`type` · string · istəyə bağlı	Hadisə növünə görə süz · Nümunə: `malware_sample`
`status` · string · istəyə bağlı	Statusa görə süz · Nümunə: `locked`
`search` · string · istəyə bağlı	Hadisə sahələrində mətn axtarışı · Nümunə: `malware`

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

İnventar qeydiCavab modeli

Cavab limitləri

Səhifə ölçüsülimit · susmaya görə 50 · maksimum 100

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

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