About this endpoint
What it does
Audits a website’s security headers for the URL you provide in the request body and returns a JSON object with the audit results for that URL. The response includes the scanned url, an integer score, a list of recommendations, and a security_headers object with the detected header statuses.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL or hostname to audit. |
Response
Returns a JSON object with url as a string, score as an integer, recommendations as a string array, and security_headers as an object. The security_headers object contains csp, hsts, and x_frame_options string fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The website URL that was audited. |
| score | Integer | No | The audit score returned by the service. |
| recommendations | String Array | No | A list of recommendation strings for improving the website’s security headers. |
| security_headers | Object | No | The detected security header statuses. |
| security_headers.csp | String | No | The status of the Content-Security-Policy header. |
| security_headers.hsts | String | No | The status of the Strict-Transport-Security header. |
| security_headers.x_frame_options | String | No | The status of the X-Frame-Options header. |