Launch scan

Everything you need to know about launching scans using the Houdin API

Launch a scan for an artifact

post

Launch a scan for an artifact.

About API Keys

Make sure you provide an API Key in the headers for each scanner you want to use privately.

Example:

• X-VT-API-Key: xxxxxxxxxxxxxxxxxxx

Regarding artifact

Supported artifact types are:

• URL
• Domain
• IPv4
• MD5 Hash
• SHA1 Hash
• SHA256 Hash

Regarding scanOn

Not specifying scanOn will automatically detect scanners compatible with the provided artifact.

Using "scanOn": "all" forces all scanner to be selected (not recommended).

Authorizations

Body

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

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

Responses

200

Scan launched

application/json

400

No compatible scanners found for this artifact

post

HTTPcURLJavaScriptPython

POST /api/v1/scan/launch HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "artifact": "https://maliciousurl.com/infected.exe",
  "scanOn": [
    "vt",
    "urlscan",
    "alienvault",
    "abuseipdb"
  ]
}

{
  "scanID": "houdin-a7675557-68ff-4a5a-9c3a-6de3d5bd8090",
  "status": "In progress"
}