REST API
API Documentation
The WebSentry API lets you scan URLs, retrieve results, manage API keys, and configure monitoring — all programmatically.
Base URL
https://websentry.devAuthentication
All API requests require an X-API-Key header. Get your key from your dashboard after signing up.
The Free plan lets you run 5 scans/day without a key (rate-limited by IP). A key unlocks higher limits and result history.
http
POST /api/scan HTTP/1.1
Host: websentry.dev
Content-Type: application/json
X-API-Key: wsk_your_api_key_here
{ "url": "https://example.com" }| Plan | Scans / day | Concurrent | History |
|---|---|---|---|
| No key (IP) | 5 | 1 | None |
| Free | 20 | 2 | 7 days |
| Pro | 200 | 5 | 90 days |
| Agency Starter | 1,000 | 10 | 1 year |
| Agency Growth | 5,000 | 25 | 1 year |
| Agency Pro | Unlimited | 50 | 1 year |
Scanning
API Keys
Monitors
Monitors re-scan a URL on a schedule (daily by default) and send email alerts when your security grade drops. Available on Pro and Agency plans.
Reference
Grading scale
| Grade | Score range |
|---|---|
| A+ | 90 – 100 |
| A | 80 – 89 |
| B | 70 – 79 |
| C | 60 – 69 |
| D | 50 – 59 |
| F | 0 – 49 |
Check statuses
| Status | Meaning |
|---|---|
| pass | Check passed, full points awarded |
| warn | Partial pass or advisory issue |
| fail | Check failed, no points |
| info | Informational — no score impact |
Common error codes
| Code | Meaning |
|---|---|
| 400 | Invalid or missing URL |
| 401 | Missing or invalid API key |
| 429 | Rate limit exceeded |
| 422 | URL unreachable or blocked |
| 500 | Internal scan error |
Ready to integrate?
Get your API key from the dashboard — free plan included.