/securityheaders/scans

POST /api/securityheaders/scans

Price: 1 credit

Scan a site's HTTP response security headers and grade them via SecurityHeaders.com

How to use it

Scan a website's HTTP response security headers and get its SecurityHeaders.com grade (A+ down to F). Returns the grade, the final scanned URL and resolved IP address, the list of present security headers, the missing security headers with recommendations, every raw HTTP response header with its actual value, upcoming/recommended headers, and additional notes. Accepts a full URL or a bare domain. Useful for security posture, attack-surface, and compliance reconnaissance of any domain.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• url string required — Target site to scan (full URL or bare domain) (examples: "https://github.com", "example.com", "https://www.cloudflare.com"; minLength: 1)
• follow_redirects boolean — Scan the final response after following redirects (default: true)
• hide_results boolean — Keep this scan out of the public results feed (default: true)

Response

• @type string (default: "SecurityheadersScan")
• grade string nullable
• url string nullable
• ip_address string nullable
• report_at string nullable
• present_headers array (default: [])
• missing_headers array (default: [])
  • @type string (default: "SecurityheadersMissingHeader")
  • name string required
  • description string nullable
• raw_headers array (default: [])
  • @type string (default: "SecurityheadersRawHeader")
  • name string required
  • value string nullable
• upcoming_headers array (default: [])
  • @type string (default: "SecurityheadersUpcomingHeader")
  • name string required
  • description string nullable
• additional_info array (default: [])
  • @type string (default: "SecurityheadersAdditionalInfo")
  • header string required
  • note string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The target site could not be scanned (unreachable or rejected) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.