Guides

API Playground

Test BoringSec API endpoints live. Enter your API key, pick an endpoint, and hit Run.

API key

Your key is used only for this request and never stored. Keys start with bsk_ — get one at API Keys.

Build a request

POST/api/v1/scan

Queue a full security scan and use the returned polling links

URL to scan

Request Body (JSON)

{"url": "https://example.com", "async": true}

curl command

curl

curl -X POST https://www.boringsec.com/api/v1/scan \
  -H "Authorization: Bearer bsk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "async": true}'

Response

Run a request to see the JSON response here.