API documentation

Unlock an inventory file

Unlocks a password-protected or encrypted inventory file. An unlocked file can be downloaded.

POST/v1/inventory/unlock
POSTUnlock an inventory file
curl -X POST "https://api.darkradar.com/api/public/v1/inventory/unlock" \
  -H "x-api-key: $DARKRADAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventId":"64b1f0c2a9e4d21f8c3b9a11","relationId":"64b1f0c2a9e4d21f8c3b9a12"}'
Response

File unlock requested successfully

{
  "success": true,
  "message": "OK",
  "data": {
    "unlockRequestId": "507f1f77bcf86cd799439014",
    "status": "processing",
    "estimatedTime": "5-10 minutes"
  },
  "meta": {
    "timestamp": "2024-02-01T10:30:45.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 89
  }
}

Access

Scopeinventory:write
Plan entitlementapi_access

Request body

FieldsValues
eventId · string · requiredLeak event id
relationId · string · requiredRelation (machine) id in the event

Responses

200File unlock requested successfully
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?