Cancel a running scan

Cancels a scan that is pending or running. Completed or failed scans cannot be cancelled.

POST/v1/scans/{scanId}/cancel

POSTCancel a running scan

curl -X POST "https://api.darkradar.com/api/public/v1/scans/507f1f77bcf86cd799439011/cancel" \
  -H "x-api-key: $DARKRADAR_API_KEY"

Response

Scan cancelled successfully

{
  "success": true,
  "message": "OK",
  "data": {
    "scan": {
      "_id": "507f1f77bcf86cd799439011",
      "status": "cancelled",
      "cancelledAt": "2024-01-15T10:15:00Z"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:15:15.123Z",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "responseTime": 25
  }
}

Access

Scopescans:write

Plan entitlementapi_access

Path parameters

Fields	Values
`scanId` · string · required	Unique identifier of the scan · Example: `507f1f77bcf86cd799439011`

Responses

200Scan cancelled 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

ScanResponse model

Response limits

Rate limit500 requests per 15 min · per IP