Launch scan

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

Launch a scan for an artifact

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).

POST/api/v1/scan/launch

Authorization

Houdin API Key

Body

application/json

artifact*string

Example: "https://maliciousurl.com/infected.exe"

scanOnarray

Response

200400

Scan launched

Body

application/json

scanIDstring

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

statusstring

Example: "In progress"

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/scan/launch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "artifact": "https://maliciousurl.com/infected.exe"
    }),
});
const data = await response.json();

Response

200

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