/alienvault_otx/files/analysis

POST /api/alienvault_otx/files/analysis

Price: 1 credit

Get the AlienVault OTX malware analysis of a file by its hash

How to use it

Get the AlienVault OTX static/dynamic malware analysis of a file by its MD5, SHA1 or SHA256 hash. Returns the full set of hashes (md5/sha1/sha256/ssdeep), file type/class and size, antivirus detection names (ClamAV, Microsoft Defender), matched YARA rule names, extracted strings, the Cuckoo sandbox score, TLP and analysis time.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hash string required — File hash (MD5, SHA1 or SHA256) to fetch the malware analysis for (examples: "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f"; minLength: 1)

Response

• @type string (default: "OtxFileAnalysis")
• hash string required
• md5 string nullable
• sha1 string nullable
• sha256 string nullable
• ssdeep string nullable
• file_type string nullable
• file_class string nullable
• file_size integer nullable
• tags array (default: [])
• tlp string nullable
• analyzed_at integer nullable
• has_dynamic boolean (default: false)
• cuckoo_score integer nullable
• detections object (default: {})
  • * string
• yara_rules array (default: [])
• strings array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No analysis found for this hash Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.