Get a scan | Detectant Documentation

{
  "id": "scan_0123456789abcdef0123456789abcdef",
  "created_at": "2024-01-15T09:30:00Z",
  "status": "completed",
  "verdict": "clean",
  "filename": "string",
  "sha256": "string",
  "size_bytes": 1,
  "duration_ms": 1.1,
  "failure": {
    "code": "SCANNER_UNAVAILABLE",
    "message": "string"
  },
  "detections": [
    "string"
  ],
  "type_analysis": {
    "declared": {
      "extension": "string",
      "mime": "string"
    },
    "identified": {
      "format": "string",
      "mime": "string"
    },
    "status": "match",
    "structurally_valid": true,
    "confidence": "high",
    "reason": {
      "code": "malformed_file",
      "claimed": "string",
      "detected": "string"
    }
  }
}

Returns one scan owned by the authenticated account.

Authentication

X-API-Keystring

API key in the mak.<lookup-id>.<secret> format.

Path parameters

scan_idstringRequired

Scan identifier returned by createScan or listScans.

Response

The requested scan.

idstring

Server-generated scan identifier.

created_atdatetime

statusenum

verdictenum

filenamestring

Filename supplied by the multipart upload.

sha256stringformat: "^[0-9a-f]{64}$"

size_byteslong>=0

duration_msdouble>=0

failureobject or null

Failure information, or null when the scan completed.

detectionslist of strings

Detection names reported for the file. Empty when no threats were detected.

type_analysisobject

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

$	curl https://api.detectant.com/v1/scans/scan_0123456789abcdef0123456789abcdef \
>	-H "X-API-Key: <apiKey>"