Get results

Everything you need to know about retrieving scan results using the Houdin API

Retrieve results for a scan

get

Retrieve results for a scan

Authorizations

Houdin API Key

X-API-KeystringRequired

Query parameters

scanIDstringRequired

A scan ID you want to retrieve results for

Example: houdin-a7675557-68ff-4a5a-9c3a-6de3d5bd8090

Responses

200

Success

application/json

scanIDstringOptionalExample: houdin-a7675557-68ff-4a5a-9c3a-6de3d5bd8090

statusstringOptionalExample: Done

artifactstringOptionalExample: https://maliciousurl.com/infected.exe

scanOnarrayOptionalExample: ["vt","urlscan","alienvault","abuseipdb"]

scanTimestringOptionalExample: 2023-01-01T00:00:00.000Z

expiresAfterstringOptionalExample: 2023-01-07T00:00:00.000Z

202

Scan is still in progress

400

Invalid scanID

404

Scan not found

get

/scan/result

HTTPcURLJavaScriptPython

GET /api/v1/scan/result?scanID=houdin-a7675557-68ff-4a5a-9c3a-6de3d5bd8090 HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "scanID": "houdin-a7675557-68ff-4a5a-9c3a-6de3d5bd8090",
  "status": "Done",
  "artifact": "https://maliciousurl.com/infected.exe",
  "scanOn": [
    "vt",
    "urlscan",
    "alienvault",
    "abuseipdb"
  ],
  "scanResults": {
    "vt": {},
    "urlscan": {},
    "alienvault": {},
    "abuseipdb": {}
  },
  "scanTime": "2023-01-01T00:00:00.000Z",
  "expiresAfter": "2023-01-07T00:00:00.000Z"
}