About this endpoint
What it does
Audits the website at the supplied url and returns a JSON object summarizing basic security checks for HTTPS, headers, cookies, TLS validity, an overall score, and a list of findings.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL to audit. |
| follow_redirects | Boolean | No | Whether redirects should be followed when auditing the target. Default: true. |
Response
Returns a JSON object with url and host string fields, https and tls_valid boolean fields, score as an integer from 0 to 100, nested cookies and headers objects with boolean checks, and a findings array of issue objects.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The audited website URL. |
| host | String | No | The host extracted for the audit target. |
| https | Boolean | No | Whether the target is accessible over HTTPS. |
| score | Integer | No | The audit score, from 0 to 100. |
| cookies | Object | No | Cookie-related security checks.<br>cookies.secure: whether cookies are marked secure.<br>cookies.http_only: whether cookies are marked HttpOnly.<br>cookies.same_site: whether cookies use SameSite. |
| headers | Object | No | Response-header security checks.<br>headers.csp: whether Content Security Policy is present.<br>headers.hsts: whether HSTS is present.<br>headers.referrer_policy: whether a Referrer-Policy header is present.<br>headers.x_frame_options: whether X-Frame-Options is present.<br>headers.x_content_type_options: whether X-Content-Type-Options is present. |
| findings | Object Array | No | A list of finding objects.<br>findings[].id: finding identifier.<br>findings[].message: finding message.<br>findings[].severity: severity level; allowed values are low, medium, high.<br>findings[].recommendation: suggested remediation. |
| tls_valid | Boolean | No | Whether the site’s TLS configuration is considered valid. |