About this endpoint
What it does
Audits the security headers for a website URL and returns the URL, an overall score, recommendations, and a breakdown of specific security header checks.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL 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 includes csp, hsts, and x_frame_options string fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The audited website URL. |
| score | Integer | No | The audit score. |
| recommendations | String Array | No | A list of recommendations for improving the website's security headers. |
| security_headers | Object | No | The security header check results. |
| security_headers.csp | String | No | Content Security Policy header status. |
| security_headers.hsts | String | No | HTTP Strict Transport Security header status. |
| security_headers.x_frame_options | String | No | X-Frame-Options header status. |