Skip to main content
POST
Scan a URL for security threats including injection attacks and policy violations.

Authorizations

apikey
string
header
required

Body

application/json
url
string<uri>
required

The URL to scan and analyze.

detectors
GuardrailsDetectorsObject · object
user_metadata
object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example:

Response

200 - application/json

Scan results for the provided URL.

summary
object
required

Summary counts of detections by detector type.

details
ScanUrlDetails · object
required

Detailed scan results including URL metadata and fragment-level information.

user_metadata
object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example: