Skip to main content
POST
URL Scan checks a URL against Encrata’s threat-detection signals and returns a verdict, risk score, and supporting indicators.

Authentication

Send your API key as Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.

Request

string
required
Set this value to url.
string
required
The URL to scan. A URL without http:// or https:// is scanned as http://.
boolean
Set to true to include STIX 2.1 output when available. Defaults to false.
Encrata never fetches private or internal addresses, such as 127.0.0.1 or 10.x.x.x. For those URLs the verdict is unknown and signals contains an ssrf signal: “The link resolves to a private or internal address and was not fetched.”

Example request

Example response

This is the full response for the example request. Fields that don’t apply to a URL are omitted. For example, tls is missing here because the page is served over plain HTTP.

Response

boolean
true when the scan completed.
string
Human-readable summary of the verdict, such as Malicious content detected.
object
The URL scan result.
See Malware Scan for fields shared with other scan kinds.

Errors

The API returns 400 for an invalid URL, 401 for a missing or invalid API key, 402 when your account has insufficient credits, and 429 when you exceed a rate limit.

Credits

A successful scan costs 1 credit. Repeating the same scan kind and content is deduplicated for billing.