List inventory items

Lists the inventory items associated with your organization (malware samples, infected files and other collected files), page by page.

GET/v1/inventory

GETList inventory items

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

Response

Successfully retrieved inventory items

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

Access

Scopeinventory:read

Plan entitlementapi_access

Query parameters

Fields	Values
`page` · integer · optional	Page number for pagination · Example: `1`
`limit` · integer · optional	Number of results per page · Example: `50`
`type` · string · optional	Filter by inventory item type · Example: `malware_sample`
`status` · string · optional	Filter by status · Example: `locked`
`search` · string · optional	Search by filename or metadata · Example: `malware`

Responses

200Successfully retrieved inventory items

400Invalid request (malformed id, missing or invalid field)

401Key missing, invalid, expired or revoked

403Insufficient scope, no API access in plan, or product not enabled

404Record not found or not owned by this key’s firm

408The request exceeded its maximum response time

429Rate limit exceeded; retry after a minute

Inventory itemResponse model

Response limits

Page sizelimit · default 50 · max 100

Rate limit500 requests per 15 min · per IP

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