Create a new scan

Starts a new security scan for one domain or all domains of your organization. The scan runs in the background; check its status with the scan id.

POST/v1/scans

POSTCreate a new scan

curl -X POST "https://api.darkradar.com/api/public/v1/scans" \
  -H "x-api-key: $DARKRADAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupId":"64b1f0c2a9e4d21f8c3b9a10"}'

Response

Scan created successfully

{
  "success": true,
  "message": "OK",
  "data": {
    "scan": {
      "_id": "507f1f77bcf86cd799439011",
      "firmId": "507f1f77bcf86cd799439012",
      "protectionResourceId": "507f1f77bcf86cd799439013",
      "status": "pending",
      "scanType": "manual",
      "createdAt": "2024-01-15T10:00:00Z"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:00:15.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 42
  }
}

Access

Scopescans:write

Plan entitlementapi_access

Request body

Fields	Values
`groupId` · string · optional	Protection resource GROUP to scan; all of the firm’s resources if omitted

Responses

201Scan created 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

409A scan is already running for the firm; wait for it to finish

429Rate limit exceeded; retry after a minute

ScanResponse model

Response limits

Rate limit500 requests per 15 min · per IP