API documentation

Get inventory item details

Returns the details of an inventory item: metadata, relationships and processing status.

GET/v1/inventory/{id}
GETGet inventory item details
curl -X GET "https://api.darkradar.com/api/public/v1/inventory/507f1f77bcf86cd799439011" \
  -H "x-api-key: $DARKRADAR_API_KEY"
Response

Successfully retrieved inventory item details

{
  "success": true,
  "message": "OK",
  "data": {
    "item": {
      "_id": "507f1f77bcf86cd799439011",
      "firm": "507f1f77bcf86cd799439010",
      "fileName": "DARKRADAR#69b88E9U91360.zip",
      "fileSize": 534773,
      "mimeType": "application/zip",
      "hasFile": true,
      "unlockedAt": "2024-01-15T10:00:00Z",
      "protectionResourceId": "507f1f77bcf86cd799439015",
      "protectionResourceGroupId": "507f1f77bcf86cd799439016",
      "eventId": {
        "_id": "507f1f77bcf86cd799439012",
        "type": "employee",
        "leakType": "domain",
        "severity": "high",
        "status": "open",
        "eventDate": "2024-01-14T15:30:00Z"
      },
      "relationId": {
        "_id": "507f1f77bcf86cd799439013",
        "machineId": {
          "_id": "507f1f77bcf86cd799439014",
          "computerName": "DESKTOP-***",
          "countryCode": "TR",
          "operatingSystem": "Windows 11"
        },
        "stealerFamilyId": {
          "_id": "507f1f77bcf86cd799439017",
          "name": "Lumma"
        }
      },
      "metadata": {
        "stealerFamily": "Lumma",
        "ipAddress": "203.0.113.10",
        "countryCode": "TR"
      },
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z"
    }
  },
  "meta": {
    "timestamp": "2024-02-01T10:30:45.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 34
  }
}

Access

Scopeinventory:read
Plan entitlementapi_access

Path parameters

FieldsValues
id · string · requiredUnique identifier of the inventory item · Example: 507f1f77bcf86cd799439011

Responses

200Successfully retrieved inventory item details
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

Response limits

Rate limit500 requests per 15 min · per IP

Was this page helpful?